Skip to content

This repo is a Docusaurus theme for search bar. It is custome made

Notifications You must be signed in to change notification settings

jacobkim9881/docusaurus-custom-search

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 

Repository files navigation

Docusaurus custom search

docusaurus search bar

This component is custom search bar for docusaurus. This search keywords by parsing values at search bar and making search with lunr js in each document's .md or .mdx files.

Node modules to be prepared

sudo npm install lunr classnames

How to use it

First, docusaurus app should be installed. The docusaurus repo is here.

Docusaurus website should be installed like,

npx @docusaurus/init@latest init [name] [template]

Because blog .md or .mdx files have date format to be parsed as paths which can be written in [docusaurus website dir]/.docusaurus/client-manifest.json. This json file is made by command above.

Second, this SearchBar dir goes into [docusaurus website dir]/src/theme. This repo will be uses as a component on docusaurus website. Example docusaurus website is here.

Third, install required node modules like,

sudo npm install lunr classnames

Last, install docusaurus website by commanding,

sudo npm run build

About

This repo is a Docusaurus theme for search bar. It is custome made

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published