README
๐ vue-component-template
A template for rapid development of vue2 components to satisfy component development, packaging, release, document development, document packaging, and document deployment.
English | ็ฎไฝไธญๆ
๐ How to use?
๐ Catalog Introduction
โโโ assets Store fixed resources
โโโ docs Component documentation
โ โโโ .vuepress VuePress
โ โ โโโ components Demo use
โ โ โโโ config.js VuePress main configuration
โ โ โโโ enhanceApp.js VuePress expand configuration
โ โโโ README.md Used to show component introduction
โ โโโ changelog.md Used to display component history
โ โโโ demo.md Used to display component Demo
โโโ examples Component development and debugging
โโโ public Component development and debugging display
โโโ src Component home directory
โ โโโ index.js Component registration
โ โโโ template.vue Component implementation code
โโโ vue.config.js Component development package configuration
๐ค Command introduction
| Name | Description | Remarks |
| -- | -- | -- |
| npm run start
| Start component development | - |
| npm run build
| Component packaging | - |
| npm publish
| Component release | Recommended for first removal prepublishOnly |
| npm run docs:start
| Document start | - |
| npm run docs:build
| Document packaging | - |
| npm run docs:deploy
| Document release | The default is to use GitHub Pages |
| npm run deploy
| Document package and release | - |
๐ญ Component
Development
npm i
npm run start
# http://localhost:8080/
Unpack
npm run build
- Remove map by default
- Do not pull independent CSS files by default
- More view official website configuration
- The package file is generated in the dist file by default
Release
package.json
introduction
- If you want to publish npm,
private
needs to be set tofalse
. - The build command can be modified according to actual conditions.
- After main decides to install the component, import points to it.
- files Contains the files at the time of publishing, and includes README.md by default.
- Others can be understood according to the meaning of the word.
๐ Documentation
Start
npm run docs:start
# http://localhost:8888/
Online preview
https://one-template.github.io/vue-component-template/
Description
- Use VuePress
- Use basic layout, please add more by yourself
- Component references, currently need to be copied to components, if there is a better way, please PR
- Because the document is deployed on GitHub Pages, the
base
ofconfig.js
is set to the project name - Update the
highlight.js
version carefully - One ๐ฐ : Knotes