N-archive/hacks-guide-minimal-mistakes-theme
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add notes disabling analytics and comments in development

Browse source 
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`.
This commit is contained in:
Michael Rose 2017-11-27 12:14:23 -05:00
parent 02c109d24f
commit cb5d8d4ee0
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/_docs/05-configuration.md
View file

@ -2,7 +2,7 @@
title: "Configuration" title: "Configuration"
permalink: /docs/configuration/ permalink: /docs/configuration/
excerpt: "Settings for configuring and customizing the theme." 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 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. 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 ##### 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: 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`. 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 ## Site Author
Used as the defaults for defining what appears in the author sidebar. Used as the defaults for defining what appears in the author sidebar.