Skip to main content

Open source · Docusaurus · MIT

Documentation search that builds with your site.

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.

instal plugn
Typo tolerantesc
  • Install the plugin
    HOW-TO
    Docs > Getting started > Install
    Add docusaurus-plugin-docsense and rebuild once.
  • How indexing works
    CONCEPT
    Docs > Concepts > Indexing
    Markdown and MDX become a static JSON file at build time.
  • Plugin options
    REFERENCE
    Docs > Reference > Configuration
    placeholder, triggerLabel, shortcut, resultLimit…
  • Style the search UI
    HOW-TO
    Docs > How-to > Style search
    Theme the modal with --docsense-accent and friends.
  • Ranking and typos
    CONCEPT
    Docs > Concepts > Ranking
    Fuzzy matching catches instal plugn without a cloud API.
↑↓ navigate ↵ open
8 pages
Build-time indexFresh on every deploy
Local queriesRuns in the browser
Default 8 pagesFilters and a − / + limit
Typo tolerantFuzzy matching built in

How it works

Three steps, and nothing to babysit.

No crawler approval queue and no sync job. Search is built and shipped with the rest of your site.

  1. 1

    Install the plugin

    Add docusaurus-plugin-docsense to your Docusaurus config. The SearchBar lands in the navbar automatically.

    // docusaurus.config.js
    plugins: ['docusaurus-plugin-docsense'],
  2. 2

    Build your docs

    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
  3. 3

    Search in the browser

    Readers open search with a shortcut and query the index locally. No account and no server to run.

    ⌘KorCtrlK

Features

Built for documentation sites.

Search your own, with a UI that feels like a modern docs site.

Section-aware results

Hits can deep-link to a heading, with breadcrumbs and a short snippet, not just the page title.

Verify signaturesDocs > Guides > Webhooks > #verify-signaturesConfirm HMAC headers before you trust the payload.

Page-type filters

Chip filters for How-to, Concept, Reference and more, inferred from paths or frontmatter.

How-toConceptReference+ more

Adjustable page limit

Default eight pages in the modal. Readers change the count with − / + (3 to 20).

−8+
pages, 3 to 20

Your branding

Swap labels, shortcut and CSS variables so the SearchBar matches your docs theme.

Private-docs friendly

Indexing stays in your build. Content does not go to a Docsense cloud crawler.

Your build ✓Cloud crawler ✕

Inspectable index

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

When to use Docsense.

Choose Docsense

Fits when
  • You want search inside your Docusaurus build
  • Index freshness must match every deploy
  • You prefer a static JSON file you own
  • Private or internal docs should not leave your boundary for indexing

Choose hosted search

  • You need a managed cloud search platform
  • You already run Algolia or similar at scale
  • You want Ask AI or chat answers from the same vendor
  • You need multi-product search beyond docs Markdown

Full comparison with easyops, Orama and Pagefind: Compare open-source Docusaurus search.

Start with a working SearchBar.

Install the plugin, rebuild once, and try ⌘K on your own site.