Vypher Docs

This directory contains the source for the Vypher documentation site, built with VitePress and deployed to docs.vypher.io.

Structure

docs/
├── .vitepress/
│   └── config.mts        # VitePress site config
├── cli/
│   ├── vypher.md         # Auto-generated: vypher root command reference
│   └── vypher_scan.md    # Auto-generated: vypher scan command reference
├── installation.md       # Installation guide
└── index.md              # Home page

Note: Files in cli/ are auto-generated by tools/docgen. Do not edit them directly; run the generator instead:

cd ../cli
go run ./tools/docgen ../docs

Local Development

npm install
npm run docs:dev

The site will be available at http://localhost:5173.

Build

npm run docs:build

Output is written to .vitepress/dist/.

Preview Production Build

npm run docs:preview