kubernetes-handbook/gitbook-plugin-search-plus/README.md

1.7 KiB

gitbook-search-plus

A powerful search plugin for GitBook.

Features

* Search any character
* Search across element (for search code)
* Remember search url

Use this plugin

Before use this plugin, you should disable the default search plugin first, Here is a book.json configuration example:

{
    plugins: ["-lunr", "-search", "search-plus"]
}

Note: Only gitbook >= 3.0.0 support

Examples

Open https://lwdgit.github.io/gitbook-plugin-search-plus/ or test it by yourself

    > git clone git@github.com:lwdgit/gitbook-plugin-search-plus.git -b gh-pages
    > cd gitbook-plugin-search-plus
    > npm install
    > npm start

And then open http://127.0.0.1:4000

Thanks To: