UseJDL Docs

Appearance

Getting Started ​

This repository uses VitePress to manage Markdown documentation with a minimal toolchain.

Prerequisites ​

  • Node.js 20 or newer
  • pnpm

Install ​

bash
pnpm install

Run Locally ​

bash
pnpm docs:dev

VitePress starts a local development server and reloads when you update files in docs/.

Build ​

bash
pnpm docs:build

The static site output is generated at docs/.vitepress/dist.

Preview The Build ​

bash
pnpm docs:preview

Use preview before deployment if you want to verify navigation, links, and page rendering from the production build.

Where To Edit ​

  • Add external-facing pages under docs/public/
  • Add team-only pages under docs/internal/
  • Update navigation and sidebar in docs/.vitepress/config.ts

Maintenance Notes ​

  • Keep each page focused on one job
  • Prefer short sections and direct instructions
  • Move content to internal if it contains sensitive implementation detail