Section-aware results
Hits can deep-link to a heading, with breadcrumbs and a short snippet, not just the page title.
Open source · Docusaurus · MIT
Index Markdown and MDX at build time, ship a static JSON file, and search in the browser. No Algolia account, no crawler, no separate search server.
On this site, press ⌘ K or Ctrl K to open Docsense search.
How it works
No crawler approval queue and no sync job. Search is built and shipped with the rest of your site.
Add docusaurus-plugin-docsense to your Docusaurus config. The SearchBar lands in the navbar automatically.
// docusaurus.config.js plugins: ['docusaurus-plugin-docsense'],
Run your normal build. Docsense indexes your Markdown and MDX and ships the result as a static JSON file.
# your usual build npm run build
Readers open search with a shortcut and query the index locally. No account and no server to run.
Features
Search your own, with a UI that feels like a modern docs site.
Hits can deep-link to a heading, with breadcrumbs and a short snippet, not just the page title.
Chip filters for How-to, Concept, Reference and more, inferred from paths or frontmatter.
Default eight pages in the modal. Readers change the count with − / + (3 to 20).
Swap labels, shortcut and CSS variables so the SearchBar matches your docs theme.
Indexing stays in your build. Content does not go to a Docsense cloud crawler.
Open the JSON file, audit what is searchable, and pin the open-source packages you ship. Nothing about your search is a black box.
{
"title": "Install Docsense",
"headings": ["Install the plugin", "Verify"],
"text": "Add docusaurus-plugin-docsense…"
}Choosing a search tool
Full comparison with easyops, Orama and Pagefind: Compare open-source Docusaurus search.
Install the plugin, rebuild once, and try ⌘K on your own site.