1.0.0-alpha.2 • Published 4 years ago

@aldridged/docusaurus-theme-lunr v1.0.0-alpha.2

Weekly downloads
1
License
MIT
Repository
github
Last release
4 years ago

docusaurus-theme-lunr

Minimal Docusaurus v2 theme with SearchBar component which consumes Lunr search index data created via the docusaurus-plugin-lunr plugin.

Installation

Add aldridged/docusaurus-theme-lunr to your package:

npm i @aldridged/docusaurus-theme-lunr

Modify your docusaurus.config.js:

module.exports = {
  ...
+ themes: ['@aldridged/docusaurus-theme-lunr'],
  ...
}

Swizzling components

To override the components in this theme, run the swizzle script in your documentation repository:

$ npm run swizzle @aldridged/docusaurus-theme-c12e [component name]

All components included in this theme can be found here. These components replace the similarly named ones in the classic theme.