search

generoi / genero-design-system

https://gds.generogrowth.com/
MIT License
4 stars 0 forks source link

docs(storybook): auto generate controls #59

Closed silentnoodlemaster closed 3 years ago

silentnoodlemaster commented 3 years ago

during stencil build a schema file is generated that will tell storybook about the components

Slots, CSS variables and CSS parts needs to be annotated with jsdoc comments to b picked up by the generator so we should reflect that in the readme

there is probably room for refactoring in this code

oxyc commented 3 years ago

Cool, could you add this to the gh-pages branch so we can preview? :D

https://github.com/generoi/genero-design-system#build-storybook

  1. basically you build the storybook locally
  2. clone the gh-pages branch
  3. move the build files into the docs/auto-controls
  4. add auto-controls as a version to docs/storybook-config.json
  5. deploy and it'll be available in the version list on the gh-pages site
oxyc commented 3 years ago

Should really add a github action to build them on branches