What is ngxdocs

ngxdocs turns Markdown and Angular components into a searchable, server-rendered documentation site. It follows the composable package model familiar from Fumadocs, but its runtime is Angular: standalone components, dependency injection, signals, Angular Router, and Analog file routes.

How it is organized

ngxdocs-core owns framework-independent contracts such as configuration, page trees, frontmatter, sources, and locale-aware links.

@ngxdocs/content adapts Analog content files into the ngxdocs source API.

ngxdocs-ui provides accessible documentation layouts and components. Its interactive primitives are Angular components and use Spartan UI where a headless primitive is needed.

ngxdocs-search, ngxdocs-mdx, and the API packages add focused capabilities without making the core package depend on them.

Rendering flow

1. Analog discovers the Markdown files in the content directory.
2. The content adapter normalizes frontmatter and creates a docs source.
3. meta.json files produce the ordered page tree.
4. Angular routes load the current document and render it in the selected layout.
5. Search, the table of contents, previous/next links, and AI exports read from the same source.

This keeps navigation and content synchronized while allowing an application to replace any part of the UI.