Skip to content

Latest commit

 

History

History
155 lines (101 loc) · 3.95 KB

README.md

File metadata and controls

155 lines (101 loc) · 3.95 KB
Raw

A Vue3 UI library template

中文文档

Help you quickly create a component library.

  • 🚀 dev with Vite
  • ✈️ build with esbuild
  • 🚁 generate types with ts-morph

Docs

Feature

  • 🌈 Speedy dev & build
  • 🎆 Customize friendly
  • 📝 More beautiful doc, support Chinese and English. Support Dark Mode by vueuse
  • 🍭 Rich scripts, inspired by esbuild-plugin-vue & vue-dts-gen
  • 😋 Type friendly
  • 🚚 ESM & CJS product

How to use

Generate a repository by vuecompoent-seed

Install

yarn

Dev

Benefited from vite-plugin-pages, the src/pages/index.vue is the entry page for development. You can visit /[component-name]/demo to check component, like http://localhost:3000/#/button/demo.

yarn dev

Build

yarn build

Test

yarn test

Generate entry point

The entry file is the input option for rollup.

yarn gen-entry

Generate Component

A component's name is required for this command.

yarn gen [component\'s name]

Generate dts

npx esno ./scripts/gen-dts.ts

Release

This command will add git tag、generate changelog. You can test your lib with argument --dry

yarn release [--dry]

Build Docs

❗ Noted: you should run yarn build:lib before run this command. Because the docs need the build bundle.

Docs dev

yarn docs:dev

Docs build

yarn docs:build

Docs deploy

Here is a git action. When you push the code to the master branch, the document will be automatically deployed on gh-pages branch. Then you can set the Github Pages's source on the gh-pages branch.

Use demo code in doc

Take button as an example.

In button.md, insert the following code

<demo-wrapper
  src="src/packages/button/demo"
  :demos="demos"
/>

<script setup>
const demos = import.meta.globEager('../../../src/packages/button/demo/demo*.vue')
</script>

There is a global component DemoWrapper to display all demos. This is currently the only way to show demo. More info.

Custom doc style

You can add the class in frontmatter, then the <Content> would inherit the class. Of course, the windicss can be used here.

---
class: 'custom-class'
---

Recommended IDE Setup

VSCode + Volar.

If Using <script setup>

<script setup> is a feature that is currently in RFC stage. To get proper IDE support for the syntax, use Volar instead of Vetur (and disable Vetur).

Credits

Thanks


eeeeelle