From 102b4cea8d7e3ede13e3986f27436825dcb98569 Mon Sep 17 00:00:00 2001 From: Leclerc Gwendal Date: Fri, 21 Oct 2016 02:29:00 +0200 Subject: [PATCH] feat: add search section into the README.md --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9c9b2117d0..365b6ff458 100644 --- a/README.md +++ b/README.md @@ -23,9 +23,28 @@ $ git clone https://github.com/matcornic/hugo-theme-learn.git - Automatic table of contents - Create buttons (typically used to provide a link to a demo) +# Search +To use the `search` functionality, you just have to put a `lunr` index which respects this format : +```json +[ + { + "uri": "/docs/01-start/index", + "title": "Get started", + "content": "\n\nGet started\n\nAll you need to know...\n", + "tags": ["start", "intro"] + }, + ... +] +``` + +into a `static/json/search.json` file in your hugo project. + +And set `search = true` in your config.toml + +To generate your lunr index, you can see this project https://github.com/gwleclerc/lunr-hugo which parse your markdown files and extract toml and yaml headers to create index with corresponding format. + # TODO - [Handling more than 2 levels in documentation](https://github.com/matcornic/hugo-theme-learn/issues/11) -- [Search in site](https://github.com/matcornic/hugo-theme-learn/issues/12) - [Handling videos](https://github.com/matcornic/hugo-theme-learn/issues/13) - [Add optional button to create doc issue (like github)](https://github.com/matcornic/hugo-theme-learn/issues/14)