API-Referenz (generiert) 1.2.0 stable
Markdown-Referenz aus den Quellen generiert ? Web Components, Tokens, Utilities, CLI und Scanner-Regeln bleiben mit der Codebasis synchron. English: API reference
Reifegrad: Die Doku-Generierung f?r CSS / WC / Runtime ist in 1.2.0 stable. Intelligence-/Meta-Snapshots sind beta / foundation. Studio und die komplette Utility Engine bleiben planned.
Wann nutzen
- Regenerate Markdown snapshots after API changes.
- Pin
@birdapi/velinstyle@1.2.0; treat intelligence embeds as beta.
Wann nicht
- Beta-Plan/Review/Meta nicht als fertiges KI-Design-System behandeln.
- Keine noch geplanten Studio- oder Utility-Engine-APIs erfinden.
Lokal generieren
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.
Ausgabeabschnitte
| 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-Attribute | 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.