youngtailors / vuepress-plugin-component-docgen

Vuepress plugin for creating a documentation site of your Vue component

vuepress-plugin-component-docgen

Vuepress plugin for creating a documentation site of your Vue component

Install from NPM

npm install --save-dev vuepress-plugin-component-docgen

Install from Yarn

yarn add vuepress-plugin-component-docgen

Config for your site

Update your .vuepress/config.js

module.exports = {
    ...
    plugins: [
      [
        'component-docgen',
        {
          rootDir: <string>,
          include: <string | string[]>,
          exclude: <string | string[]>,
          prefix: <string>,
        }
      ]
    ]
}

See Who Is Using component-docgen

• vue-kawaii
• vue-w3css

Contributors

• Evan N
• F3ltron

License

MIT © dacsang97