Quick Start

ngxdocs is a documentation framework built for Angular. Analog provides the file-based routing, server rendering, and Vite toolchain; ngxdocs provides the content source, navigation, search, layouts, and authoring components.

Create a project

Start a new documentation app with the project generator:

pnpm create ngxdocs-app@latest
cd my-docs
pnpm install
pnpm dev

Your documentation lives in src/content. Every Markdown file becomes a docs page, while meta.json controls the order and shape of the sidebar.

src/content/
├── meta.json
├── quick-start.md
└── guides/
    ├── meta.json
    └── first-guide.md

Add your first page

Create src/content/guides/first-guide.md:

---
title: First guide
description: A short description used by search and page metadata.
---

## Start here

Write regular Markdown. ngxdocs renders it inside the Angular docs layout.

Then add first-guide to src/content/guides/meta.json. The page appears in the sidebar without changing an Angular component.

Next steps

• Read What is ngxdocs for the package architecture.
• Use Manual Installation when adding ngxdocs to an existing Analog app.
• Open Page Conventions to learn the meta.json format.