Overview
MinimalDoc includes a client-side search that indexes all your documentation pages, FAQ items, and Knowledge Base articles.
Keyboard Shortcuts
| Shortcut | Action |
|---|---|
/ or Ctrl+K |
Open search |
Escape |
Close search |
Arrow keys |
Navigate results |
Enter |
Go to selected result |
Enabling Search
Search is enabled by default. To explicitly configure it:
enable_search: true
How It Works
During build, MinimalDoc generates a search-index.json file containing:
- Page titles and descriptions
- Section headings
- Content snippets
- Tags and metadata
The search runs entirely in the browser with no server required.
Search Weighting
Results are ranked by relevance:
- Title matches: Highest priority
- Description matches: Medium priority
- Tag matches: Medium priority
- Content matches: Lower priority
Tips for Better Search
- Use descriptive page titles
- Add
descriptionin frontmatter - Use relevant
tagsfor categorization - Structure content with clear headings