Skip to main content
VelinStyle v0.9.0
⌂ Home
  1. Docs
  2. Guides
  3. API reference

API reference (generated) 0.9.0

Markdown reference generated from source — Web Components, tokens, utilities, CLI, and scanner rules stay in sync with the codebase.

Generate locally

npm run docs:generate
npx velinstyle docs generate
npx velinstyle docs generate --scope components
npx velinstyle docs generate --scope tokens

Scopes: all, components, tokens, utilities, cli, rules, a11y.

Output sections

SectionSource
Web Componentscomponents/velin-*.js
Design tokenssrc/tokens/*.css
Utilitiessrc/utilities/*.css
CLIcli/cli-manifest.json
Scanner rulescli/scanner-rules-data.js
A11y CSSsrc/a11y/*.css
HTML attributescore/attributes/
WCAG 2.2 AAA matrixdocs/generated/a11y/wcag22-aaa-matrix.md
HTML attributescore/attributes/
WCAG 2.2 AAA matrixdocs/generated/a11y/wcag22-aaa-matrix.md
HTML attributescore/attributes/
WCAG 2.2 AAA matrixdocs/generated/a11y/wcag22-aaa-matrix.md
HTML attributescore/attributes/
WCAG 2.2 AAA matrixdocs/generated/a11y/wcag22-aaa-matrix.md
HTML attributescore/attributes/
WCAG 2.2 AAA matrixdocs/generated/a11y/wcag22-aaa-matrix.md

Files are written to docs/generated/ in the framework repo and deployed on GitHub Pages.

CI

CI runs npm run docs:generate and fails if docs/generated/ is out of date. Commit snapshots after API changes.

Browse online

docs/generated on GitHub · GitHub Pages /generated/