-
-
Notifications
You must be signed in to change notification settings - Fork 2
Open
Description
With #62 we built registry at `apps/registry/public/r/@geist/ (.json) aligning shadcn schema
- study shadcn
- shadcn use mdx to build the docs - example
Goal
- we want to auto gen docs as much as possible.
- the registry item in
.jsonalready pick up jsdoc (title, description of the component) - a script generating onto
content/under docs, our build process will pick up and show on sidebar
- the registry item in
- the doc for component should show
- sample command line (with geist registry path)
- dependencies
- we should integrate storybook
- for the actual working example
- low hangingfruit is to embed our hosted storybook (only for deployed components) https://storybook.js.org/docs/sharing/embed
- we can have the flexibility that if we want customized docs for particular component, we add on storybook (.mdx) and embed
- future potential way is embed the storybook "runtime" onto astro
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels