Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/novalagung/gitbook-plugin-docsearch-v3
DocSearch v3 plugin for HonKit / GitBook legacy
https://github.com/novalagung/gitbook-plugin-docsearch-v3
algolia docsearch gitbook honkit search
Last synced: about 1 month ago
JSON representation
DocSearch v3 plugin for HonKit / GitBook legacy
- Host: GitHub
- URL: https://github.com/novalagung/gitbook-plugin-docsearch-v3
- Owner: novalagung
- License: mit
- Created: 2023-06-04T12:29:33.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-06-05T09:57:33.000Z (over 1 year ago)
- Last Synced: 2024-10-29T21:05:25.723Z (about 2 months ago)
- Topics: algolia, docsearch, gitbook, honkit, search
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/gitbook-plugin-docsearch-v3
- Size: 13.7 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Algolia DocSearch v3 plugin for HonKit / GitBook legacy
## Installation
### Using HonKit
```bash
npm install gitbook-plugin-docsearch-v3 --save-dev
```
### Using GitBook Legacy
Follow the steps under **Usage** section first, then run the following command:
```bash
gitbook install
```
## Usage
Apply on https://docsearch.algolia.com/ to get free Algolia DocSearch credentials. Next, on `book.json` do the following steps:
- Disable the `search` and `lunr` plugins (by adding `-` prefix on the plugin name).
- Add the `docsearch-v3` plugin.
- Specify your DocSearch credentials under `pluginsConfig.docsearch`.
```js
{
"plugins": [
"-search",
"-lunr",
"docsearch-v3"
],
"pluginsConfig": {
"docsearch": {
"appId": "",
"apiKey": "",
"indexName": ""
}
}
}
```
## License
[MIT License](LICENSE)
## Author
[Noval Agung Prayogo](mailto:[email protected])