NgMd
Star on GitHub

The Angular docs starter you've been missing

Drop a markdown file. Get a route. Beautifully branded out of the box, powered by AnalogJS, Angular, Vite, Tailwind, and Shiki.

Zero config to ship a page

Markdown in, route out. No descriptors, no boilerplate, no proprietary syntax.

src/content/welcome.mdmarkdown
# Welcome

NgMd is a modern Angular docs starter.

## Quick start

- Drop a .md file
- Get a route
- Done.
Browser → /welcomelive

Welcome

NgMd is a modern Angular docs starter.

Quick start

  • Drop a .md file
  • Get a route
  • Done.

Everything you need

Batteries-included docs without the bloat.

Markdown routes

Drop a .md file in src/content, get a route. Powered by AnalogJS content collections.

Branding-first

Tailwind tokens and CSS variables make a complete rebrand a one-file change.

Shiki highlighting

Beautiful syntax highlighting for code blocks. Same engine as VS Code.

Own your components

shadcn-style ownership. Authoring components live in your repo, theme freely.

Cmd+K search

Local Orama index out of the box with optional Algolia swap-in. Fuzzy, ranked, with recents and favourites. Press ⌘K (or Ctrl+K on Windows / Linux) to try it.

AnalogJS-native

File-based routing, SSR/SSG, Vite dev server. The fast Angular stack.

Multi-version docs

Header version switcher in the adev / PrimeNG model. Each version is its own deployment, the switcher is a flat registry of external sibling URLs, and a status banner nudges visitors stuck on a next / rc / deprecated build toward the current stable.

API reference auto-gen

Drop an `ngmd.api.ts` scope file at the repo root. The api-gen plugin walks your TypeScript through ts-morph, emits a virtual symbol index, and serves it at `/api`. Cmd+K palette searches symbols alongside content pages.

Ready to ship docs?

One command, a few markdown files, and you've got a beautiful docs site.

$npm create ngmd@latest my-docs