Add link to jekyll-algolia's documentation
This commit is contained in:
parent
73d82964a2
commit
f878aa943b
5 changed files with 41 additions and 2 deletions
|
@ -3,6 +3,7 @@
|
||||||
### Enhancements
|
### Enhancements
|
||||||
|
|
||||||
* Update jQuery to version `3.3.1`. [#1491](https://github.com/mmistakes/minimal-mistakes/issues/1491)
|
* Update jQuery to version `3.3.1`. [#1491](https://github.com/mmistakes/minimal-mistakes/issues/1491)
|
||||||
|
* Add link to jekyll-algolia's `files_to_exclude` documentation.
|
||||||
|
|
||||||
### Bug Fixes
|
### Bug Fixes
|
||||||
|
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
title: "Configuration"
|
title: "Configuration"
|
||||||
permalink: /docs/configuration/
|
permalink: /docs/configuration/
|
||||||
excerpt: "Settings for configuring and customizing the theme."
|
excerpt: "Settings for configuring and customizing the theme."
|
||||||
last_modified_at: 2018-02-16T12:49:45-05:00
|
last_modified_at: 2018-02-19T08:09:39-05:00
|
||||||
toc: true
|
toc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -530,6 +530,9 @@ For faster and more relevant search ([see demo](https://mmistakes.github.io/mini
|
||||||
|
|
||||||
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).
|
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}
|
||||||
|
|
||||||
### SEO, Social Sharing, and Analytics Settings
|
### 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.
|
||||||
|
|
|
@ -4,7 +4,7 @@ permalink: /docs/history/
|
||||||
excerpt: "Change log of enhancements and bug fixes made to the theme."
|
excerpt: "Change log of enhancements and bug fixes made to the theme."
|
||||||
sidebar:
|
sidebar:
|
||||||
nav: docs
|
nav: docs
|
||||||
last_modified_at: 2018-02-16T15:18:36-05:00
|
last_modified_at: 2018-02-19T08:07:26-05:00
|
||||||
toc: true
|
toc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -13,6 +13,7 @@ toc: true
|
||||||
### Enhancements
|
### Enhancements
|
||||||
|
|
||||||
* Update jQuery to version `3.3.1`. [#1491](https://github.com/mmistakes/minimal-mistakes/issues/1491)
|
* Update jQuery to version `3.3.1`. [#1491](https://github.com/mmistakes/minimal-mistakes/issues/1491)
|
||||||
|
* Add link to jekyll-algolia's `files_to_exclude` documentation.
|
||||||
|
|
||||||
### Bug Fixes
|
### Bug Fixes
|
||||||
|
|
||||||
|
|
|
@ -3,10 +3,27 @@ title: "Exclude Post from Search Index"
|
||||||
search: false
|
search: false
|
||||||
categories:
|
categories:
|
||||||
- Jekyll
|
- Jekyll
|
||||||
|
last_modified_at: 2018-02-19T08:06:00-05:00
|
||||||
---
|
---
|
||||||
|
|
||||||
This post should not appear in the search index because it has the following YAML Front Matter:
|
This post should not appear in the search index because it has the following YAML Front Matter:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
search: false
|
search: false
|
||||||
|
```
|
||||||
|
|
||||||
|
**Note:** `search: false` only works to exclude post's when using Lunr as a search provider.
|
||||||
|
{: .notice--info}
|
||||||
|
|
||||||
|
To exclude files when using Algolia as a search provider add an array to `algolia.files_to_exclude` in your `_config.yml`. For more configuration options be sure to check their [full documentation](https://community.algolia.com/jekyll-algolia/options.html).
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
algolia:
|
||||||
|
# Exclude more files from indexing
|
||||||
|
files_to_exclude:
|
||||||
|
- index.html
|
||||||
|
- index.md
|
||||||
|
- excluded-file.html
|
||||||
|
- _posts/2017-11-28-post-exclude-search.md
|
||||||
|
- subdirectory/*.html
|
||||||
```
|
```
|
|
@ -3,10 +3,27 @@ title: "Exclude Post from Search Index"
|
||||||
search: false
|
search: false
|
||||||
categories:
|
categories:
|
||||||
- Jekyll
|
- Jekyll
|
||||||
|
last_modified_at: 2018-02-19T08:05:34-05:00
|
||||||
---
|
---
|
||||||
|
|
||||||
This post should not appear in the search index because it has the following YAML Front Matter:
|
This post should not appear in the search index because it has the following YAML Front Matter:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
search: false
|
search: false
|
||||||
|
```
|
||||||
|
|
||||||
|
**Note:** `search: false` only works to exclude post's when using **Lunr** as a search provider.
|
||||||
|
{: .notice--info}
|
||||||
|
|
||||||
|
To exclude files when using **Algolia** as a search provider add an array to `algolia.files_to_exclude` in your `_config.yml`. For more configuration options be sure to check their [full documentation](https://community.algolia.com/jekyll-algolia/options.html).
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
algolia:
|
||||||
|
# Exclude more files from indexing
|
||||||
|
files_to_exclude:
|
||||||
|
- index.html
|
||||||
|
- index.md
|
||||||
|
- excluded-file.html
|
||||||
|
- _posts/2017-11-28-post-exclude-search.md
|
||||||
|
- subdirectory/*.html
|
||||||
```
|
```
|
Loading…
Reference in a new issue