使用dumi搭建文檔（一）

使用dumi搭建文檔（一）

dumi是一個爲組件開發場景而生的文檔工具

dumi官網

今天咱們就從零開始搭建一個dumi的文檔。

環境準備

首先確保 node 版本是10.13或以上

$node -v
v12.18.3
複製代碼

初始化腳手架

初始化腳手架方式有兩種：

1. 組件開發腳手架
2. 靜態站點腳手架

今天咱們使用組件開發腳手架，另外一種方式能夠本身去查看文檔

# 組件開發腳手架

# 初始化一個文檔模式的組件開發腳手架（實現這個）
$ 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