https://github.com/siegerts/vue-component-library-template
Supporting project and code for Vue Component Library post series.
https://github.com/siegerts/vue-component-library-template
component-library documentation vue vuepress
Last synced: 4 months ago
JSON representation
Supporting project and code for Vue Component Library post series.
- Host: GitHub
- URL: https://github.com/siegerts/vue-component-library-template
- Owner: siegerts
- License: mit
- Created: 2019-03-05T01:18:00.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T17:46:59.000Z (over 3 years ago)
- Last Synced: 2025-06-04T14:20:36.035Z (about 1 year ago)
- Topics: component-library, documentation, vue, vuepress
- Language: JavaScript
- Homepage: https://xiegerts.com/series/vue-component-library/
- Size: 976 KB
- Stars: 33
- Watchers: 3
- Forks: 26
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vue-component-library-template
Supporting project and code for [Vue Component Library](https://xiegerts.com/series/vue-component-library/) post series.
> In this series, we’ll focus on structuring a Vue component library as a plugin for use, and reuse. That also includes distribution and documentation. That’s what is so great about Vue - the ability to create your own building blocks for designing a user experience. This series of posts is not about writing components, that’s a subject for another day.
- [Creating a Vue.js component library: Introduction](https://xiegerts.com/post/creating-vue-component-library-introduction/)
- [Structuring a Vue component library](https://xiegerts.com/post/creating-vue-component-library-structure/)
- [Consolidating components into a Vue.js plugin](https://xiegerts.com/post/creating-vue-component-library-plugin/)
- [Using VuePress for plugin documentation](https://xiegerts.com/post/creating-vue-component-library-documentation/)
- [Deploy VuePress on Netlify](https://www.xiegerts.com/post/creating-vue-component-library-deploy/)
- [Publishing a Vue component plugin on npm](https://www.xiegerts.com/post/creating-vue-component-library-npm/)
## Project setup
```
yarn install
```
### Compiles and hot-reloads documentation site for development
```
yarn docs:dev
```
### Compiles and minifies for documentation site for production
```
yarn docs:build
```