From c6ca6f61ab99a67e972c12e842ac949b786bbd2c Mon Sep 17 00:00:00 2001 From: Patrick Marsceill Date: Fri, 16 Nov 2018 11:47:30 -0500 Subject: [PATCH] Update docs for search config --- docs/search.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/search.md b/docs/search.md index 8656427..0c9543f 100644 --- a/docs/search.md +++ b/docs/search.md @@ -12,7 +12,9 @@ Just the docs uses [lunr.js](http://lunrjs.com) to add a client-side search inte - Page content - Page URL -## Setup search +## Set up search + +### 1. Generate search index Before you can use search, you must initialize the feature by running this 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)._ + +### 2. Enable search in configuration + +In your site's `_config.yml` enable search: + +```yml +# Enable or disable the site search +search_enabled: true +```