search

README

search

This plugin is a default plugin for GitBook, it adds an interactive search bar to your book.

This plugin is backend agnostic.

Disable this plugin

This is a default plugin and it can be disabled using a book.json configuration:

{
    plugins: ["-search"]
}

Backends

Backend Plugin Name Description
Lunr lunr Index the content into a local/offlien index
Algolia algolia Index the content in Algolia

Plugin

Search input for your GitBook

https://github.com/GitbookIO/plugin-search


Latest: 2.2.1

1.0.0, 1.0.1, 1.0.2, 1.1.0, 1.2.0, 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 4.0.0-alpha.1, 4.0.0-alpha.2, 4.0.0-alpha.3, 4.0.0-alpha.4, 4.0.0-alpha.5, 4.0.0-alpha.6,

Requirements

GitBook
1.0.2 >=2.4.0
1.1.0 >=2.5.0
2.2.1 >=3.0.0-pre.0
4.0.0-alpha.6 >=3.0.0

Maintainers

Open on NPM