Skip to content

Commit def3aaf

Browse files
authored
Clarify lunr only searches documents in collections (#2450)
1 parent 2d0b445 commit def3aaf

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/_docs/05-configuration.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -374,7 +374,7 @@ repository: # GitHub username/repo-name e.g. "mmistakes/minimal-mistakes"
374374
**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.
375375
{: .notice--warning}
376376

377-
To enable utterances on the front end set `comments.provider` and the color theme of the widget.
377+
To enable utterances on the front end set `comments.provider` and the color theme of the widget.
378378

379379
```yaml
380380
comments:
@@ -533,7 +533,7 @@ To enable site-wide search add `search: true` to your `_config.yml`.
533533

534534
#### Lunr (default)
535535

536-
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.
536+
The default search uses [**Lunr**](https://lunrjs.com/) to build a search index of all post and your documents in collections. This method is 100% compatible with sites hosted on GitHub Pages.
537537

538538
**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.
539539
{: .notice--warning}
@@ -600,13 +600,13 @@ Add a Google search box to your site.
600600
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.
601601

602602
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).
603-
603+
604604
![Google Custom Search Engine layout]({{ '/assets/images/google-custom-search-engine-layout.png' | relative_url }})
605605

606606
3. Select "Save & Get Code" and grab your search engine ID from the line that begins with `var cx = 'YOUR_SEARCH_ENGINE_ID'`.
607607

608608
4. Add your search engine ID to `_config.yml` like so:
609-
609+
610610
```yaml
611611
google:
612612
search_engine_id: YOUR_SEARCH_ENGINE_ID
@@ -793,7 +793,7 @@ author:
793793
name : "Your Name"
794794
avatar : "/assets/images/bio-photo.jpg"
795795
bio : "My awesome biography constrained to a sentence or two goes here."
796-
location : "Somewhere, USA"
796+
location : "Somewhere, USA"
797797
```
798798

799799
Author links are all optional, include the ones you want visible under the `author.links` array.

0 commit comments

Comments
 (0)