https://github.com/youngtailors/vuepress-plugin-component-docgen

Vuepress plugin for creating a documentation site of your Vue component
https://github.com/youngtailors/vuepress-plugin-component-docgen

Last synced: 3 months ago
JSON representation

Vuepress plugin for creating a documentation site of your Vue component

• Host: GitHub
• URL: https://github.com/youngtailors/vuepress-plugin-component-docgen
• Owner: youngtailors
• License: mit
• Created: 2018-12-27T12:19:26.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-03-09T00:47:00.000Z (over 5 years ago)
• Last Synced: 2024-01-18T09:22:22.402Z (5 months ago)
• Language: TypeScript
• Homepage: https://vuepress-docgen.now.sh/
• Size: 839 KB
• Stars: 15
• Watchers: 3
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-vuepress - vuepress-plugin-component-docgen - Generate documentation for Vue component - [npm](https://www.npmjs.com/package/vuepress-plugin-component-docgen) (Plugins / Community)

README

        
# vuepress-plugin-component-docgen

> Vuepress plugin for creating a documentation site of your Vue component

![npm](https://img.shields.io/npm/v/vuepress-plugin-component-docgen.svg?style=flat-square)

## Install from NPM

```bash

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

```

## Install from Yarn

```bash

yarn add vuepress-plugin-component-docgen

```

## Config for your site

Update your `.vuepress/config.js`

```js

module.exports = {

    ...

    plugins: [

      [

        'component-docgen',

        {

          rootDir: ,

          include: ,

          exclude: ,

          prefix: ,

        }

      ]

    ]

}

```

## See Who Is Using `component-docgen`

- [vue-kawaii](https://github.com/youngtailors/vue-kawaii)

- [vue-w3css](https://github.com/f3ltron/vuew3css)

## Contributors

- [Evan N](https://github.com/dacsang97)

- [F3ltron](https://github.com/f3ltron/)

## License

MIT © dacsang97