ALP Docs

Markdown-first project documentation for ALP, powered by Quartz 5.

Local development

npm install
npm run dev

Open http://localhost:8080. Changes under content/ are rebuilt automatically.

Production build

npm run build

The static site is written to public/. The configured production URL is https://digimap2000.github.io/ALP-Docs/.

GitHub Pages deployment

The workflow at .github/workflows/pages.yml deploys this app whenever main is updated. It installs dependencies, runs npm run build, uploads /public as the Pages artifact, and deploys it with GitHub's official Pages action.

Configure the repository once at:

Settings → Pages → Source → GitHub Actions

The repository uses main as its deployment branch.

Adding documentation

• Add areas below content/areas/.
• Add project documentation below its area directory.
• Copy a starting point from content/templates/; templates are excluded from the site.
• Use relative Markdown links so content remains portable.

The navigation is intentionally curated around areas and project documentation. Quartz's graph, backlinks, tags, reader mode, and recent-note surfaces are disabled.