declared-md docs

the documentation site for declared-md. built with Docusaurus 3, deployed to GitHub Pages.

---

running locally

cd docs/
npm install
npm start       # starts dev server at localhost:3000

---

building

npm run build   # produces build/
npm run serve   # preview the production build locally

search (local index) works in both dev and production builds.

---

adding content

1. new page: add a .md or .mdx file in docs/docs/<section>/. update sidebars.ts to include it.

2. new section: create a folder in docs/docs/, add a _category_.json, and update sidebars.ts.

3. updating a spec mirror: the files in docs/docs/spec/ are mirrors of declared-md/spec. when the spec changes, update the mirror manually. the banner at the top of each mirror file notes that spec/ is the normative source.

---

design system

the site uses CSS variables mapped from DESIGN.md. all token overrides are in src/css/custom.css. fonts are loaded via @fontsource in src/css/fonts.css.

reference: ../DESIGN.md

---

deploy workflow

the site deploys automatically via GitHub Actions on push to main. the workflow is in .github/workflows/deploy.yml.

to deploy to GitHub Pages, enable Pages in the repo settings with source set to "GitHub Actions".

---