zudo-sg Docs

Type to search...

to open search from anywhere

0.1.0

Initial release of the @takazudo/zudo-sg styleguide engine.

Released: unreleased

Initial release of @takazudo/zudo-sg, the installable styleguide engine package. Finalized by /l-make-release when the first version actually ships.

Features

  • Package-owned catalog routes — /components, /components/[slug], /components/preview, /tokens — injected into a host's zfb build via @takazudo/zudo-sg/plugins/routes, mirroring @takazudo/zudo-doc's route-injection seam.

  • zudo-sg CLI: gen-registry [--check], new-component <name> --category <c> [--nested] [--skip-barrel], gen-token-manifest [--check], all driven by a host zudo-sg.config.mjs.

  • Story-authoring contract (@takazudo/zudo-sg/stories): StoryMeta, Story, StoryControl, StoryModule, defineStory. Story categories are open, host-ordered data, not a closed type.

  • Standalone preview stylesheet compiler (@takazudo/zudo-sg/plugins/preview-css) that compiles the host's token CSS with @tailwindcss/node and rescopes it under :root[data-sg-preview-doc] so it coexists with the host's own global stylesheet.

  • Generated safelist and chrome styles (@takazudo/zudo-sg/safelist.css, @takazudo/zudo-sg/styles.css) so package-owned catalog UI ships its own Tailwind utilities without depending on the host's content scan.

  • Token dashboards and the preview design-token panel, driven by a gen-token-manifest-produced manifest.

  • Framework scope: Preact/zfb hosts only for this release.