ngxdocs
Documentation

Search

Configure local, zero-network search or Algolia DocSearch.

On this page

Local search indexes the pages exposed by the active ngxdocs source and filters them to the visible metadata tree. It needs no service, API key, or network request.

search: {
  type: "local",
  placeholder: "Search documentation…",
  maxResults: 8,
}

Readers can open the search dialog from the header or with Command K on macOS and Control K elsewhere. Arrow keys move through results and Enter opens the selected page.

Algolia DocSearch

For a hosted index, configure the Algolia application, search key, and index name.

search: {
  type: "algolia",
  appId: "APP_ID",
  apiKey: "SEARCH_ONLY_KEY",
  indexName: "docs",
}

Use a search-only key in browser configuration. Index administration keys belong only in your indexing job.

Last updated on