Skip to content

快速上手

面向组件库开发者:基于本脚手架开发、构建和预览你的组件库。

作为模板使用:若复制本仓库做自己的组件库,请修改 package.jsonname,以及 docs/.vitepress/config.jsdocs/preview/vite.config.js 中的 alias,改为你的包名。

安装依赖

bash
npm install
# 或
pnpm install

开发

启动文档站(含组件预览):

bash
pnpm start
# 或
npm run start

浏览器访问 http://127.0.0.1:6065 查看文档和 Demo。

构建

文档构建

构建文档站和预览页:

bash
pnpm build:all
# 或
npm run build:all

产出目录(可通过 .env.productionDOCS_OUT_DIRPREVIEW_OUT_DIR 修改):

  • 文档:docs-dist/docs/
  • 预览:docs-dist/mobile/

组件库构建

构建组件库产物(ESM、CJS、UMD 及样式):

bash
pnpm build:lib
# 或
npm run build:lib

产出在 dist/ 目录。

下一步