Getting Started

Welcome to the docs. This site is built with Nx, Angular, AnalogJS, and Tailwind CSS v4, and it is deployed as a fully static site to GitHub Pages.

Everything you are reading is a Markdown file. Drop a new .md file into docs/src/content/docs, give it some frontmatter, and it automatically becomes a page, shows up in the sidebar, and gets prerendered at build time — with zero code changes.

Prerequisites

You will need a recent LTS release of Node.js and npm:

• Node.js 20 or newer
• npm 10 or newer

Tip: Run node --version to confirm your toolchain before you start. If you use nvm, an .nvmrc makes switching painless.

Run it locally

Install dependencies and start the dev server:

npm install
npx nx serve docs

The site is served at http://localhost:4200. Edits to Markdown and components hot-reload instantly.

How a page is resolved

When you visit /docs/guides/routing, the catch-all route reads the slug param and asks AnalogJS for the matching content file:

import { injectContent } from '@analogjs/content';

// Resolves /src/content/docs/guides/routing.md, reactively.
readonly doc = toSignal(
  injectContent({ param: 'slug', subdirectory: 'docs' }),
);

What to read next

• Installation — a deeper look at the toolchain and versions.
• Routing — how Markdown files map to URLs.
• Deployment — shipping to GitHub Pages.
• API Overview — the content helpers you will use most.

Task	Command
Start dev server	npx nx serve docs
Production build	npx nx build docs
Run tests	npx nx test docs
Lint	npx nx lint docs