1043 lines
44 KiB
Markdown
1043 lines
44 KiB
Markdown
---
|
|
title: "Configuration"
|
|
permalink: /docs/configuration/
|
|
excerpt: "Settings for configuring and customizing the theme."
|
|
last_modified_at: 2019-01-15T08:31:44-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.
|
|
|
|
**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.
|
|
|
|
## Site settings
|
|
|
|
### Theme
|
|
|
|
If you're using the Ruby gem version of the theme you'll need this line to activate it:
|
|
|
|
```yaml
|
|
theme: minimal-mistakes-jekyll
|
|
```
|
|
|
|
### Skin
|
|
|
|
Easily change the color scheme of the theme using one of the provided "skins":
|
|
|
|
```yaml
|
|
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}
|
|
|
|
#### Air skin: `air`
|
|
|
|
{:.no_toc}
|
|
|
|
<figure class="half">
|
|
<a href="{{ site.baseurl }}/assets/images/air-skin-archive-large.png"><img src="{{ site.baseurl }}/assets/images/air-skin-archive.png"></a>
|
|
<a href="{{ site.baseurl }}/assets/images/air-skin-post-large.png"><img src="{{ site.baseurl }}/assets/images/air-skin-post.png"></a>
|
|
<figcaption>Calm and blue.</figcaption>
|
|
</figure>
|
|
|
|
#### Aqua skin: `aqua`
|
|
|
|
<figure class="half">
|
|
<a href="{{ site.baseurl }}/assets/images/aqua-skin-archive-large.png"><img src="{{ site.baseurl }}/assets/images/aqua-skin-archive.png"></a>
|
|
<a href="{{ site.baseurl }}/assets/images/aqua-skin-post-large.png"><img src="{{ site.baseurl }}/assets/images/aqua-skin-post.png"></a>
|
|
<figcaption>Just like water.</figcaption>
|
|
</figure>
|
|
|
|
#### Contrast skin: `contrast`
|
|
|
|
<figure class="half">
|
|
<a href="{{ site.baseurl }}/assets/images/contrast-skin-archive-large.png"><img src="{{ site.baseurl }}/assets/images/contrast-skin-archive.png"></a>
|
|
<a href="{{ site.baseurl }}/assets/images/contrast-skin-post-large.png"><img src="{{ site.baseurl }}/assets/images/contrast-skin-post.png"></a>
|
|
<figcaption>Retro feel with bold blue links and inverted footer.</figcaption>
|
|
</figure>
|
|
|
|
#### Dark skin: `dark`
|
|
|
|
<figure class="half">
|
|
<a href="{{ site.baseurl }}/assets/images/dark-skin-archive-large.png"><img src="{{ site.baseurl }}/assets/images/dark-skin-archive.png"></a>
|
|
<a href="{{ site.baseurl }}/assets/images/dark-skin-post-large.png"><img src="{{ site.baseurl }}/assets/images/dark-skin-post.png"></a>
|
|
<figcaption>Inverted palette, white text on a dark background.</figcaption>
|
|
</figure>
|
|
|
|
#### Dirt skin: `dirt`
|
|
|
|
<figure class="half">
|
|
<a href="{{ site.baseurl }}/assets/images/dirt-skin-archive-large.png"><img src="{{ site.baseurl }}/assets/images/dirt-skin-archive.png"></a>
|
|
<a href="{{ site.baseurl }}/assets/images/dirt-skin-post-large.png"><img src="{{ site.baseurl }}/assets/images/dirt-skin-post.png"></a>
|
|
<figcaption>Earthy tones.</figcaption>
|
|
</figure>
|
|
|
|
#### Mint skin: `mint`
|
|
|
|
{:.no_toc}
|
|
|
|
<figure class="half">
|
|
<a href="{{ site.baseurl }}/assets/images/mint-skin-archive-large.png"><img src="{{ site.baseurl }}/assets/images/mint-skin-archive.png"></a>
|
|
<a href="{{ site.baseurl }}/assets/images/mint-skin-post-large.png"><img src="{{ site.baseurl }}/assets/images/mint-skin-post.png"></a>
|
|
<figcaption>Minty fresh green.</figcaption>
|
|
</figure>
|
|
|
|
#### Neon skin: `neon`
|
|
|
|
<figure class="half">
|
|
<a href="{{ site.baseurl }}/assets/images/neon-skin-archive-large.png"><img src="{{ site.baseurl }}/assets/images/neon-skin-archive.png"></a>
|
|
<a href="{{ site.baseurl }}/assets/images/neon-skin-post-large.png"><img src="{{ site.baseurl }}/assets/images/neon-skin-post.png"></a>
|
|
<figcaption>Inverted palette, white text on a dark background.</figcaption>
|
|
</figure>
|
|
|
|
#### Neon skin: `plum`
|
|
|
|
<figure class="half">
|
|
<a href="{{ site.baseurl }}/assets/images/plum-skin-archive-large.png"><img src="{{ site.baseurl }}/assets/images/plum-skin-archive.png"></a>
|
|
<a href="{{ site.baseurl }}/assets/images/plum-skin-post-large.png"><img src="{{ site.baseurl }}/assets/images/plum-skin-post.png"></a>
|
|
<figcaption>Purple reigns supreme.</figcaption>
|
|
</figure>
|
|
|
|
#### Sunrise skin: `sunrise`
|
|
|
|
<figure class="half">
|
|
<a href="{{ site.baseurl }}/assets/images/sunrise-skin-archive-large.png"><img src="{{ site.baseurl }}/assets/images/sunrise-skin-archive.png"></a>
|
|
<a href="{{ site.baseurl }}/assets/images/sunrise-skin-post-large.png"><img src="{{ site.baseurl }}/assets/images/sunrise-skin-post.png"></a>
|
|
<figcaption>Oranges and red.</figcaption>
|
|
</figure>
|
|
|
|
### Site locale
|
|
|
|
`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>).
|
|
|
|
Properly setting the locale is important for associating localized text found in the [**UI Text**]({{ "/docs/ui-text/" | relative_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}
|
|
|
|
### Site title
|
|
|
|
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.
|
|
|
|
_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}
|
|
|
|
### 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.
|
|
|
|
_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}
|
|
|
|
### Site description
|
|
|
|
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."`
|
|
|
|
### 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.
|
|
|
|
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}
|
|
|
|
### 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.
|
|
|
|
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/).
|
|
|
|
**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`.
|
|
|
|
```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.
|
|
|
|
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:
|
|
|
|
**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).
|
|
|
|
### Site 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:
|
|
|
|
```yaml
|
|
head_scripts:
|
|
- https://code.jquery.com/jquery-3.2.1.min.js
|
|
- /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.
|
|
{: .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:
|
|
|
|
```yaml
|
|
teaser: /assets/images/500x300.png
|
|
```
|
|
|
|
This image can be overridden at anytime by applying the following to a document's YAML Front Matter.
|
|
|
|
```yaml
|
|
header:
|
|
teaser: /assets/images/my-awesome-post-teaser.jpg
|
|
```
|
|
|
|
<figure>
|
|
<img src="{{ '/assets/images/mm-teaser-images-example.jpg' | relative_url }}" alt="teaser image example">
|
|
<figcaption>Example of teaser images found in the related posts module.</figcaption>
|
|
</figure>
|
|
|
|
### Site masthead logo
|
|
|
|
To insert a logo before the site title, place a graphic in the `/assets/images/` directory and add the filename to `_config.yml`:
|
|
|
|
```yaml
|
|
logo: "/assets/images/88x88.png"
|
|
```
|
|
|
|
<figure>
|
|
<img src="{{ '/assets/images/mm-masthead-logo.png' | relative_url }}" alt="masthead with logo and custom title">
|
|
<figcaption>Example of masthead with logo and custom title.</figcaption>
|
|
</figure>
|
|
|
|
### Site masthead title
|
|
|
|
By default your site title is used in the masthead. You can override this text by adding the following to your `_config.yml`:
|
|
|
|
```yaml
|
|
masthead_title: "My Custom Title"
|
|
```
|
|
|
|
### 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:
|
|
|
|
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" | relative_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/" | relative_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`.
|
|
|
|
![reading time example]({{ "/assets/images/mm-read-time-example.jpg" | relative_url }})
|
|
|
|
Instead of adding `read_time: true` to each post, apply as a default in `_config.yml` like so:
|
|
|
|
```yaml
|
|
defaults:
|
|
# _posts
|
|
- scope:
|
|
path: ""
|
|
type: posts
|
|
values:
|
|
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`.
|
|
|
|
### Comments
|
|
|
|
[**Disqus**](https://disqus.com/), [**Discourse**](https://www.discourse.org/), [**Facebook**](https://developers.facebook.com/docs/plugins/comments), [**utterances**](https://utteranc.es/), 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 |
|
|
| ---------------- | ------------------------- |
|
|
| **disqus** | Disqus |
|
|
| **discourse** | Discourse |
|
|
| **facebook** | Facebook Comments |
|
|
| **staticman_v2** | Staticman v2 |
|
|
| **staticman** | Staticman v1 (deprecated) |
|
|
| **utterances** | utterances |
|
|
| **custom** | Other |
|
|
|
|
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:
|
|
|
|
```yaml
|
|
defaults:
|
|
# _posts
|
|
- scope:
|
|
path: ""
|
|
type: posts
|
|
values:
|
|
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.
|
|
|
|
**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:
|
|
|
|
```yaml
|
|
comments:
|
|
provider: "disqus"
|
|
disqus:
|
|
shortname: "your-disqus-shortname"
|
|
```
|
|
|
|
#### 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).
|
|
|
|
```yaml
|
|
comments:
|
|
provider: "discourse"
|
|
discourse:
|
|
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}
|
|
|
|
#### Facebook comments
|
|
|
|
To enable Facebook Comments choose how many comments you'd like visible per post and the color scheme of the widget.
|
|
|
|
```yaml
|
|
comments:
|
|
provider: "facebook"
|
|
facebook:
|
|
appid: # optional
|
|
num_posts: # 5 (default)
|
|
colorscheme: # "light" (default), "dark"
|
|
```
|
|
|
|
#### utterances comments
|
|
|
|
To use utterances you will need to [install the app](https://github.com/apps/utterances) to your GitHub repository by adding the following to `_config.yml`:
|
|
|
|
```yaml
|
|
repository: # GitHub username/repo-name e.g. "mmistakes/minimal-mistakes"
|
|
```
|
|
|
|
**Note:** Make sure the repo is public, otherwise your readers will not be able to view the issues/comments. The [issues feature](https://guides.github.com/features/issues/) also needs to be active on your repo.
|
|
{: .notice--warning}
|
|
|
|
To enable utterances on the front end set `comments.provider` and the color theme of the widget.
|
|
|
|
```yaml
|
|
comments:
|
|
provider: "utterances"
|
|
utterances:
|
|
theme: "github-light" # "github-dark"
|
|
issue_term: "pathname"
|
|
```
|
|
|
|
#### Static-based comments via 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:** Please note that as of September 2018, Staticman is reaching GitHub API limits due to its popularity, and it is recommended by its maintainer that users deploy their own instances for production (use `site.staticman.endpoint`).
|
|
{: .notice--warning}
|
|
|
|
##### 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/docs/index.html)" guide for more info.
|
|
|
|
##### Configure Staticman
|
|
|
|
###### Staticman v3
|
|
|
|
Due to the [support for GitLab](https://github.com/eduardoboucas/staticman/pull/219), the URL scheme has been changed. Between `v3/entry/` and `/{your Git username}`, one needs to input a Git service provider (either `github` or `gitlab`). For example
|
|
|
|
https://{your Staticman v3 API}/v3/entry/github/{your Git username}/{your repository name}/...
|
|
|
|
```yaml
|
|
# _config.yml (defaults)
|
|
repository : # Git username/repo-name e.g. "mmistakes/minimal-mistakes"
|
|
comments:
|
|
provider : "staticman_v2"
|
|
staticman:
|
|
branch : "master"
|
|
endpoint : https://{your Staticman v3 API}/v3/entry/github/
|
|
```
|
|
|
|
###### 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).
|
|
|
|
```yaml
|
|
# staticman.yml (defaults)
|
|
comments:
|
|
allowedFields : ["name", "email", "url", "message"]
|
|
branch : "master"
|
|
commitMessage : "New comment by {fields.name}"
|
|
filename : "comment-{@timestamp}"
|
|
format : "yaml"
|
|
generatedFields:
|
|
date:
|
|
type : "date"
|
|
options:
|
|
format : "iso8601"
|
|
moderation : true
|
|
path : "_data/comments/{options.slug}"
|
|
requiredFields : ["name", "email", "message"]
|
|
transforms:
|
|
email : md5
|
|
```
|
|
|
|
These settings need to be added to your `_config.yml` file as well:
|
|
|
|
```yaml
|
|
# _config.yml (defaults)
|
|
repository : # GitHub username/repo-name e.g. "mmistakes/minimal-mistakes"
|
|
comments:
|
|
provider : "staticman_v2"
|
|
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}
|
|
|
|
**Note:** Staticman is currently compatible with GitHub and GitLab based repositories. [Support for GitLab Pages](https://github.com/eduardoboucas/staticman/issues/22) is already available at [Staticman v3](https://github.com/eduardoboucas/staticman/pull/219).
|
|
{: .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).
|
|
|
|
```yaml
|
|
# _config.yml (defaults)
|
|
comments:
|
|
provider: "staticman"
|
|
staticman:
|
|
allowedFields : ['name', 'email', 'url', 'message']
|
|
branch : "master"
|
|
commitMessage : "New comment by {fields.name}"
|
|
filename : comment-{@timestamp}
|
|
format : "yml"
|
|
moderation : true
|
|
path : "_data/comments/{options.slug}"
|
|
requiredFields : ['name', 'email', 'message']
|
|
transforms:
|
|
email : "md5"
|
|
generatedFields:
|
|
date:
|
|
type : "date"
|
|
options:
|
|
format : "iso8601" # "iso8601" (default), "timestamp-seconds", "timestamp-milliseconds"
|
|
```
|
|
|
|
##### 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).
|
|
|
|
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}
|
|
|
|
![pull-request webhook]({{ "/assets/images/mm-staticman-pr-webhook.jpg" | relative_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).
|
|
|
|
```yaml
|
|
reCaptcha:
|
|
enabled: true
|
|
siteKey: # "6LdRBykTAAAAAFB46MnIu6ixuxwu9W1ihFF8G60Q"
|
|
secret: # "PznnZGu3P6eTHRPLORniSq+J61YEf+A9zmColXDM5icqF49gbunH51B8+h+i2IvewpuxtA9TFoK68TuhUp/X3YKmmqhXasegHYabY50fqF9nJh9npWNhvITdkQHeaOqnFXUIwxfiEeUt49Yoa2waRR7a5LdRAP3SVM8hz0KIBT4="
|
|
```
|
|
|
|
#### 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`.
|
|
|
|
### 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:
|
|
|
|
```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).
|
|
{: .notice--info}
|
|
|
|
### Site search
|
|
|
|
To enable site-wide search add `search: true` to your `_config.yml`.
|
|
|
|
![masthead search example]({{ "/assets/images/masthead-search.gif" | relative_url }})
|
|
|
|
#### Lunr (default)
|
|
|
|
The default search uses [**Lunr**](https://lunrjs.com/) to build a search index of all your documents. This method is 100% compatible with sites hosted on GitHub Pages.
|
|
|
|
**Note:** Only the first 50 words of a post or page's body content is added to the Lunr search index. Setting `search_full_content` to `true` in your `_config.yml` will override this and could impact page load performance.
|
|
{: .notice--warning}
|
|
|
|
#### Algolia
|
|
|
|
For faster and more relevant search ([see demo](https://mmistakes.github.io/minimal-mistakes-algolia-search/)):
|
|
|
|
1. Add the [`jekyll-algolia`](https://github.com/algolia/jekyll-algolia) gem to your `Gemfile`, in the `:jekyll_plugins` section.
|
|
|
|
```ruby
|
|
group :jekyll_plugins do
|
|
gem "jekyll-feed"
|
|
gem "jekyll-seo-tag"
|
|
gem "jekyll-sitemap"
|
|
gem "jekyll-paginate"
|
|
gem "jekyll-include-cache"
|
|
gem "jekyll-algolia"
|
|
end
|
|
```
|
|
|
|
Once this is done, download all dependencies by running `bundle install`.
|
|
|
|
2. Switch search providers from `lunr` to `algolia` in your `_config.yml` file:
|
|
|
|
```yaml
|
|
search_provider: algolia
|
|
```
|
|
|
|
3. Add the following Algolia credentials to your `_config.yml` file. *If you don't have an Algolia account, you can open a free [Community plan](https://www.algolia.com/users/sign_up/hacker). Once signed in, you can grab your credentials from [your dashboard](https://www.algolia.com/licensing).*
|
|
|
|
```yaml
|
|
algolia:
|
|
application_id: # YOUR_APPLICATION_ID
|
|
index_name: # YOUR_INDEX_NAME
|
|
search_only_api_key: # YOUR_SEARCH_ONLY_API_KEY
|
|
powered_by: # true (default), false
|
|
```
|
|
|
|
4. Once your credentials are setup, you can run the indexing with the following command:
|
|
|
|
```
|
|
ALGOLIA_API_KEY=your_admin_api_key bundle exec jekyll algolia
|
|
```
|
|
|
|
For Windows users you will have to use `set` to assigned the `ALGOLIA_API_KEY` environment variable.
|
|
|
|
```
|
|
set ALGOLIA_API_KEY=your_admin_api_key
|
|
bundle exec jekyll algolia
|
|
```
|
|
|
|
Note that `ALGOLIA_API_KEY` should be set to your admin API key.
|
|
|
|
To use the Algolia search with GitHub Pages hosted sites follow [this deployment guide](https://community.algolia.com/jekyll-algolia/github-pages.html). Or this guide for [deploying on Netlify](https://community.algolia.com/jekyll-algolia/netlify.html).
|
|
|
|
**Note:** The Jekyll Algolia plugin can be configured in several ways. Be sure to check out [their full documentation](https://community.algolia.com/jekyll-algolia/options.html "Algolia configuration") on how to exclude files and other valuable settings.
|
|
{: .notice--info}
|
|
|
|
#### Google Custom Search Engine
|
|
|
|
Add a Google search box to your site.
|
|
|
|
1. Create a **New search engine** in [Google Custom Search Engine](https://cse.google.com/cse/all), give it an appropriate name and setup "Sites to search" to your liking.
|
|
|
|
2. Under **Look and feel** choose the "Results only" layout and a theme (*Minimalist* is a good choice to match the default look of the Minimal Mistakes).
|
|
|
|
|
|
|
|
3. Select "Save & Get Code" and grab your search engine ID from the line that begins with `var cx = 'YOUR_SEARCH_ENGINE_ID'`.
|
|
|
|
4. Add your search engine ID to `_config.yml` like so:
|
|
|
|
```yaml
|
|
google:
|
|
search_engine_id: YOUR_SEARCH_ENGINE_ID
|
|
```
|
|
|
|
**Note:** If your site is new and hasn't been indexed by Google yet, search will be incomplete and won't provide accurate results.
|
|
{: .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.
|
|
|
|
#### 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"`.
|
|
|
|
**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.
|
|
|
|
Copy and paste the string inside of `content`:
|
|
|
|
```html
|
|
<meta name="msvalidate.01" content="0FC3FD70512616B052E755A56F8952D" />
|
|
```
|
|
|
|
Into `_config.yml`
|
|
|
|
```yaml
|
|
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/).
|
|
|
|
Much like Google and Bing you'll be provided with a meta description:
|
|
|
|
```html
|
|
<meta name="naver-site-verification" content="6BF5A01C0E650B479B612AC5A2184144">`
|
|
```
|
|
|
|
Which you can add to your `_config.yml` like so:
|
|
|
|
```yaml
|
|
naver_site_verification: "6BF5A01C0E650B479B612AC5A2184144"
|
|
```
|
|
|
|
#### Yandex
|
|
|
|
To verify site ownership copy and paste the string inside of `content`:
|
|
|
|
```html
|
|
<meta name='yandex-verification' content='2132801JL' />
|
|
```
|
|
|
|
Into `_config.yml`
|
|
|
|
```yaml
|
|
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.
|
|
|
|
##### 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.
|
|
|
|
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.
|
|
|
|
**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
|
|
|
|
If you have a Facebook ID or publisher page add them:
|
|
|
|
```yaml
|
|
facebook:
|
|
app_id: # A Facebook app ID
|
|
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.
|
|
|
|
```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}
|
|
|
|
##### 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.
|
|
|
|
```yaml
|
|
og_image: /assets/images/site-logo.png
|
|
```
|
|
|
|
<figure>
|
|
<img src="{{ '/assets/images/mm-twitter-card-summary-image.jpg' | relative_url }}" alt="Twitter Card summary example">
|
|
<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.
|
|
|
|
<figure>
|
|
<img src="{{ '/assets/images/mm-twitter-card-summary-large.jpg' | relative_url }}" alt="page shared on Twitter">
|
|
<figcaption>Shared page on Twitter with header image assigned.</figcaption>
|
|
</figure>
|
|
|
|
<figure>
|
|
<img src="{{ '/assets/images/facebook-share-example.jpg' | relative_url }}" alt="page shared on Facebook">
|
|
<figcaption>Shared page on Facebook with header image assigned.</figcaption>
|
|
</figure>
|
|
|
|
##### 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.
|
|
|
|
```yaml
|
|
social:
|
|
type: # Person or Organization (defaults to Person)
|
|
name: # If the user or organization name differs from the site's name
|
|
links:
|
|
- "https://twitter.com/yourTwitter"
|
|
- "https://facebook.com/yourFacebook"
|
|
- "https://instagram.com/yourProfile"
|
|
- "https://www.linkedin.com/in/yourprofile"
|
|
- "https://plus.google.com/your_profile"
|
|
```
|
|
|
|
#### Analytics
|
|
|
|
Analytics is disabled by default. To enable globally select one of the following:
|
|
|
|
| Name | Analytics Provider |
|
|
| -------------------- | --------------------------------------------------------------- |
|
|
| **google** | [Google Standard Analytics](https://www.google.com/analytics/) |
|
|
| **google-universal** | [Google Universal Analytics](https://www.google.com/analytics/) |
|
|
| **google-gtag** | [Google Analytics Global Site Tag](https://www.google.com/analytics/) |
|
|
| **custom** | Other analytics providers |
|
|
|
|
For Google Analytics add your Tracking Code:
|
|
|
|
```yaml
|
|
analytics:
|
|
provider: "google-gtag"
|
|
google:
|
|
tracking_id: "UA-1234567-8"
|
|
anonymize_ip: false # default
|
|
```
|
|
|
|
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.
|
|
|
|
![author sidebar example]({{ "/assets/images/mm-author-sidebar-example.jpg" | relative_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}
|
|
|
|
```yaml
|
|
author:
|
|
name : "Your Name"
|
|
avatar : "/assets/images/bio-photo.jpg"
|
|
bio : "My awesome biography constrained to a sentence or two goes here."
|
|
location : "Somewhere, USA"
|
|
```
|
|
|
|
Author links are all optional, include the ones you want visible under the `author.links` array.
|
|
|
|
| Name | Description |
|
|
| --- | --- |
|
|
| **label** | Link label (e.g. `"Twitter"`) |
|
|
| **icon** | [Font Awesome icon](https://fontawesome.com/icons?d=gallery) classes (e.g. `"fab fa-fw fa-twitter-square"`) |
|
|
| **url** | Link URL (e.g. `"https://twitter.com/mmistakes"`) |
|
|
|
|
```yaml
|
|
author:
|
|
name: "Your Name"
|
|
avatar: "/assets/images/bio-photo.jpg"
|
|
bio: "I am an amazing person."
|
|
location: "Somewhere"
|
|
links:
|
|
- label: "Made Mistakes"
|
|
icon: "fas fa-fw fa-link"
|
|
url: "https://mademistakes.com"
|
|
- label: "Twitter"
|
|
icon: "fab fa-fw fa-twitter-square"
|
|
url: "https://twitter.com/mmistakes"
|
|
- label: "GitHub"
|
|
icon: "fab fa-fw fa-github"
|
|
url: "https://github.com/mmistakes"
|
|
- label: "Instagram"
|
|
icon: "fab fa-fw fa-instagram"
|
|
url: "https://instagram.com/mmistakes"
|
|
```
|
|
|
|
To customize the author sidebar, read the full [layout documentation]({{ "/docs/layouts/#author-profile" | relative_url }}).
|
|
|
|
## Site footer
|
|
|
|
Footer links can be added under the `footer.links` array.
|
|
|
|
| Name | Description |
|
|
| --- | --- |
|
|
| **label** | Link label (e.g. `"Twitter"`) |
|
|
| **icon** | [Font Awesome icon](https://fontawesome.com/icons?d=gallery) classes (e.g. `"fab fa-fw fa-twitter-square"`) |
|
|
| **url** | Link URL (e.g. `"https://twitter.com/mmistakes"`) |
|
|
|
|
```yaml
|
|
footer:
|
|
links:
|
|
- label: "Twitter"
|
|
icon: "fab fa-fw fa-twitter-square"
|
|
url: "https://twitter.com/mmistakes"
|
|
- label: "GitHub"
|
|
icon: "fab fa-fw fa-github"
|
|
url: "https://github.com/mmistakes"
|
|
- label: "Instagram"
|
|
icon: "fab fa-fw fa-instagram"
|
|
url: "https://instagram.com/mmistakes"
|
|
```
|
|
|
|
**Note:** Twitter and Facebook footer links no longer automatically pull from `site.twitter.username` and `site.facebook.username`. This behavior has been deprecated in favor of the `footer.links` array above.
|
|
{: .notice--danger}
|
|
|
|
To change "Follow:" text that precedes footer links, edit the `follow_label` key in `_data/ui-text.yml`.
|
|
|
|
## Reading files
|
|
|
|
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.
|
|
|
|
## 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.
|
|
|
|
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:
|
|
# _posts
|
|
- scope:
|
|
path: ""
|
|
type: posts
|
|
values:
|
|
layout: single
|
|
author_profile: true
|
|
read_time: true
|
|
comments: true
|
|
share: true
|
|
related: true
|
|
```
|
|
|
|
Pages Front Matter defaults can be scoped like this:
|
|
|
|
```yaml
|
|
defaults:
|
|
# _pages
|
|
- scope:
|
|
path: ""
|
|
type: pages
|
|
values:
|
|
layout: single
|
|
```
|
|
|
|
And collections like this:
|
|
|
|
```yaml
|
|
defaults:
|
|
# _foo
|
|
- scope:
|
|
path: ""
|
|
type: foo
|
|
values:
|
|
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).
|
|
|
|
## 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`.
|
|
|
|
**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:
|
|
|
|
```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" | relative_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:
|
|
|
|
```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}
|
|
|
|
### 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.
|
|
|
|
```yaml
|
|
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.
|
|
|
|
| Plugin | Description |
|
|
| --- | --- |
|
|
| [jekyll-paginate][jekyll-paginate] | Pagination Generator for Jekyll. |
|
|
| [jekyll-sitemap][jekyll-sitemap] | Jekyll plugin to silently generate a sitemaps.org compliant sitemap for your Jekyll site. |
|
|
| [jekyll-gist][jekyll-gist] | Liquid tag for displaying GitHub Gists in Jekyll sites. |
|
|
| [jekyll-feed][jekyll-feed] | A Jekyll plugin to generate an Atom (RSS-like) feed of your Jekyll posts. |
|
|
| [jemoji][jemoji] | GitHub-flavored emoji plugin for Jekyll. |
|
|
| [jekyll-include-cache][jekyll-include-cache] | Liquid tag that caches Liquid includes. |
|
|
|
|
[jekyll-paginate]: https://github.com/jekyll/jekyll-paginate
|
|
[jekyll-sitemap]: https://github.com/jekyll/jekyll-sitemap
|
|
[jekyll-gist]: https://github.com/jekyll/jekyll-gist
|
|
[jekyll-feed]: https://github.com/jekyll/jekyll-feed
|
|
[jemoji]: https://github.com/jekyll/jemoji
|
|
[jekyll-include-cache]: https://github.com/benbalter/jekyll-include-cache
|
|
|
|
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.
|
|
|
|
**Note:** The [jekyll-include-cache](https://github.com/benbalter/jekyll-include-cache) plugin needs to be installed in your `Gemfile` and added to the `plugins` array of `_config.yml`. Otherwise you'll throw `Unknown tag 'include_cached'` errors at build.
|
|
{: .notice--warning}
|
|
|
|
## 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.
|
|
|
|
[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}
|
|
|
|
```yaml
|
|
category_archive:
|
|
type: liquid
|
|
path: /categories/
|
|
tag_archive:
|
|
type: liquid
|
|
path: /tags/
|
|
```
|
|
|
|
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.md) (copy to `_pages/category-archive.md`) and [`/tags/index.html`](https://github.com/{{ site.repository }}/blob/master/docs/_pages/tag-archive.md) (copy to `_pages/tag-archive.md`).
|
|
{: .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.md` and `tag-archive.md`) 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`:
|
|
|
|
```
|
|
group :jekyll_plugins do
|
|
gem "jekyll-archives"
|
|
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):
|
|
|
|
```yaml
|
|
category_archive:
|
|
type: jekyll-archives
|
|
path: /categories/
|
|
tag_archive:
|
|
type: jekyll-archives
|
|
path: /tags/
|
|
jekyll-archives:
|
|
enabled:
|
|
- categories
|
|
- tags
|
|
layouts:
|
|
category: archive-taxonomy
|
|
tag: archive-taxonomy
|
|
permalinks:
|
|
category: /categories/:name/
|
|
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}
|
|
|
|
## 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'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`.
|
|
|
|
```yaml
|
|
compress_html:
|
|
clippings: all
|
|
ignore:
|
|
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`.
|
|
{: .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}
|