API-Referenz (generiert) 1.2.2 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- und Meta-Snapshots sind beta / foundation. Studio und die komplette Utility Engine bleiben planned.

Wann nutzen

Markdown-Snapshots nach API-Änderungen neu generieren.
@birdapi/velinstyle@1.3.0 pinnen; Intelligence-Embeds als beta behandeln.

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

Abschnitt	Quelle
Web Components	`components/velin-*.js`
Design Tokens	`src/tokens/*.css`
Utilities	`src/utilities/*.css`
CLI	`cli/cli-manifest.json`
Scanner-Regeln	`cli/scanner-rules-data.js`
A11y-CSS	`src/a11y/*.css`
HTML-Attribute	`core/attributes/`
WCAG-2.2-AAA-Supportmatrix	`docs/generated/a11y/wcag22-aaa-matrix.md` — Framework-Support-Tracking, keine App-Zertifizierung

Die Dateien werden im Framework-Repo nach docs/generated/ geschrieben und über GitHub Pages veröffentlicht.

CI

Die CI führt npm run docs:generate aus und schlägt fehl, wenn docs/generated/ nicht aktuell ist. Committen Sie Snapshots nach API-Änderungen.

Online ansehen

docs/generated auf GitHub · GitHub Pages /generated/