Skip to content

Setting up site search

DocsForge includes a powerful client-side search engine. It's enabled by default via the search plugin.

Configuration

Basic setup

Search is enabled by default:

plugins:
  - search

Search separator

Control how search terms are split into tokens:

plugins:
  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`\/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'

The default separator splits on:
- Whitespace and zero-width spaces
- Hyphens, underscores, commas, colons
- CamelCase boundaries (e.g., MyClass → My + Class)

Language

Configure search stemming for your language:

plugins:
  - search:
      lang: en

Supported languages include: en, de, es, fr, ja, pt, ru, zh.

Search features

Enable in theme.features:

Highlighting

Highlight matching terms in search results:

theme:
  features:
    - search.highlight

Suggestions

Show autocomplete suggestions as you type:

theme:
  features:
    - search.suggest

Allow users to share direct links to search results:

theme:
  features:
    - search.share

Complete search configuration

theme:
  features:
    - search.highlight
    - search.suggest
    - search.share

plugins:
  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`\/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
      lang: en

Search behavior

  • Instant: Results appear as you type, with no server round-trip
  • Fuzzy matching: Minor typos are tolerated
  • Stemming: Searching for "run" finds "running", "runs", etc.
  • Ranking: Results ordered by relevance (title matches rank higher)
  • Excerpts: Each result shows a snippet with context

Excluding content from search

Add search.exclude front matter to hide a page:

---
search:
  exclude: true
---

Or exclude specific sections with HTML comments:

<!--search exclude-->
This content will not be indexed.
<!--end search exclude-->

Next steps