gitbook-plugin-docsearch

GitBook Plugin to add Algolia docSearch Plugin

Installation

npm install gitbook-plugin-docsearch

Usage

Gitbook comes with default search option. In order to use this plugin, need to disable the default search plugins and add docSearch as bellow :

"plugins": [
    "-search",
    "-lunr",
    "docsearch"
  ]

add the following plugin configurations in book.json

{
   "pluginsConfig": {
     "docSearch": {
       "apiKey" : "replace_with_algolia_doc_search_api_key",
       "index" : "replace_with_algolia_doc_search_index",
        "logo" : "logo.png",
        "brandUrl" : "https://uilicious.com/"
     }
   }
}

logo and brandUrl is optional. So you can choose to leave them empty if you do want want to put your brand logo in Gitbook.

But, if you want to use logo then put the logo image into the root directory of your Gitbook project.

In order to customize the styling of your search experience you can supply a css separately as bellow inside book.json

"addcssjs": {
   "css": [
        "css/replace_with_your_file_name.css"
        ]
    }

Known issues

The default behaviour of algolia search result prompt crops out. See bellow :

In order to fix it, apply the following css with styling

/* FIX for algolia search box getting cropped off */
/* FIX-START*/

.book.with-summary .book-summary {

    display: flex;
    flex-direction: column;
    height: 100vh;
    overflow-y: hidden;

    /* reset */
    position: relative;
    left: auto;
    top: auto;
    bottom: auto;
    z-index: auto;
    width: inherit;
    border: none;

}

.book-summary > a, /*logo*/
#book-search-input,
.book-summary > nav {
    width: 300px;
}

@media (max-width: 600px) {
    .book-summary > a, /*logo*/
    #book-search-input,
    .book-summary > nav {
        width: auto;
    }
}

.book.with-summary .book-body {
    border-left: 1px solid rgba(0, 0, 0, 0.07);
}

#book-search-input {
    margin-bottom: 0;
}

.book-summary > nav {
    overflow-y: auto;
}

/* FIX-END*/

License & copyright

Licensed under the MIT License