ngxdocs
Documentation

Page Conventions

Organize Markdown pages and navigation with meta.json.

On this page

Every Markdown or AGX file in src/content can be loaded by the docs route. A meta.json file controls which pages are visible, their order, and how folders appear in the sidebar.

Root metadata

Mark a metadata file as a documentation root to make it available in the section switcher.

{
  "root": true,
  "title": "Framework",
  "description": "Get started with ngxdocs",
  "icon": "lucideBookOpen",
  "order": 0,
  "pages": [
    "---Introduction---",
    { "page": "quick-start", "slug": "", "icon": "lucideRocket" },
    "what-is-ngxdocs",
    "guides"
  ]
}

Folder metadata

Place another meta.json inside a folder to create a collapsible group.

{
  "title": "Guides",
  "icon": "lucideBookOpen",
  "defaultOpen": true,
  "pages": ["authoring", "deployment"]
}

Page entries

A string refers to a file or folder relative to the metadata file. Object entries can override the title, description, icon, or public slug. Strings wrapped in three dashes create section labels, and entries prefixed with ! stay out of navigation.

The same page tree drives the sidebar, search quick links, and previous/next navigation, so changing meta.json updates all three.

Last updated on