Zum Hauptinhalt springen
VelinStyle v1.2.0
⌂ Home
  1. Docs
  2. Guides
  3. API-Referenz

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

Wann nicht

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

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-Attributecore/attributes/
WCAG 2.2 AAA support matrixdocs/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.

Online ansehen

docs/generated on GitHub · GitHub Pages /generated/