From daf20dd652f9294273c1110f60ff4da6d99f67c5 Mon Sep 17 00:00:00 2001 From: Charlie Root Date: Tue, 26 May 2020 22:45:15 +0000 Subject: Commit preview bundle --- plugins/localsearch/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 plugins/localsearch/README.md (limited to 'plugins/localsearch/README.md') 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 @@ +If you don't want to depend on Google or DuckDuckGo to implement search for you, +or just want it to work even if you are offline, enable this plugin and the +search will be performed client side. It uses [Tipue Search](http://www.tipue.com/search/) as its engine. + +In ordrer to set up Tipue, you will need: + + * the sample config from `conf.py.sample` and a page set up to render `localsearch.tmpl` (which you may customize) — + an example is in `search-EXAMPLE.html` + * or the alternate sample config from `conf.py.sample.alt`, which uses a modal + and does not need another page + +For more information about how to customize it and use it, please refer to the Tipue +docs at http://www.tipue.com/search/ + +Tipue is under an MIT license (see MIT-LICENSE.txt) -- cgit v1.2.3