thang/notes
1
0
Fork 0
mirror of https://github.com/thangisme/notes.git synced 2024-11-06 20:07:31 -05:00
Code Issues Projects Releases Wiki Activity

Update docs for search config

Browse Source
This commit is contained in:
Patrick Marsceill 2018-11-16 11:47:30 -05:00
parent e41c1701a5
commit c6ca6f61ab
No known key found for this signature in database
GPG Key ID: 286B93882D828F40
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/search.md
View File

@ -12,7 +12,9 @@ Just the docs uses [lunr.js](http://lunrjs.com) to add a client-side search inte
- Page content - Page content
- Page URL - Page URL
## Setup search ## Set up search
### 1. Generate search index
Before you can use search, you must initialize the feature by running this Before you can use search, you must initialize the feature by running this
rake command that comes with the `just-the-docs` rake command that comes with the `just-the-docs`
@ -41,3 +43,12 @@ your search index. Alternatively, you can create the file manually in the
``` ```
_Note: If you don't run this rake command or create this file manually, search will not work (or it will use the search index data from this docs site, not your site's content)._ _Note: If you don't run this rake command or create this file manually, search will not work (or it will use the search index data from this docs site, not your site's content)._
### 2. Enable search in configuration
In your site's `_config.yml` enable search:
```yml
# Enable or disable the site search
search_enabled: true
```