VelinStyle API reference (generated) 1.2.2 stable
Markdown reference generated from source — Web Components, tokens, utilities, CLI, and scanner rules stay in sync with the codebase. Deutsch
Maturity: Docs generate for CSS / WC / runtime is stable in 1.2.0. Intelligence / meta snapshots are beta / foundation. Studio and the complete Utility Engine stay planned.
When to use
- Regenerate Markdown snapshots after API changes.
- Pin
@birdapi/velinstyle@1.3.0; treat intelligence embeds as beta.
When not
- Do not treat beta plan/review/meta as a finished AI design system.
- Do not invent Studio or Utility Engine APIs that are still planned.
Generate locally
npm run docs:generate
npx velinstyle docs generate
npx velinstyle docs generate --scope components
npx velinstyle docs generate --scope tokensScopes: all, components, tokens, utilities, cli, rules, a11y.
Output sections
| Section | Source |
|---|---|
| Web Components | components/velin-*.js |
| Design tokens | src/tokens/*.css |
| Utilities | src/utilities/*.css |
| CLI | cli/cli-manifest.json |
| Scanner rules | cli/scanner-rules-data.js |
| A11y CSS | src/a11y/*.css |
| HTML attributes | core/attributes/ |
| WCAG 2.2 AAA matrix | docs/generated/a11y/wcag22-aaa-matrix.md |
| HTML attributes | core/attributes/ |
| WCAG 2.2 AAA matrix | docs/generated/a11y/wcag22-aaa-matrix.md |
| HTML attributes | core/attributes/ |
| WCAG 2.2 AAA matrix | docs/generated/a11y/wcag22-aaa-matrix.md |
| HTML attributes | core/attributes/ |
| WCAG 2.2 AAA matrix | docs/generated/a11y/wcag22-aaa-matrix.md |
| HTML attributes | core/attributes/ |
| WCAG 2.2 AAA matrix | docs/generated/a11y/wcag22-aaa-matrix.md |
| HTML attributes | core/attributes/ |
| WCAG 2.2 AAA matrix | docs/generated/a11y/wcag22-aaa-matrix.md |
| HTML attributes | core/attributes/ |
| WCAG 2.2 AAA matrix | docs/generated/a11y/wcag22-aaa-matrix.md |
| HTML attributes | core/attributes/ |
| WCAG 2.2 AAA matrix | docs/generated/a11y/wcag22-aaa-matrix.md |
| HTML attributes | core/attributes/ |
| WCAG 2.2 AAA matrix | docs/generated/a11y/wcag22-aaa-matrix.md |
| HTML attributes | core/attributes/ |
| WCAG 2.2 AAA matrix | docs/generated/a11y/wcag22-aaa-matrix.md |
| HTML attributes | core/attributes/ |
| WCAG 2.2 AAA matrix | docs/generated/a11y/wcag22-aaa-matrix.md |
| HTML attributes | core/attributes/ |
| WCAG 2.2 AAA matrix | docs/generated/a11y/wcag22-aaa-matrix.md |
| HTML attributes | core/attributes/ |
| WCAG 2.2 AAA matrix | docs/generated/a11y/wcag22-aaa-matrix.md |
| HTML attributes | core/attributes/ |
| WCAG 2.2 AAA matrix | docs/generated/a11y/wcag22-aaa-matrix.md |
| HTML attributes | core/attributes/ |
| WCAG 2.2 AAA matrix | docs/generated/a11y/wcag22-aaa-matrix.md |
| HTML attributes | core/attributes/ |
| WCAG 2.2 AAA matrix | docs/generated/a11y/wcag22-aaa-matrix.md |
| HTML attributes | core/attributes/ |
| WCAG 2.2 AAA matrix | docs/generated/a11y/wcag22-aaa-matrix.md |
| HTML attributes | core/attributes/ |
| WCAG 2.2 AAA matrix | docs/generated/a11y/wcag22-aaa-matrix.md |
| HTML attributes | core/attributes/ |
| WCAG 2.2 AAA matrix | docs/generated/a11y/wcag22-aaa-matrix.md |
| HTML attributes | core/attributes/ |
| WCAG 2.2 AAA support matrix | docs/generated/a11y/wcag22-aaa-matrix.md — framework support tracking, not app certification |
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.