Markdown

ngxdocs uses Analog's content pipeline to load Markdown and AGX files. Standard Markdown remains the default authoring format.

Frontmatter

Every page should declare a title and concise description.

---
title: Configure search
description: Add local or hosted search to an ngxdocs site.
lastUpdated: "2026-08-09"
---

The title and description feed the page header, metadata, and search index. Projects can extend or validate frontmatter through provideNgxDocs.

Headings and table of contents

Second- and third-level headings become the page table of contents. Keep heading text unique so generated anchor IDs remain predictable.

Code blocks

Use fenced code blocks with a language identifier. ngxdocs enhances rendered blocks with syntax metadata and copy controls without requiring a client-only Markdown renderer.

Angular-rich content

Use AGX or the MDX package when a guide needs interactive Angular components. Keep ordinary prose in Markdown so static rendering, search extraction, and AI exports remain straightforward.