Overview

Vue-demi Lib Template is an innovative project designed to facilitate the development of component libraries that are compatible with both Vue 2 and Vue 3. This template allows developers to write components once and seamlessly use them in both versions of Vue, thanks to the functionality provided by vue-demi. By leveraging this template, developers can enjoy a more streamlined workflow and less redundancy in their coding processes.

The template is equipped with useful tools and plugins like rollup-plugin-vue-demi, which enables the building of single-file components (SFC) for both Vue versions. Coupled with the documentation capabilities of vite-press, this template not only simplifies the coding experience but also enhances the organization and accessibility of library documentation.

Features

• Dual Compatibility: Supports both Vue 2 and Vue 3, allowing for a single codebase for both frameworks.
• Efficiency with Vue-demi: Enhances development efficiency by enabling one-time writing of components for use in different Vue versions.
• Rollup Plugin Integration: Use rollup-plugin-vue-demi for seamless building of SFCs for both Vue 2 and 3.
• Automated Documentation: Automatically generate a documentation website with well-structured organization through vite-press.
• Structured Docs Requirement: Enforces a requirement for documentation organization, ensuring clarity with an index.md file in the docs folder.
• Demo Integration: Includes the ability to add demo components directly into documentation for illustrative purposes by organizing files correctly.
• Accessible Build Scripts: Provides straightforward npm scripts for building the library and documentation, making it user-friendly for developers.