Skip to content

本地开发

Maintain

本地开发

这里记录组件库和文档站的本地开发命令。修改文档后建议始终执行构建,避免上线时才发现链接或 Markdown 渲染问题。

安装依赖

根 README 建议:

bash
yarn

安装子包依赖:

bash
lerna bootstrap

或使用 workspace:

bash
pnpm install

本地调试包

例如调试 @mbjia/ui

bash
cd packages/ui
yarn link

cd your-project
yarn link @mbjia/ui

调试完成后:

bash
cd your-project
yarn unlink @mbjia/ui

cd packages/ui
yarn unlink

文档开发

bash
npm run docs:dev

构建:

bash
npm run docs:build

更多维护规则见 文档维护

文档修改建议流程

  1. 先从源码确认 Props、回调、事件和数据结构。
  2. 修改对应文档页。
  3. 如果新增组件或包导出,同步更新索引页。
  4. 执行构建验证。
bash
pnpm docs:build

MBJIA Tools 文档