Documentation Generation
Last modified by Manuel Leduc on 2023/10/24 15:22
Libraries to consider
- https://vue-styleguidist.github.io/
- https://storybook.js.org/
- Docz (only for react)
- Vuese https://github.com/vuese/vuese Does not support vue 3
- VuePress https://vuepress.vuejs.org/
Criteria
- possibility to document properties and event
- possibility to display interactive use cases as examples of the components
- live modification of the proposed configuration
- support for scopes styles
- possibility to define the documentation using a broad standard (i.e., jsdoc), to avoid having to re-write all the documentation in another framework if we ever need to switch
- support for Web Components documentation
Results
The only library supporting a modular architecture to support different kinds of components is Storybook.
In addition, extensions are officially supported for Vue 3 and Web Components