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

Fix notices

Browse source
This commit is contained in:
Michael Rose 2017-11-27 12:06:42 -05:00
parent da72581be3
commit 02c109d24f
1 changed files with 138 additions and 358 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -6,27 +6,18 @@ last_modified_at: 2017-11-27T11:28:31-05:00
toc: true
---
Settings that affect your entire site can be changed in
[Jekyll's configuration file](https://jekyllrb.com/docs/configuration/):
`_config.yml`, found in the root of your project. If you don't have this file
you'll need to copy or create one using the theme's
[default `_config.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_config.yml)
as a base.
Settings that affect your entire site can be changed in [Jekyll's configuration file](https://jekyllrb.com/docs/configuration/): `_config.yml`, found in the root of your project. If you don't have this file you'll need to copy or create one using the theme's [default `_config.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_config.yml) as a base.
**Note:** for technical reasons, `_config.yml` is NOT reloaded automatically
when used with `jekyll serve`. If you make any changes to this file, please
restart the server process for them to be applied. {: .notice--warning}
**Note:** for technical reasons, `_config.yml` is NOT reloaded automatically when used with `jekyll serve`. If you make any changes to this file, please restart the server process for them to be applied.
{: .notice--warning}
Take a moment to look over the configuration file included with the theme.
Comments have been added to provide examples and default values for most
settings. Detailed explanations of each can be found below.
Take a moment to look over the configuration file included with the theme. Comments have been added to provide examples and default values for most settings. Detailed explanations of each can be found below.
## Site Settings
### Theme
If you're using the Ruby gem version of the theme you'll need this line to
activate it:
If you're using the Ruby gem version of the theme you'll need this line to activate it:
```yaml
theme: minimal-mistakes-jekyll
@ -40,14 +31,10 @@ Easily change the color scheme of the theme using one of the provided "skins":
minimal_mistakes_skin: "default" # "air", "aqua", "contrast", "dark", "dirt", "neon", "mint", "plum" "sunrise"
```
**Note:** If you have made edits to the theme's CSS files be sure to update
[`/assets/css/main.scss`](https://github.com/mmistakes/minimal-mistakes/blob/master/assets/css/main.scss)
to include `@import "minimal-mistakes/skins/{{ site.minimal_mistakes_skin |
default: 'default' }}"; // skin` before the `minimal-mistakes` import. {:
.notice--warning}
**Note:** If you have made edits to the theme's CSS files be sure to update [`/assets/css/main.scss`](https://github.com/mmistakes/minimal-mistakes/blob/master/assets/css/main.scss) to include `@import "minimal-mistakes/skins/{{ site.minimal_mistakes_skin | default: 'default' }}"; // skin` before the `minimal-mistakes` import.
{: .notice--warning}
#### Air skin: `air`
{:.no_toc}
<figure class="half">
@ -57,7 +44,6 @@ default: 'default' }}"; // skin` before the `minimal-mistakes` import. {:
</figure>
#### Aqua skin: `aqua`
{:.no_toc}
<figure class="half">
@ -67,7 +53,6 @@ default: 'default' }}"; // skin` before the `minimal-mistakes` import. {:
</figure>
#### Contrast skin: `contrast`
{:.no_toc}
<figure class="half">
@ -77,7 +62,6 @@ default: 'default' }}"; // skin` before the `minimal-mistakes` import. {:
</figure>
#### Dark skin: `dark`
{:.no_toc}
<figure class="half">
@ -87,7 +71,6 @@ default: 'default' }}"; // skin` before the `minimal-mistakes` import. {:
</figure>
#### Dirt skin: `dirt`
{:.no_toc}
<figure class="half">
@ -97,7 +80,6 @@ default: 'default' }}"; // skin` before the `minimal-mistakes` import. {:
</figure>
#### Mint skin: `mint`
{:.no_toc}
<figure class="half">
@ -107,7 +89,6 @@ default: 'default' }}"; // skin` before the `minimal-mistakes` import. {:
</figure>
#### Neon skin: `neon`
{:.no_toc}
<figure class="half">
@ -117,7 +98,6 @@ default: 'default' }}"; // skin` before the `minimal-mistakes` import. {:
</figure>
#### Neon skin: `plum`
{:.no_toc}
<figure class="half">
@ -127,7 +107,6 @@ default: 'default' }}"; // skin` before the `minimal-mistakes` import. {:
</figure>
#### Sunrise skin: `sunrise`
{:.no_toc}
<figure class="half">
@ -138,133 +117,87 @@ default: 'default' }}"; // skin` before the `minimal-mistakes` import. {:
### Site Locale
`site.locale` is used to declare the primary language for each web page within
the site.
`site.locale` is used to declare the primary language for each web page within the site.
_Example:_ `locale: "en-US"` sets the `lang` attribute for the site to the
_United States_ flavor of English, while `en-GB` would be for the `United
Kingdom` style of English. Country codes are optional and the shorter variation
`locale: "en"` is also acceptable. To find your language and country codes check
this
[reference table](<https://msdn.microsoft.com/en-us/library/ee825488(v=cs.20).aspx>).
_Example:_ `locale: "en-US"` sets the `lang` attribute for the site to the _United States_ flavor of English, while `en-GB` would be for the `United Kingdom` style of English. Country codes are optional and the shorter variation `locale: "en"` is also acceptable. To find your language and country codes check this [reference table](<https://msdn.microsoft.com/en-us/library/ee825488(v=cs.20).aspx>).
Properly setting the locale is important for associating localized text found in
the [**UI Text**]({{ "/docs/ui-text/" | absolute_url }}) data file. An improper
match will cause parts of the UI to disappear (eg. button labels, section
headings, etc).
Properly setting the locale is important for associating localized text found in the [**UI Text**]({{ "/docs/ui-text/" | absolute_url }}) data file. An improper match will cause parts of the UI to disappear (eg. button labels, section headings, etc).
**Note:** The theme comes with localized text in English (`en`, `en-US`,
`en-GB`). If you change `locale` in `_config.yml` to something else, most of the
UI text will go blank. Be sure to add the corresponding locale key and
translated text to `_data/ui-text.yml` to avoid this. {: .notice--warning}
**Note:** The theme comes with localized text in English (`en`, `en-US`, `en-GB`). If you change `locale` in `_config.yml` to something else, most of the UI text will go blank. Be sure to add the corresponding locale key and translated text to `_data/ui-text.yml` to avoid this.
{: .notice--warning}
### Site Title
The name of your site. Is used throughout the theme in places like the site
masthead and `<title>` tags.
The name of your site. Is used throughout the theme in places like the site masthead and `<title>` tags.
_Example:_ `title: "My Awesome Site"`
You also have the option of customizing the separation character used in
SEO-friendly page titles.
You also have the option of customizing the separation character used in SEO-friendly page titles.
_Example:_ `title_separator: "|"` would produce page titles like `Sample Page |
My Awesome Site`.
_Example:_ `title_separator: "|"` would produce page titles like `Sample Page | My Awesome Site`.
**Note:** Long site titles have been known to break the masthead layout. Avoid
adding a long "tagline" to the title prevent this from happening eg. `My Awesome
Site is the Best Because I Say So". {: .notice--warning}
**Note:** Long site titles have been known to break the masthead layout. Avoid adding a long "tagline" to the title prevent this from happening eg. `My Awesome Site is the Best Because I Say So".
{: .notice--warning}
### Site Name
Used to assign a site author. Don't worry, you can override the site author with
different ones on specific posts, pages, or collection documents.
Used to assign a site author. Don't worry, you can override the site author with different ones on specific posts, pages, or collection documents.
_Example:_ `name: "Michael Rose"`.
**ProTip:** If you want to get crafty with your YAML you can use
[anchors](http://www.yaml.org/spec/1.2/spec.html#id2785586) to reuse values. For
example `foo: &var "My String"` allows you to reuse `"My String"` elsewhere in
`_config.yml` like so... `bar: *var`. You'll see a few examples of this in the
provided Jekyll config. {: .notice--info}
**ProTip:** If you want to get crafty with your YAML you can use [anchors](http://www.yaml.org/spec/1.2/spec.html#id2785586) to reuse values. For example `foo: &var "My String"` allows you to reuse `"My String"` elsewhere in `_config.yml` like so... `bar: *var`. You'll see a few examples of this in the provided Jekyll config.
{: .notice--info}
### Site Description
Fairly obvious. `site.description` describes the site. Used predominantly in
meta descriptions for improving SEO.
Fairly obvious. `site.description` describes the site. Used predominantly in meta descriptions for improving SEO.
_Example:_ `description: "A flexible Jekyll theme for your blog or site with a
minimalist aesthetic."`
_Example:_ `description: "A flexible Jekyll theme for your blog or site with a minimalist aesthetic."`
### Site URL
The base hostname and protocol for your site. If you're hosting with GitHub
Pages this will be something like `url: "https://github.io.mmistakes"` or `url:
"https://mademistakes.com"` if you have a custom domain name.
The base hostname and protocol for your site. If you're hosting with GitHub Pages this will be something like `url: "https://github.io.mmistakes"` or `url: "https://mademistakes.com"` if you have a custom domain name.
GitHub Pages now
[forces `https://` for new sites](https://help.github.com/articles/securing-your-github-pages-site-with-https/)
so be mindful of that when setting your URL to avoid mixed-content warnings.
GitHub Pages now [forces `https://` for new sites](https://help.github.com/articles/securing-your-github-pages-site-with-https/) so be mindful of that when setting your URL to avoid mixed-content warnings.
**Note:** Jekyll 3.3 overrides this value with `url: http://localhost:4000` when
running `jekyll serve` locally in development. If you want to avoid this
behavior set `JEKYLL_ENV=production` to
[force the environment](http://jekyllrb.com/docs/configuration/#specifying-a-jekyll-environment-at-build-time)
to production. {: .notice--warning}
**Note:** Jekyll 3.3 overrides this value with `url: http://localhost:4000` when running `jekyll serve` locally in development. If you want to avoid this behavior set `JEKYLL_ENV=production` to [force the environment](http://jekyllrb.com/docs/configuration/#specifying-a-jekyll-environment-at-build-time) to production.
{: .notice--warning}
### Site Base URL
This little option causes all kinds of confusion in the Jekyll community. If
you're not hosting your site as a GitHub Pages Project or in a subfolder (eg:
`/blog`), then don't mess with it.
This little option causes all kinds of confusion in the Jekyll community. If you're not hosting your site as a GitHub Pages Project or in a subfolder (eg: `/blog`), then don't mess with it.
In the case of the Minimal Mistakes demo site it's hosted on GitHub at
<https://mmistakes.github.io/minimal-mistakes>. To correctly set this base path
I'd use `url: "https://mmistakes.github.io"` and `baseurl: "/minimal-mistakes"`.
In the case of the Minimal Mistakes demo site it's hosted on GitHub at <https://mmistakes.github.io/minimal-mistakes>. To correctly set this base path I'd use `url: "https://mmistakes.github.io"` and `baseurl: "/minimal-mistakes"`.
For more information on how to properly use `site.url` and `site.baseurl` as
intended by the Jekyll maintainers, check
[Parker Moore's post on the subject](https://byparker.com/blog/2014/clearing-up-confusion-around-baseurl/).
For more information on how to properly use `site.url` and `site.baseurl` as intended by the Jekyll maintainers, check [Parker Moore's post on the subject](https://byparker.com/blog/2014/clearing-up-confusion-around-baseurl/).
**Note:** When using `baseurl` remember to include it as part of your path when
testing your site locally. Values of `url:` and `baseurl: "/blog"` would make
your local site visible at `http://localhost:4000/blog` and not
`http://localhost:4000`. {: .notice--warning}
**Note:** When using `baseurl` remember to include it as part of your path when testing your site locally. Values of `url:` and `baseurl: "/blog"` would make your local site visible at `http://localhost:4000/blog` and not `http://localhost:4000`.
{: .notice--warning}
### Site Repository
Add your repository name with organization to your site's configuration file,
`_config.yml`.
Add your repository name with organization to your site's configuration file, `_config.yml`.
```yaml
repository: "username/repo-name"
```
"NWO" stands for "name with owner." It is GitHub lingo for the username of the
owner of the repository plus a forward slash plus the name of the repository,
e.g. `mmistakes/minimal-mistakes`, where **mmistakes** is the owner and
**minimal-mistakes** is the repository name.
"NWO" stands for "name with owner." It is GitHub lingo for the username of the owner of the repository plus a forward slash plus the name of the repository, e.g. `mmistakes/minimal-mistakes`, where **mmistakes** is the owner and **minimal-mistakes** is the repository name.
Your `site.github.*` fields should fill in like normal. If you run Jekyll with
the --verbose flag, you should be able to see all the API calls made.
Your `site.github.*` fields should fill in like normal. If you run Jekyll with the --verbose flag, you should be able to see all the API calls made.
If you don't set `repository` correctly you may see the following error when
trying to `serve` or `build` your Jekyll site:
If you don't set `repository` correctly you may see the following error when trying to `serve` or `build` your Jekyll site:
**Liquid Exceptions:** No repo name found. Specify using `PAGES_REPO_NWO`
environment variables, `repository` in your configuration, or set up `origin`
git remote pointing to your github.com repository. {: .notice--danger}
**Liquid Exceptions:** No repo name found. Specify using `PAGES_REPO_NWO` environment variables, `repository` in your configuration, or set up `origin` git remote pointing to your github.com repository.
{: .notice--danger}
For more information on how `site.github` data can be used with Jekyll check out
[`github-metadata`'s documentation](https://github.com/jekyll/github-metadata).
For more information on how `site.github` data can be used with Jekyll check out [`github-metadata`'s documentation](https://github.com/jekyll/github-metadata).
### Site Scripts
Add scripts to the `<head>` or closing `</body>` elements by assigning paths to
either `head_scripts` and/or `footer_scripts`.
Add scripts to the `<head>` or closing `</body>` elements by assigning paths to either `head_scripts` and/or `footer_scripts`.
For example, to add a CDN version of jQuery to page's head along with a custom
script you'd do the following:
For example, to add a CDN version of jQuery to page's head along with a custom script you'd do the following:
```yaml
head_scripts:
@ -272,22 +205,18 @@ head_scripts:
- /assets/js/your-custom-head-script.js
```
Consult the [JavaScript documentation]({{ site.baseurl }}{% link
_docs/17-javascript.md %}) for more information on working with theme scripts.
Consult the [JavaScript documentation]({{ site.baseurl }}{% link _docs/17-javascript.md %}) for more information on working with theme scripts.
{: .notice--info}
### Site Default Teaser Image
To assign a fallback teaser image used in the "**Related Posts**" module, place
a graphic in the `/assets/images/` directory and add the filename to
`_config.yml` like so:
To assign a fallback teaser image used in the "**Related Posts**" module, place a graphic in the `/assets/images/` directory and add the filename to `_config.yml` like so:
```yaml
teaser: /assets/images/500x300.png
```
This image can be overridden at anytime by applying the following to a
document's YAML Front Matter.
This image can be overridden at anytime by applying the following to a document's YAML Front Matter.
```yaml
header:
@ -301,37 +230,26 @@ header:
### Breadcrumb Navigation (Beta)
Enable breadcrumb links to help visitors better navigate deep sites. Because of
the fragile method of implementing them they don't always produce accurate links
reliably. For best results:
Enable breadcrumb links to help visitors better navigate deep sites. Because of the fragile method of implementing them they don't always produce accurate links reliably. For best results:
1. Use a category based permalink structure e.g. `permalink:
/:categories/:title/`
2. Manually create pages for each category or use a plugin like
[jekyll-archives][jekyll-archives] to auto-generate them. If these pages
don't exist breadcrumb links to them will be broken.
1. Use a category based permalink structure e.g. `permalink: /:categories/:title/`
2. Manually create pages for each category or use a plugin like [jekyll-archives][jekyll-archives] to auto-generate them. If these pages don't exist breadcrumb links to them will be broken.
![breadcrumb navigation example]({{ "/assets/images/mm-breadcrumbs-example.jpg"
| absolute_url }})
![breadcrumb navigation example]({{ "/assets/images/mm-breadcrumbs-example.jpg" | absolute_url }})
```yaml
breadcrumbs: true # disabled by default
```
Breadcrumb start link text and separator character can both be changed in the
[UI Text data file]({{ "/docs/ui-text/" | absolute_url }}).
Breadcrumb start link text and separator character can both be changed in the [UI Text data file]({{ "/docs/ui-text/" | absolute_url }}).
### Reading Time
Enable estimated reading time snippets with `read_time: true` in YAML Front
Matter. `200` has been set as the default words per minute value --- which can
be changed by adjusting `words_per_minute:` in `_config.yml`.
Enable estimated reading time snippets with `read_time: true` in YAML Front Matter. `200` has been set as the default words per minute value --- which can be changed by adjusting `words_per_minute:` in `_config.yml`.
![reading time example]({{ "/assets/images/mm-read-time-example.jpg" |
absolute_url }})
![reading time example]({{ "/assets/images/mm-read-time-example.jpg" | absolute_url }})
Instead of adding `read_time: true` to each post, apply as a default in
`_config.yml` like so:
Instead of adding `read_time: true` to each post, apply as a default in `_config.yml` like so:
```yaml
defaults:
@ -343,16 +261,11 @@ defaults:
read_time: true
```
To disable reading time for a post, add `read_time: false` its YAML Front Matter
to override what was set in `_config.yml`.
To disable reading time for a post, add `read_time: false` its YAML Front Matter to override what was set in `_config.yml`.
### Comments
[**Disqus**](https://disqus.com/), [**Discourse**](https://www.discourse.org/),
[**Facebook**](https://developers.facebook.com/docs/plugins/comments),
**Google+**, and static-based commenting via
[**Staticman**](https://staticman.net/) are built into the theme. First set the
comment provider you'd like to use:
[**Disqus**](https://disqus.com/), [**Discourse**](https://www.discourse.org/), [**Facebook**](https://developers.facebook.com/docs/plugins/comments), **Google+**, and static-based commenting via [**Staticman**](https://staticman.net/) are built into the theme. First set the comment provider you'd like to use:
| Name | Comment Provider |
| ---------------- | ------------------------- |
@ -366,8 +279,7 @@ comment provider you'd like to use:
Then add `comments: true` to each document you want comments visible on.
Instead of adding YAML Front Matter to each document, apply as a default in
`_config.yml`. To enable comments for all posts:
Instead of adding YAML Front Matter to each document, apply as a default in `_config.yml`. To enable comments for all posts:
```yaml
defaults:
@ -379,14 +291,11 @@ defaults:
comments: true
```
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.
##### 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:
```yaml
comments:
@ -397,9 +306,7 @@ comments:
##### Discourse
For guidance on how to set up Discourse for embedding comments from a topic on a
post page,
[consult this guide](https://meta.discourse.org/t/embedding-discourse-comments-via-javascript/31963).
For guidance on how to set up Discourse for embedding comments from a topic on a post page, [consult this guide](https://meta.discourse.org/t/embedding-discourse-comments-via-javascript/31963).
```yaml
comments:
@ -408,14 +315,12 @@ comments:
server : # meta.discourse.org
```
**Note:** Do not include `http://` or `https://` when setting your Discourse
`server`. The theme automatically prepends the URL `//`, following a scheme-less
pattern. {: .notice--info}
**Note:** Do not include `http://` or `https://` when setting your Discourse `server`. The theme automatically prepends the URL `//`, following a scheme-less pattern.
{: .notice--info}
##### Facebook Comments
To enable Facebook Comments choose how many comments you'd like visible per post
and the color scheme of the widget.
To enable Facebook Comments choose how many comments you'd like visible per post and the color scheme of the widget.
```yaml
comments:
@ -428,31 +333,21 @@ comments:
##### Static-Based Comments via Staticman
Transform user comments into `_data` files that live inside of your GitHub
repository by enabling Staticman.
Transform user comments into `_data` files that live inside of your GitHub repository by enabling Staticman.
**Note:** Looking to migrate comments from a Wordpress based site? Give
[this tool](https://github.com/arthurlacoste/wordpress-comments-jekyll-staticman)
a try. {: .notice--info}
**Note:** Looking to migrate comments from a Wordpress based site? Give [this tool](https://github.com/arthurlacoste/wordpress-comments-jekyll-staticman) a try.
{: .notice--info}
###### Add Staticman as a Collaborator
1. Allow Staticman push access to your GitHub repository by clicking on
**Settings**, then the **Collaborators** tab and adding `staticmanapp` as a
collaborator.
2. To accept the pending invitation visit:
`https://api.staticman.net/v2/connect/{your GitHub username}/{your repository
name}`. Consult the Staticman
"[Get Started](https://staticman.net/get-started)" guide for more info.
1. Allow Staticman push access to your GitHub repository by clicking on **Settings**, then the **Collaborators** tab and adding `staticmanapp` as a collaborator.
2. To accept the pending invitation visit: `https://api.staticman.net/v2/connect/{your GitHub username}/{your repository name}`. Consult the Staticman "[Get Started](https://staticman.net/get-started)" guide for more info.
###### Configure Staticman
**Staticman v2**
Default settings have been provided in
[`staticman.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/staticman.yml)
and are commented to guide you through setup. View the
[full list of configurations](https://staticman.net/docs/configuration).
Default settings have been provided in [`staticman.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/staticman.yml) and are commented to guide you through setup. View the [full list of configurations](https://staticman.net/docs/configuration).
```yaml
# staticman.yml (defaults)
@ -485,20 +380,15 @@ staticman:
branch : "master"
```
**Branch setting:** This is the branch comment files will be sent to via pull
requests. If you host your site on GitHub Pages it will likely be `master`
unless your repo is setup as a project --- use `gh-pages` in that case. {:
.notice--info}
**Branch setting:** This is the branch comment files will be sent to via pull requests. If you host your site on GitHub Pages it will likely be `master` unless your repo is setup as a project --- use `gh-pages` in that case.
{: .notice--info}
**Note:** Staticman is currently only compatible with GitHub based repositories.
[Support for GitLab Pages](https://github.com/eduardoboucas/staticman/issues/22)
is planned but not available yet. {: .notice--warning}
**Note:** Staticman is currently only compatible with GitHub based repositories. [Support for GitLab Pages](https://github.com/eduardoboucas/staticman/issues/22) is planned but not available yet.
{: .notice--warning}
**Staticman v1 (deprecated)**
Default settings have been provided in `_config.yml`. The important ones to set
are `provider: "staticman"`, `branch`, and `path`. View the
[full list of configurations](https://staticman.net/docs/configuration).
Default settings have been provided in `_config.yml`. The important ones to set are `provider: "staticman"`, `branch`, and `path`. View the [full list of configurations](https://staticman.net/docs/configuration).
```yaml
# _config.yml (defaults)
@ -524,29 +414,21 @@ staticman:
###### Comment Moderation
By default comment moderation is enabled in `staticman.yml`. As new comments are
submitted Staticman will send a pull request. Merging these in will approve the
comment, close the issue, and automatically rebuild your site (if hosted on
GitHub Pages).
By default comment moderation is enabled in `staticman.yml`. As new comments are submitted Staticman will send a pull request. Merging these in will approve the comment, close the issue, and automatically rebuild your site (if hosted on GitHub Pages).
To skip this moderation step simply set `moderation: false`.
**ProTip:** Create a GitHub webhook that sends a `POST` request to the following
payload URL `https://api.staticman.net/v2/webhook` and triggers a "Pull request"
event to delete Staticman branches on merge. {: .notice--info}
**ProTip:** Create a GitHub webhook that sends a `POST` request to the following payload URL `https://api.staticman.net/v2/webhook` and triggers a "Pull request" event to delete Staticman branches on merge.
{: .notice--info}
![pull-request webhook]({{ "/assets/images/mm-staticman-pr-webhook.jpg" |
absolute_url }})
![pull-request webhook]({{ "/assets/images/mm-staticman-pr-webhook.jpg" | absolute_url }})
###### reCAPTCHA Support (v2 only)
To enable Google's reCAPTCHA to aid in spam detection you'll need to:
1. Apply for [reCAPTCHA API](https://www.google.com/recaptcha) keys and register
your site using the reCAPTCHA V2 type.
2. Add your site and secret keys to `staticman.yml` and `_config.yml`. Be sure
to properly encrypt your secret key using
[Staticman's encrypt endpoint](https://staticman.net/docs/encryption).
1. Apply for [reCAPTCHA API](https://www.google.com/recaptcha) keys and register your site using the reCAPTCHA V2 type.
2. Add your site and secret keys to `staticman.yml` and `_config.yml`. Be sure to properly encrypt your secret key using [Staticman's encrypt endpoint](https://staticman.net/docs/encryption).
```yaml
reCaptcha:
@ -557,46 +439,34 @@ reCaptcha:
##### Other Comment Providers
To use another provider not included with the theme set `provider: "custom"`
then add their embed code to `_includes/comments-providers/custom.html`.
To use another provider not included with the theme set `provider: "custom"` then add their embed code to `_includes/comments-providers/custom.html`.
### Custom Feed URL
By default the theme links to `feed.xml` generated in the root of your site by
the **jekyll-feed** plugin. To link to an externally hosted feed update
`atom_feed` in `_config.yml` like so:
By default the theme links to `feed.xml` generated in the root of your site by the **jekyll-feed** plugin. To link to an externally hosted feed update `atom_feed` in `_config.yml` like so:
```yaml
atom_feed:
path: "http://feeds.feedburner.com/youFeedname"
```
**Note:** By default the site feed is linked in two locations: inside the
[`<head>` element](https://github.com/mmistakes/minimal-mistakes/blob/master/_includes/head.html)
and at the bottom of every page in the
[site footer](https://github.com/mmistakes/minimal-mistakes/blob/master/_includes/footer.html).
**Note:** By default the site feed is linked in two locations: inside the [`<head>` element](https://github.com/mmistakes/minimal-mistakes/blob/master/_includes/head.html) and at the bottom of every page in the [site footer](https://github.com/mmistakes/minimal-mistakes/blob/master/_includes/footer.html).
{: .notice--info}
### SEO, Social Sharing, and Analytics Settings
All optional, but a good idea to take the time setting up to improve SEO and
links shared from the site.
All optional, but a good idea to take the time setting up to improve SEO and links shared from the site.
#### Google Search Console
Formerly known as
[Google Webmaster Tools](https://www.google.com/webmasters/tools/), add your
[verification code](https://support.google.com/analytics/answer/1142414?hl=en)
like so: `google_site_verification: "yourVerificationCode"`.
Formerly known as [Google Webmaster Tools](https://www.google.com/webmasters/tools/), add your [verification code](https://support.google.com/analytics/answer/1142414?hl=en) like so: `google_site_verification: "yourVerificationCode"`.
**Note:** You likely won't have to do this if you verify site ownership through
**Google Analytics** instead. {: .notice--warning}
**Note:** You likely won't have to do this if you verify site ownership through **Google Analytics** instead.
{: .notice--warning}
#### Bing Webmaster Tools
There are several ways to
[verify site ownership](https://www.bing.com/webmaster/help/how-to-verify-ownership-of-your-site-afcfefc6)
--- the easiest adding an authentication code to your config file.
There are several ways to [verify site ownership](https://www.bing.com/webmaster/help/how-to-verify-ownership-of-your-site-afcfefc6) --- the easiest adding an authentication code to your config file.
Copy and paste the string inside of `content`:
@ -612,10 +482,7 @@ bing_site_verification: "0FC3FD70512616B052E755A56F8952D"
#### Naver Webmaster Tools
To verify site ownership you will need to
[create a Naver account](https://nid.naver.com/user2/joinGlobal.nhn?lang=en_US&m=init)
and then **Add your site** via
[Naver Webmaster Tools](http://webmastertool.naver.com/).
To verify site ownership you will need to [create a Naver account](https://nid.naver.com/user2/joinGlobal.nhn?lang=en_US&m=init) and then **Add your site** via [Naver Webmaster Tools](http://webmastertool.naver.com/).
Much like Google and Bing you'll be provided with a meta description:
@ -645,31 +512,23 @@ yandex_site_verification: "2132801JL"
#### Twitter Cards and Facebook Open Graph
To improve the appearance of links shared from your site to social networks like
Twitter and Facebook be sure to configure the following.
To improve the appearance of links shared from your site to social networks like Twitter and Facebook be sure to configure the following.
##### Site Twitter Username
Twitter username for the site. For pages that have custom author Twitter
accounts assigned in their YAML Front Matter or data file, they will be
attributed as a **creator** in the Twitter Card.
Twitter username for the site. For pages that have custom author Twitter accounts assigned in their YAML Front Matter or data file, they will be attributed as a **creator** in the Twitter Card.
For example if my site's Twitter account is `@mmistakes-theme` I would add the
following to `_config.yml`
For example if my site's Twitter account is `@mmistakes-theme` I would add the following to `_config.yml`
```yaml
twitter:
username: "mmistakes-theme"
```
And if I assign `@mmistakes` as an author account it will appear in the Twitter
Card along with `@mmistakes-theme`, attributed as a creator of the page being
shared.
And if I assign `@mmistakes` as an author account it will appear in the Twitter Card along with `@mmistakes-theme`, attributed as a creator of the page being shared.
**Note**: You need to
[apply for Twitter Cards](https://dev.twitter.com/docs/cards) and validate
they're working on your site before they will begin showing up. {:
.notice--warning}
**Note**: You need to [apply for Twitter Cards](https://dev.twitter.com/docs/cards) and validate they're working on your site before they will begin showing up.
{: .notice--warning}
##### Facebook Open Graph
@ -681,26 +540,19 @@ facebook:
publisher: # A Facebook page URL or ID of the publishing entity
```
While not part a part of Open Graph, you can also add your Facebook username for
use in the sidebar and footer.
While not part a part of Open Graph, you can also add your Facebook username for use in the sidebar and footer.
```yaml
facebook:
username: "michaelrose" # https://www.facebook.com/michaelrose
```
**ProTip:** To debug Open Graph data use
[this tool](https://developers.facebook.com/tools/debug/og/object?q=https%3A%2F%2Fmademistakes.com)
to test your pages. If content changes aren't reflected you will probably have
to hit the **Fetch new scrape information** button to refresh. {: .notice--info}
**ProTip:** To debug Open Graph data use [this tool](https://developers.facebook.com/tools/debug/og/object?q=https%3A%2F%2Fmademistakes.com) to test your pages. If content changes aren't reflected you will probably have to hit the **Fetch new scrape information** button to refresh.
{: .notice--info}
##### Open Graph Default Image
For pages that don't have a `header.image` assigned in their YAML Front Matter,
`site.og_image` will be used as a fallback. Use your logo, icon, avatar or
something else that is meaningful. Just make sure it is place in the
`/assets/images/` folder, a minimum size of 120px by 120px, and less than 1MB in
file size.
For pages that don't have a `header.image` assigned in their YAML Front Matter, `site.og_image` will be used as a fallback. Use your logo, icon, avatar or something else that is meaningful. Just make sure it is place in the `/assets/images/` folder, a minimum size of 120px by 120px, and less than 1MB in file size.
```yaml
og_image: /assets/images/site-logo.png
@ -711,8 +563,7 @@ og_image: /assets/images/site-logo.png
<figcaption>Example of a image placed in a Summary Card.</figcaption>
</figure>
Documents who have a `header.image` assigned in their YAML Front Matter will
appear like this when shared on Twitter and Facebook.
Documents who have a `header.image` assigned in their YAML Front Matter will appear like this when shared on Twitter and Facebook.
<figure>
<img src="{{ '/assets/images/mm-twitter-card-summary-large.jpg' | absolute_url }}" alt="page shared on Twitter">
@ -726,10 +577,7 @@ appear like this when shared on Twitter and Facebook.
##### Include your social profile in search results
Use markup on your official website to add your
[social profile information](https://developers.google.com/structured-data/customize/social-profiles#adding_structured_markup_to_your_site)
to the Google Knowledge panel in some searches. Knowledge panels can prominently
display your social profile information.
Use markup on your official website to add your [social profile information](https://developers.google.com/structured-data/customize/social-profiles#adding_structured_markup_to_your_site) to the Google Knowledge panel in some searches. Knowledge panels can prominently display your social profile information.
```yaml
social:
@ -745,8 +593,7 @@ social:
#### Analytics
Analytics is disabled by default. To enable globally select one of the
following:
Analytics is disabled by default. To enable globally select one of the following:
| Name | Analytics Provider |
| -------------------- | --------------------------------------------------------------- |
@ -763,19 +610,16 @@ analytics:
tracking_id: "UA-1234567-8"
```
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`.
## Site Author
Used as the defaults for defining what appears in the author sidebar.
![author sidebar example]({{ "/assets/images/mm-author-sidebar-example.jpg" |
absolute_url }})
![author sidebar example]({{ "/assets/images/mm-author-sidebar-example.jpg" | absolute_url }})
**Note:** For sites with multiple authors these values can be overridden post by
post with custom YAML Front Matter and a data file. For more information on how
that works see below. {: .notice--info}
**Note:** For sites with multiple authors these values can be overridden post by post with custom YAML Front Matter and a data file. For more information on how that works see below.
{: .notice--info}
```yaml
author:
@ -786,37 +630,23 @@ author:
uri : "http://your-site.com"
```
Social media links are all optional, include the ones you want visible. In most
cases you just need to add the username. If you're unsure double check
`_includes/author-profile.html` to see how the URL is constructed.
Social media links are all optional, include the ones you want visible. In most cases you just need to add the username. If you're unsure double check `_includes/author-profile.html` to see how the URL is constructed.
To add social media links not included with the theme or customize the author
sidebar further, read the full [layout documentation]({{
"/docs/layouts/#author-profile" | absolute_url }}).
To add social media links not included with the theme or customize the author sidebar further, read the full [layout documentation]({{ "/docs/layouts/#author-profile" | absolute_url }}).
## Reading Files
Nothing out of the ordinary here. `include` and `exclude` may be the only things
you need to alter.
Nothing out of the ordinary here. `include` and `exclude` may be the only things you need to alter.
## Conversion and Markdown Processing
Again nothing out of the ordinary here as the theme adheres to the defaults used
by GitHub Pages. [**Kramdown**](http://kramdown.gettalong.org/) for Markdown
conversion, [**Rouge**](http://rouge.jneen.net/) syntax highlighting, and
incremental building disabled. Change them if you need to.
Again nothing out of the ordinary here as the theme adheres to the defaults used by GitHub Pages. [**Kramdown**](http://kramdown.gettalong.org/) for Markdown conversion, [**Rouge**](http://rouge.jneen.net/) syntax highlighting, and incremental building disabled. Change them if you need to.
## Front Matter Defaults
To save yourself time setting
[Front Matter Defaults](https://jekyllrb.com/docs/configuration/#front-matter-defaults)
for posts, pages, and collections is the way to go. Sure you can assign layouts
and toggle settings like **reading time**, **comments**, and **social sharing**
in each file, but that's not ideal.
To save yourself time setting [Front Matter Defaults](https://jekyllrb.com/docs/configuration/#front-matter-defaults) for posts, pages, and collections is the way to go. Sure you can assign layouts and toggle settings like **reading time**, **comments**, and **social sharing** in each file, but that's not ideal.
Using the `default` key in `_config.yml` you could set the layout and enable
author profiles, reading time, comments, social sharing, and related posts for
all posts --- in one shot.
Using the `default` key in `_config.yml` you could set the layout and enable author profiles, reading time, comments, social sharing, and related posts for all posts --- in one shot.
```yaml
defaults:
@ -857,55 +687,37 @@ defaults:
layout: single
```
And of course any default value can be overridden by settings in a post, page,
or collection file. All you need to do is specify the settings in the YAML Front
Matter. For more examples be sure to check out the demo site's
[`_config.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_config.yml).
And of course any default value can be overridden by settings in a post, page, or collection file. All you need to do is specify the settings in the YAML Front Matter. For more examples be sure to check out the demo site's [`_config.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_config.yml).
## Outputting
The default permalink style used by the theme is `permalink:
/:categories/:title/`. If you have a post named `2016-01-01-my-post.md` with
`categories: foo` in the YAML Front Matter, Jekyll will generate
`_site/foo/my-post/index.html`.
The default permalink style used by the theme is `permalink: /:categories/:title/`. If you have a post named `2016-01-01-my-post.md` with `categories: foo` in the YAML Front Matter, Jekyll will generate `_site/foo/my-post/index.html`.
**Note:** If you plan on enabling breadcrumb links --- including category names
in permalinks is a big part of how those are created. {: .notice--warning}
**Note:** If you plan on enabling breadcrumb links --- including category names in permalinks is a big part of how those are created.
{: .notice--warning}
### Paginate
If [using pagination](https://github.com/jekyll/jekyll-paginate) on the homepage
you can change the amount of posts shown with:
If [using pagination](https://github.com/jekyll/jekyll-paginate) on the homepage you can change the amount of posts shown with:
```yaml
paginate: 5
```
You'll also need to include some Liquid and HTML to properly use the paginator,
which you can find in the **Layouts** section under [Home Page]({{
"/docs/layouts/#home-page" | absolute_url }}).
You'll also need to include some Liquid and HTML to properly use the paginator, which you can find in the **Layouts** section under [Home Page]({{ "/docs/layouts/#home-page" | absolute_url }}).
The paginator only works on files with name `index.html`. To use pagination in a
subfolder --- for example `/recent/`, create `/recent/index.html` and set the
`paginate_path` in `_config.yml` to this:
The paginator only works on files with name `index.html`. To use pagination in a subfolder --- for example `/recent/`, create `/recent/index.html` and set the `paginate_path` in `_config.yml` to this:
```yaml
paginate_path: /recent/page:num/
```
**Please note:** When using Jekyll's default
[pagination plugin](http://jekyllrb.com/docs/pagination/) `paginator.posts` can
only be called once. If you're looking for something more powerful that can
paginate category, tag, and collection pages I suggest
[**jekyll-paginate-v2**](https://github.com/sverrirs/jekyll-paginate-v2). {:
.notice--info}
**Please note:** When using Jekyll's default [pagination plugin](http://jekyllrb.com/docs/pagination/) `paginator.posts` can only be called once. If you're looking for something more powerful that can paginate category, tag, and collection pages I suggest [**jekyll-paginate-v2**](https://github.com/sverrirs/jekyll-paginate-v2).
{: .notice--info}
### Timezone
This sets the timezone environment variable, which Ruby uses to handle time and
date creation and manipulation. Any entry from the
[IANA Time Zone Database](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
is valid. The default is the local time zone, as set by your operating system.
This sets the timezone environment variable, which Ruby uses to handle time and date creation and manipulation. Any entry from the [IANA Time Zone Database](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones) is valid. The default is the local time zone, as set by your operating system.
```yaml
timezone: America/New_York
@ -913,10 +725,7 @@ timezone: America/New_York
## Plugins
When hosting with GitHub Pages a small
[set of gems](https://pages.github.com/versions/) have been whitelisted for use.
The theme uses a few of them which can be found under `gems`. Additional
settings and configurations are documented in the links below.
When hosting with GitHub Pages a small [set of gems](https://pages.github.com/versions/) have been whitelisted for use. The theme uses a few of them which can be found under `gems`. Additional settings and configurations are documented in the links below.
| Plugin | Description |
| ---------------------------------- | ----------------------------------------------------------------------------------------- |
@ -932,24 +741,18 @@ settings and configurations are documented in the links below.
[jekyll-feed]: https://github.com/jekyll/jekyll-feed
[jemoji]: https://github.com/jekyll/jemoji
If you're hosting elsewhere then you don't really have to worry about what is
whitelisted as you are free to include whatever
[Jekyll plugins](https://jekyllrb.com/docs/plugins/) you desire.
If you're hosting elsewhere then you don't really have to worry about what is whitelisted as you are free to include whatever [Jekyll plugins](https://jekyllrb.com/docs/plugins/) you desire.
## Archive Settings
The theme ships with support for taxonomy (category and tag) pages. GitHub Pages
hosted sites need to use a _Liquid only_ approach while those hosted elsewhere
can use plugins like [**jekyll-archives**][jekyll-archives] to generate these
pages automatically.
The theme ships with support for taxonomy (category and tag) pages. GitHub Pages hosted sites need to use a _Liquid only_ approach while those hosted elsewhere can use plugins like [**jekyll-archives**][jekyll-archives] to generate these pages automatically.
[jekyll-archives]: https://github.com/jekyll/jekyll-archives
The default `type` is set to use Liquid.
**Note:** `category_archive` and `tag_archive` were previously named
`categories` and `tags`. Names were changed to avoid possible conflicts with
`site.categories` and `site.tags`. {: .notice--danger}
**Note:** `category_archive` and `tag_archive` were previously named `categories` and `tags`. Names were changed to avoid possible conflicts with `site.categories` and `site.tags`.
{: .notice--danger}
```yaml
category_archive:
@ -960,27 +763,14 @@ tag_archive:
path: /tags/
```
Which would create category and tag links in the breadcrumbs and page meta like:
`/categories/#foo` and `/tags/#foo`.
Which would create category and tag links in the breadcrumbs and page meta like: `/categories/#foo` and `/tags/#foo`.
**Note:** these are simply hash (fragment) links into the full taxonomy index
pages. For them to resolve properly, the category and tag index pages need to
exist at [`/categories/index.html`](https://github.com/{{ site.repository
}}/blob/master/docs/_pages/category-archive.html) (copy to
`_pages/category-archive.html`) and [`/tags/index.html`](https://github.com/{{
site.repository }}/blob/master/docs/_pages/tag-archive.html) (copy to
`_pages/tag-archive.html`). {: .notice--warning}
**Note:** these are simply hash (fragment) links into the full taxonomy index pages. For them to resolve properly, the category and tag index pages need to exist at [`/categories/index.html`](https://github.com/{{ site.repository }}/blob/master/docs/_pages/category-archive.html) (copy to `_pages/category-archive.html`) and [`/tags/index.html`](https://github.com/{{ site.repository }}/blob/master/docs/_pages/tag-archive.html) (copy to `_pages/tag-archive.html`).
{: .notice--warning}
If you have the luxury of using Jekyll Plugins, then
[**jekyll-archives**][jekyll-archives] will create a better experience as
discrete taxonomy pages would be generated, and their corresponding links would
be "real" (not just hash/fragment links into a larger index). However, the
plugin will not generate the taxonomy index pages (`category-archive.html` and
`_pages/tag-archive.html`) so you'd still need to manually create them if you'd
like to have them (see note above).
If you have the luxury of using Jekyll Plugins, then [**jekyll-archives**][jekyll-archives] will create a better experience as discrete taxonomy pages would be generated, and their corresponding links would be "real" (not just hash/fragment links into a larger index). However, the plugin will not generate the taxonomy index pages (`category-archive.html` and `_pages/tag-archive.html`) so you'd still need to manually create them if you'd like to have them (see note above).
First, you'll need to make sure that the `jekyll-archives` plugin is installed.
Either run `gem install jekyll-archives` or add the following to your `Gemfile`:
First, you'll need to make sure that the `jekyll-archives` plugin is installed. Either run `gem install jekyll-archives` or add the following to your `Gemfile`:
```
group :jekyll_plugins do
@ -990,9 +780,7 @@ end
Then run `bundle install`.
Now that the plugin is installed, change `type` to `jekyll-archives` and apply
the following
[configurations](https://github.com/jekyll/jekyll-archives/blob/master/docs/configuration.md):
Now that the plugin is installed, change `type` to `jekyll-archives` and apply the following [configurations](https://github.com/jekyll/jekyll-archives/blob/master/docs/configuration.md):
```yaml
category_archive:
@ -1013,21 +801,16 @@ jekyll-archives:
tag: /tags/:name/
```
**Note:** The `archive-taxonomy` layout used by jekyll-archives is provided with
the theme and can be found in the `_layouts` folder. {: .notice--info}
**Note:** The `archive-taxonomy` layout used by jekyll-archives is provided with the theme and can be found in the `_layouts` folder.
{: .notice--info}
## HTML Compression
If you care at all about performance (and really who doesn't) compressing the
HTML files generated by Jekyll is a good thing to do.
If you care at all about performance (and really who doesn't) compressing the HTML files generated by Jekyll is a good thing to do.
If you're hosting with GitHub Pages there aren't many options afforded to you
for optimizing the HTML Jekyll generates. Thankfully there is some Liquid
wizardry you can use to strip whitespace and comments to reduce file size.
If you're hosting with GitHub Pages there aren't many options afforded to you for optimizing the HTML Jekyll generates. Thankfully there is some Liquid wizardry you can use to strip whitespace and comments to reduce file size.
There's a variety of configurations and caveats to using the `compress` layout,
so be sure to read through the [documentation](http://jch.penibelst.de/) if you
decide to make change the defaults set in the theme's `_config.yml`.
There's a variety of configurations and caveats to using the `compress` layout, so be sure to read through the [documentation](http://jch.penibelst.de/) if you decide to make change the defaults set in the theme's `_config.yml`.
```yaml
compress_html:
@ -1036,11 +819,8 @@ compress_html:
envs: development # disable compression in dev environment
```
**Caution:** Inline JavaScript comments can cause problems with `compress.html`,
so be sure to `/* comment this way */` and avoid `// these sorts of comments`.
**Caution:** Inline JavaScript comments can cause problems with `compress.html`, so be sure to `/* comment this way */` and avoid `// these sorts of comments`.
{: .notice--warning}
**Note:** CDN services such as CloudFlare provide optional automatic
minification for HTML, CSS, and JavaScript. If you are serving your site via
such a service and have minification enabled, this configuration might be
redundant. {: .notice--info}
**Note:** CDN services such as CloudFlare provide optional automatic minification for HTML, CSS, and JavaScript. If you are serving your site via such a service and have minification enabled, this configuration might be redundant.
{: .notice--info}