vue-example-docgen-vite v0.0.0

vue-example-docgen-vite

This template should help get you started developing with docgen and VitePress.

It contains an example of a light integration with vue-live in docs/.vitepress/theme. Using a markdown-it plugin, we will render each example with the suffix live into a vue-live component.

It also uses vue-component-meta instead of vue-docgen-api to parse vue components for props and events. The integration is done here: docgen.config.js

Run both vitepress & docgen at the same time

yarn styleguide

chain the steps

yarn styleguide:build

Project Setup

yarn

Compile and Hot-Reload for Development

yarn dev

Type-Check, Compile and Minify for Production

yarn build

Generate the documentation pages for each component

yarn vue-docgen

Open vitepress in the browser

yarn vitepress open