pilotkid / vue-doc-generator

Example of how to generate documentation of your vue components with Vue Styleguidist automatically

This is a quick example of how to use vue-styleguidist and the vue-docgen-cli. As well as a bit on generating the documentation at runtime, without manual intervention. There is also a YouTube video covering how to do this here:

Examples

Example output: https://github.com/pilotkid/vue-doc-generator/blob/master/docs/src/components/HelloWorld.md

Auto Create Documentation (development environment only) on compile: https://github.com/pilotkid/vue-doc-generator/blob/master/vue.config.js

Sources

Official vue-styleguidist site: https://vue-styleguidist.github.io/

Official vue-styleguidist docs: https://vue-styleguidist.github.io/docs/GettingStarted.html

Official vue-docgen-cli docs: https://vue-styleguidist.github.io/docs/docgen-cli.html

Documenting guide: https://vue-styleguidist.github.io/docs/Documenting.html

Getting Started

1. Follow the documentation from vue-dtyleguidist and docgen for initial setup
2. Add the code below the AUTO GENERATE DOCS ON COMPILE to your vue.config.js file
3. Restart the server application
4. Enjoy auto generated docs

Basic guide on using this project on your own computer

Project setup

npm install

Compiles and hot-reloads for development

npm run serve

Compiles and minifies for production

npm run build

Lints and fixes files

npm run lint

Customize configuration

See Configuration Reference.