Open romgrk opened 3 years ago
The setup for the documentation is done :D
Everything is hosted on github pages, under https://romgrk.github.io/web-toolkit/demo/ and https://romgrk.github.io/web-toolkit/docs/. The docs app is under /packages/web-toolkit-docs
and the demo under /packages/web-toolkit
. Running npm run deploy
in /packages/web-toolkit
builds both the demo and the docs and sends them to github pages.
The documentation setup is very much WIP but I'm quite happy with how it works. The script parsePropTypes.js
reads all components under /packages/web-toolkit/src/lib/components/
and generates a properties.json
file based on the propTypes
, defaultProps
and JSDoc comments found directly in the code.
If anyone is interested in helping, one thing to do here is to go through each component file and make sure that:
propTypes
with all used propertiesThe documentation still needs to be completed to show how to use all the components. For now we only show the auto-generated props table and maybe the component if it doesn't crash by rendering it as <Component />
.
Things to think about: