Create Vue Component Package

This package can be used to quickly generate the base for your component to be published on npm. It contains the following features:

• Rollup to transpile for ESM, SSR and UNPKG
• Vuepress for documentation
• Automated API documentation generation with vuedoc.md

Usage

Run the following command in your terminal to initialize:

npm init vue-component-package

Publishing

During the initialisation there is one step that asks 'Do you want to add a GitHub action for publishing to npm'. To make this work you need to set a secret in your GitHub repo settings called NPM_AUTH_TOKEN containing your npm token. Now when you push a new tag to github, the new version will be published to npm.

Roadmap

• add support for component/directive/...
• add TypeScript support
• add style bundling (postcss > legacy + modern?)
• add version support (simple docs/v1/?) and configure VuePress search by version