diff options
Diffstat (limited to 'plugins/localsearch/README.md')
-rw-r--r-- | plugins/localsearch/README.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/plugins/localsearch/README.md b/plugins/localsearch/README.md new file mode 100644 index 00000000..f7321da6 --- /dev/null +++ b/plugins/localsearch/README.md | |||
@@ -0,0 +1,15 @@ | |||
1 | If you don't want to depend on Google or DuckDuckGo to implement search for you, | ||
2 | or just want it to work even if you are offline, enable this plugin and the | ||
3 | search will be performed client side. It uses [Tipue Search](http://www.tipue.com/search/) as its engine. | ||
4 | |||
5 | In ordrer to set up Tipue, you will need: | ||
6 | |||
7 | * the sample config from `conf.py.sample` and a page set up to render `localsearch.tmpl` (which you may customize) — | ||
8 | an example is in `search-EXAMPLE.html` | ||
9 | * or the alternate sample config from `conf.py.sample.alt`, which uses a modal | ||
10 | and does not need another page | ||
11 | |||
12 | For more information about how to customize it and use it, please refer to the Tipue | ||
13 | docs at http://www.tipue.com/search/ | ||
14 | |||
15 | Tipue is under an MIT license (see MIT-LICENSE.txt) | ||