Overview

Vue-Donut is a streamlined template designed for use with vue-cli that enables developers to create a custom VueJS UI component library with ease. By simplifying the setup process, it takes away much of the complexity involved in building with Vue, allowing developers to focus on crafting their components and functionality.

This tool is especially useful for those looking to enhance their development workflow. With commands tailored for development, building, and documentation, Vue-Donut provides a comprehensive solution for assembling and publishing your own VueJS library.

Features

• Development Mode: Easily run your project in development mode with the yarn run dev command, allowing for a smooth testing experience.

• Pack and Publish: The yarn run build command utilizes webpack to bundle your components from src/components/index.js into a single distributable file.

• Documentation Generation: Build and maintain your project’s documentation effortlessly using the yarn run doc command, ensuring that you have a clear reference for your library.

• Output Management: Automatically outputs built files like app.[hash].js, vendor.[hash].js, and CSS files to the specified docs folder for easy access and deployment.

• Source Maps Creation: Automatically generates source maps to aid in debugging, making the development process more manageable.

• GitHub Pages Compatibility: Easily utilize the generated documentation folder as a source for GitHub Pages, facilitating the sharing of your library online.

• MIT License: Enjoy the flexibility of open source with the MIT license, allowing you to modify and distribute your library without stringent restrictions.