From cb5d8d4ee0515f5bc22758339329f218d5d51089 Mon Sep 17 00:00:00 2001 From: Michael Rose Date: Mon, 27 Nov 2017 12:14:23 -0500 Subject: [PATCH] Add notes disabling analytics and comments in `development` To enable analytics or comments while testing/building locally set Jekyll's environment variable to `production`, `JEKYLL_ENV=production`. On Windows use `set JEKYLL_ENV=production`. --- docs/_docs/05-configuration.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/_docs/05-configuration.md b/docs/_docs/05-configuration.md index 3ceff281..8fdfa0db 100644 --- a/docs/_docs/05-configuration.md +++ b/docs/_docs/05-configuration.md @@ -2,7 +2,7 @@ title: "Configuration" permalink: /docs/configuration/ excerpt: "Settings for configuring and customizing the theme." -last_modified_at: 2017-11-27T11:28:31-05:00 +last_modified_at: 2017-11-27T12:11:11-05:00 toc: true --- @@ -293,6 +293,10 @@ defaults: If you add `comments: false` to a post's YAML Front Matter it will override the default and disable comments for just that post. +**Note:** Comments are disabled by default in `development`. To enable when testing/building locally be sure to set +`JEKYLL_ENV=production` to [force the environment](http://jekyllrb.com/docs/configuration/#specifying-a-jekyll-environment-at-build-time) to production. +{: .notice--info} + ##### Disqus To use Disqus you'll need to create an account and [shortname](https://help.disqus.com/customer/portal/articles/466208-what-s-a-shortname-). Once you have both update `_config.yml` to: @@ -612,6 +616,10 @@ analytics: To use another provider not included with the theme set `provider: "custom"` then add their embed code to `_includes/analytics-providers/custom.html`. +**Note:** Analytics are disabled by default in `development`. To enable when testing/building locally be sure to set +`JEKYLL_ENV=production` to [force the environment](http://jekyllrb.com/docs/configuration/#specifying-a-jekyll-environment-at-build-time) to production. +{: .notice--info} + ## Site Author Used as the defaults for defining what appears in the author sidebar.