Skip to content

Development

From the blf-ts/ directory:

bash
npm install
npm run validate   # lint, test, typecheck, docs build
npm run build

Scripts

ScriptPurpose
npm run docs:genRegenerate version chunk list for the guide
npm run docsVitePress dev server
npm run docs:buildProduction docs site (runs docs:gen first)
npm run docs:previewPreview built docs
npm run releaseVersion bump and tag (npm publish on tag via CI)

Docs site

User guide: VitePress in docs/ (same layout as cstruct).

CI deploys the VitePress site to GitHub Pages on pushes to main.