https://github.com/vue-styleguidist/vue-styleguidist

Created from react styleguidist for Vue Components with a living style guide
https://github.com/vue-styleguidist/vue-styleguidist

design-system doc documentation markdown parser style-guide styleguide vue vue-components vuejs

Last synced: 5 days ago
JSON representation

Created from react styleguidist for Vue Components with a living style guide

• Host: GitHub
• URL: https://github.com/vue-styleguidist/vue-styleguidist
• Owner: vue-styleguidist
• License: mit
• Created: 2017-06-11T20:44:36.000Z (over 7 years ago)
• Default Branch: dev
• Last Pushed: 2024-10-23T08:20:26.000Z (3 months ago)
• Last Synced: 2024-10-30T08:04:08.660Z (2 months ago)
• Topics: design-system, doc, documentation, markdown, parser, style-guide, styleguide, vue, vue-components, vuejs
• Language: TypeScript
• Homepage: https://vue-styleguidist.github.io
• Size: 25 MB
• Stars: 2,467
• Watchers: 26
• Forks: 416
• Open Issues: 91
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

• stars - vue-styleguidist/vue-styleguidist

README

        


    


**Isolated Vue component development environment with a living style guide**



[![Lint & Test](https://github.com/vue-styleguidist/vue-styleguidist/actions/workflows/release.yml/badge.svg)](https://github.com/vue-styleguidist/vue-styleguidist/actions/workflows/release.yml)



    





  





    





    





    







Start documenting now on codesandbox.io



    





## Sponsors

A big thank you to our sponsors. 

[Marcello Bachechi](https://github.com/pilotkid), [Walter Tommasi](https://github.com/jtommy), [Luca Ban](https://github.com/mesqueeb) and [Ben Hong](https://github.com/bencodezen)

## Packages

[vue-styleguidist](packages/vue-styleguidist) takes the results of [vue-docgen-api](packages/vue-docgen-api) and creates a website to showcase and develop components.

[![](https://img.shields.io/npm/v/vue-styleguidist.svg)](https://www.npmjs.com/package/vue-styleguidist) [![](https://img.shields.io/npm/dw/vue-styleguidist.svg)](https://www.npmjs.com/package/vue-styleguidist)

---

[vue-docgen-api](packages/vue-docgen-api) parses vue components and load their documentation in a JavaScript object.

[![](https://img.shields.io/npm/v/vue-docgen-api.svg)](https://www.npmjs.com/package/vue-docgen-api) [![](https://img.shields.io/npm/dw/vue-docgen-api.svg)](https://www.npmjs.com/package/vue-docgen-api)

---

[vue-inbrowser-compiler](packages/vue-inbrowser-compiler) takes vue components code written in es6 and uses buble to make it compatible with all browser.

[![](https://img.shields.io/npm/v/vue-inbrowser-compiler.svg)](https://www.npmjs.com/package/vue-inbrowser-compiler) [![](https://img.shields.io/npm/dw/vue-inbrowser-compiler.svg)](https://www.npmjs.com/package/vue-inbrowser-compiler)

---

[vue-cli-plugin-styleguidist](packages/vue-cli-plugin-styleguidist) configures vue-styleguidist to work with [vue-cli 3](https://cli.vuejs.org/guide/).

[![](https://img.shields.io/npm/v/vue-cli-plugin-styleguidist.svg)](https://www.npmjs.com/package/vue-cli-plugin-styleguidist) [![](https://img.shields.io/npm/dw/vue-cli-plugin-styleguidist.svg)](https://www.npmjs.com/package/vue-cli-plugin-styleguidist)

---

[vue-docgen-cli](packages/vue-docgen-cli) is a command line interface generating documentation files automatically from [vue-docgen-api](packages/vue-docgen-api). Generate markdown by default but can be configured to generate whatever text format you desire.

[![](https://img.shields.io/npm/v/vue-docgen-cli.svg)](https://www.npmjs.com/package/vue-docgen-cli) [![](https://img.shields.io/npm/dw/vue-docgen-cli.svg)](https://www.npmjs.com/package/vue-docgen-cli)

## Documentation

Docs are available at https://vue-styleguidist.github.io/ - we are still working on refining it and contributions are welcome!

## Contributing

Please see [contributing guide](https://github.com/vue-styleguidist/vue-styleguidist/blob/dev/.github/CONTRIBUTING.md).

Note that the current monorepo relies on `yarn` workspaces. Don't forget to install yarn, `npm i --global yarn`, before cloning.

## Authors and license

[Artem Sapegin](http://sapegin.me), [Rafael Escala](https://github.com/rafaesc), [Bart Ledoux](https://github.com/elevatebart), [react-styleguidist contributors](https://github.com/styleguidist/react-styleguidist/graphs/contributors) and [vue-styleguidist contributors](https://github.com/vue-styleguidist/vue-styleguidist/graphs/contributors). Thanks to the team of react-styleguidist for the amazing tool.

We work on this project because we love the open-source community and learn new things.

Logo by [Benjamin Cognard](https://twitter.com/benbnur).

## License

[MIT License](https://github.com/vue-styleguidist/vue-styleguidist/blob/delivery/LICENSE)