使用dumi搭建文档(一)
dumi是一个为组件开发场景而生的文档工具
今天我们就从零开始搭建一个dumi的文档。
环境准备
首先确保 node 版本是10.13或以上
$node -v
v12.18.3
初始化脚手架
初始化脚手架方式有两种:
- 组件开发脚手架
- 静态站点脚手架
今天我们使用组件开发脚手架,另一种方式可以自己去查看文档
# 组件开发脚手架
# 初始化一个文档模式的组件开发脚手架(实现这个)
$ npx @umijs/create-dumi-lib
# or
$ yarn create @umijs/dumi-lib
# 初始化一个站点模式的组件开发脚手架
$ npx @umijs/create-dumi-lib --site
# or
$ yarn create @umijs/dumi-lib --site
如果安装速度慢的,可以切换到 cnpm
或者 tyarn
# npm 切换 cnpm
$ npm install -g cnpm --registry=https://registry.npm.taobao.org
# 查看版本号
$ cnpm -v
# yarn 切换 tyarn
$ cnpm install -g yarn tyarn
执行
初始化后执行 npm install
或 yarn
安装依赖
安装好后再执行 npm run start
或 yarn start
构建&部署
执行 npm run docs:build
或 yarn docs:build