Skip to main content

FAQ

Does Docsense require an Algolia account?​

No. Docsense indexes your docs at build time and searches in the browser against a static JSON file. There is no Docsense cloud account and no crawler approval step.

Where is the search index stored?​

By default the plugin writes:

static/docsense/search-index.json

That file deploys with your site. You can change the path with the plugin indexPath option. See Indexing.

Why does the Pages − control stop at 3?​

The SearchBar clamps the visible page count between 3 and 20. At 3, the − button is disabled. At 20, the + button is disabled. The default starting value is 8. See Use filters and page limits.

Can readers filter by page type?​

Yes. When results include more than one page type, the modal shows chips such as How-to, Concept, and Reference. Types come from folder paths or from pageType in frontmatter.

Does search work for private or internal docs?​

Yes, as long as readers can load your static site (and the index file). Docsense does not send document content to a Docsense server for indexing or querying.

Does Docsense index MDX?​

Yes. The indexer reads Markdown and MDX, including many string attributes such as title and description. Put critical terms in headings or prose when possible. See MDX extraction and stemming.

Will a typo still find the right page?​

Often yes. Docsense uses exact, prefix, and fuzzy matching, plus English stemming. Short tokens allow fewer edits than longer tokens. See Ranking and typos.

How do I change the SearchBar label or colors?​

Why does Docsense exist if Algolia and other search options already exist?​

Hosted and existing local options leave gaps around deploy freshness, private-docs data boundaries, and docs-native SearchBar UX. See Why Docsense.

How does Docsense compare with easyops, Orama, Pagefind, and Algolia?​

See Compare open-source Docusaurus search.

Is Ask AI included?​

Not in the current release. Optional Ask AI integration is on the feature roadmap.

Next steps​