Document how to index post/collections entire content with search_full_content
This commit is contained in:
parent
3fb63f302d
commit
e10501aaa4
1 changed files with 38 additions and 20 deletions
|
@ -2,7 +2,7 @@
|
||||||
title: "Configuration"
|
title: "Configuration"
|
||||||
permalink: /docs/configuration/
|
permalink: /docs/configuration/
|
||||||
excerpt: "Settings for configuring and customizing the theme."
|
excerpt: "Settings for configuring and customizing the theme."
|
||||||
last_modified_at: 2017-11-27T12:11:11-05:00
|
last_modified_at: 2018-01-04T20:29:29-05:00
|
||||||
toc: true
|
toc: true
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -35,6 +35,7 @@ minimal_mistakes_skin: "default" # "air", "aqua", "contrast", "dark", "dirt", "n
|
||||||
{: .notice--warning}
|
{: .notice--warning}
|
||||||
|
|
||||||
#### Air skin: `air`
|
#### Air skin: `air`
|
||||||
|
|
||||||
{:.no_toc}
|
{:.no_toc}
|
||||||
|
|
||||||
<figure class="half">
|
<figure class="half">
|
||||||
|
@ -44,6 +45,7 @@ minimal_mistakes_skin: "default" # "air", "aqua", "contrast", "dark", "dirt", "n
|
||||||
</figure>
|
</figure>
|
||||||
|
|
||||||
#### Aqua skin: `aqua`
|
#### Aqua skin: `aqua`
|
||||||
|
|
||||||
{:.no_toc}
|
{:.no_toc}
|
||||||
|
|
||||||
<figure class="half">
|
<figure class="half">
|
||||||
|
@ -53,6 +55,7 @@ minimal_mistakes_skin: "default" # "air", "aqua", "contrast", "dark", "dirt", "n
|
||||||
</figure>
|
</figure>
|
||||||
|
|
||||||
#### Contrast skin: `contrast`
|
#### Contrast skin: `contrast`
|
||||||
|
|
||||||
{:.no_toc}
|
{:.no_toc}
|
||||||
|
|
||||||
<figure class="half">
|
<figure class="half">
|
||||||
|
@ -62,6 +65,7 @@ minimal_mistakes_skin: "default" # "air", "aqua", "contrast", "dark", "dirt", "n
|
||||||
</figure>
|
</figure>
|
||||||
|
|
||||||
#### Dark skin: `dark`
|
#### Dark skin: `dark`
|
||||||
|
|
||||||
{:.no_toc}
|
{:.no_toc}
|
||||||
|
|
||||||
<figure class="half">
|
<figure class="half">
|
||||||
|
@ -71,6 +75,7 @@ minimal_mistakes_skin: "default" # "air", "aqua", "contrast", "dark", "dirt", "n
|
||||||
</figure>
|
</figure>
|
||||||
|
|
||||||
#### Dirt skin: `dirt`
|
#### Dirt skin: `dirt`
|
||||||
|
|
||||||
{:.no_toc}
|
{:.no_toc}
|
||||||
|
|
||||||
<figure class="half">
|
<figure class="half">
|
||||||
|
@ -80,6 +85,7 @@ minimal_mistakes_skin: "default" # "air", "aqua", "contrast", "dark", "dirt", "n
|
||||||
</figure>
|
</figure>
|
||||||
|
|
||||||
#### Mint skin: `mint`
|
#### Mint skin: `mint`
|
||||||
|
|
||||||
{:.no_toc}
|
{:.no_toc}
|
||||||
|
|
||||||
<figure class="half">
|
<figure class="half">
|
||||||
|
@ -89,6 +95,7 @@ minimal_mistakes_skin: "default" # "air", "aqua", "contrast", "dark", "dirt", "n
|
||||||
</figure>
|
</figure>
|
||||||
|
|
||||||
#### Neon skin: `neon`
|
#### Neon skin: `neon`
|
||||||
|
|
||||||
{:.no_toc}
|
{:.no_toc}
|
||||||
|
|
||||||
<figure class="half">
|
<figure class="half">
|
||||||
|
@ -98,6 +105,7 @@ minimal_mistakes_skin: "default" # "air", "aqua", "contrast", "dark", "dirt", "n
|
||||||
</figure>
|
</figure>
|
||||||
|
|
||||||
#### Neon skin: `plum`
|
#### Neon skin: `plum`
|
||||||
|
|
||||||
{:.no_toc}
|
{:.no_toc}
|
||||||
|
|
||||||
<figure class="half">
|
<figure class="half">
|
||||||
|
@ -107,6 +115,7 @@ minimal_mistakes_skin: "default" # "air", "aqua", "contrast", "dark", "dirt", "n
|
||||||
</figure>
|
</figure>
|
||||||
|
|
||||||
#### Sunrise skin: `sunrise`
|
#### Sunrise skin: `sunrise`
|
||||||
|
|
||||||
{:.no_toc}
|
{:.no_toc}
|
||||||
|
|
||||||
<figure class="half">
|
<figure class="half">
|
||||||
|
@ -205,7 +214,7 @@ head_scripts:
|
||||||
- /assets/js/your-custom-head-script.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.
|
Consult the [JavaScript documentation]({{ site.baseurl }}{% link \_docs/17-javascript.md %}) for more information on working with theme scripts.
|
||||||
{: .notice--info}
|
{: .notice--info}
|
||||||
|
|
||||||
### Site Default Teaser Image
|
### Site Default Teaser Image
|
||||||
|
@ -467,6 +476,15 @@ search: true
|
||||||
|
|
||||||
![masthead search example]({{ "/assets/images/masthead-search.gif" | absolute_url }})
|
![masthead search example]({{ "/assets/images/masthead-search.gif" | absolute_url }})
|
||||||
|
|
||||||
|
To index the full content of your documents set `search_full_content` to `true` in `_config.yml`:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
search_full_content: true
|
||||||
|
```
|
||||||
|
|
||||||
|
**Note:** If you have length posts or a large amount of them the size of search index could impact page load performance. Setting `search_full_content` back to `false` (the default) restricts indexing the first 50 words of post's and collection documents.
|
||||||
|
{: .notice--warning}
|
||||||
|
|
||||||
### 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.
|
||||||
|
@ -784,7 +802,7 @@ tag_archive:
|
||||||
|
|
||||||
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`).
|
**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}
|
{: .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).
|
||||||
|
|
Loading…
Reference in a new issue