Skip to content

README_DOCS.md

Latest commit

 

History

History
51 lines (35 loc) · 1.3 KB

README_DOCS.md

File metadata and controls

51 lines (35 loc) · 1.3 KB

Documentation Setup

This project uses VitePress for documentation with TypeScript and pnpm. Node tooling lives under docs/ (see docs/package.json).

Development

cd docs

# Install dependencies
pnpm install

# Start dev server
pnpm run docs:dev

# Build for production
pnpm run docs:build

# Preview production build
pnpm run docs:preview

GitHub Pages

The documentation is automatically deployed to GitHub Pages when changes are pushed to the master branch.

The workflow is configured in .github/workflows/docs.yml.

Documentation Structure

  • docs/ - Documentation source files and Node manifest (package.json, pnpm-lock.yaml, tsconfig.json)
  • docs/.vitepress/ - VitePress configuration
  • docs/.vitepress/config.ts - VitePress config file (TypeScript)
  • docs/tsconfig.json - TypeScript configuration for VitePress

Local Development

  1. Install Node.js 18+ and pnpm 
    # Install pnpm globally if not already installed
npm install -g pnpm
  2. cd docs and run pnpm install
  3. Run pnpm run docs:dev to start the dev server
  4. Open http://localhost:5173 in your browser

Tech Stack

  • VitePress - Static site generator
  • TypeScript - Type-safe configuration
  • pnpm - Fast, disk space efficient package manager