Skip to content

Latest commit

 

History

History

README.md

Federated Directory Documentation

This is the source code for the Federated Directory documentation site.

Development

Prerequisites:

  • Node.js (v20 or higher)
  • npm

Install dependencies:

npm install

Start local development server:

npm run docs:dev

Browse to http://localhost:5173

Build for production:

npm run docs:build

Preview production build:

npm run docs:preview

Architecture

This site is built with VitePress and integrates Scalar for interactive API documentation.

  • docs/: Markdown source files
  • docs/.vitepress/: VitePress configuration and theme customization
  • scripts/: Build-time scripts (e.g., Swagger sanitization)