Skip to main content

What is Docsense?

Docsense is documentation search for Docusaurus.

It indexes your Markdown and MDX files when you build your site, then serves search from a static JSON file that ships with your docs. There is no Algolia account, no crawler, and no separate search server.

Docsense search UI with filters, page limit, and section results

Press ⌘K (macOS) or Ctrl+K (Windows/Linux) on this site to try it.

Who it is for​

Use Docsense if you want to:

  • Add search to a Docusaurus site without a hosted search product
  • Keep the search index in sync with every docs deploy
  • Search private or internal docs without sending content to a third-party crawler
  • Own and inspect the index file yourself

What you get​

FeatureWhat it does
Build-time indexScans your docs folders during docusaurus start / build
Search modalNavbar trigger plus keyboard shortcut
Section resultsHits point to headings, not only page titles
FiltersNarrow results by page type (How-to, Concept, Reference, and more)
Page limitDefault 8 pages. Readers change the count with − / +. The − control stops at 3 (it will not go lower). The + control stops at 20.
Typo toleranceFinds results even when a query has small spelling mistakes
Custom labels and CSSChange copy, shortcut, and colors to match your site

How it fits together​

  1. You add the docusaurus-plugin-docsense plugin.
  2. On each build, Docsense reads your docs and writes static/docsense/search-index.json.
  3. Readers open search in the browser. Queries run locally against that JSON file.

Next steps​