dumi

指南
配置项
主题
插件

⌘ K

介绍: 什么是 dumi

基础: 初始化; 目录结构; 约定式路由; 页面渲染配置; 写组件 demo; Markdown 增强

进阶: 多语言; 页面 Tab; 移动端组件研发; 自动 API 表格

使用vue: 安装插件; 自动 API 表格

其他: 命令行; 从 dumi 1.x 升级; 常见问题

最后更新时间：

帮助改进此文档

dumi

指南
配置项
主题
插件

⌘ K

介绍: 什么是 dumi

基础: 初始化; 目录结构; 约定式路由; 页面渲染配置; 写组件 demo; Markdown 增强

进阶: 多语言; 页面 Tab; 移动端组件研发; 自动 API 表格

使用vue: 安装插件; 自动 API 表格

其他: 命令行; 从 dumi 1.x 升级; 常见问题

‌
‌
‌
‌

最后更新时间：

帮助改进此文档

命令行

`dumi dev`

启动本地开发服务器，进行项目的开发与调试。

`dumi build`

构建 dumi 文档产物，适用于生产环境的部署。

`dumi preview`

在本地启动一个静态 Web 服务器，将 docs-dist 文件夹运行在 http://127.0.0.1:4172, 用于预览构建后产物。

你可以通过 --port 参数来配置服务的运行端口。

dumi preview --port 9527

现在 preview 命令会将服务器运行在 http://127.0.0.1:9527

`dumi setup`

初始化项目，会做临时文件的生成等操作。通常在 package.json 的 scripts.prepare 里设置。

{
  "scripts": {
    "prepare": "dumi setup"
  }
}

`dumi version`

查看 dumi 版本，等同于 dumi -v。

‌
‌
‌
‌

命令行

`dumi dev`

启动本地开发服务器，进行项目的开发与调试。

`dumi build`

构建 dumi 文档产物，适用于生产环境的部署。

`dumi preview`

在本地启动一个静态 Web 服务器，将 docs-dist 文件夹运行在 http://127.0.0.1:4172, 用于预览构建后产物。

你可以通过 --port 参数来配置服务的运行端口。

dumi preview --port 9527

现在 preview 命令会将服务器运行在 http://127.0.0.1:9527

`dumi setup`

初始化项目，会做临时文件的生成等操作。通常在 package.json 的 scripts.prepare 里设置。

{
  "scripts": {
    "prepare": "dumi setup"
  }
}

`dumi version`

查看 dumi 版本，等同于 dumi -v。

TABLE OF CONTENTS

TABLE OF CONTENTS

命令行

`dumi dev`

`dumi build`

`dumi preview`

`dumi setup`

`dumi version`

命令行

`dumi dev`

`dumi build`

`dumi preview`

`dumi setup`

`dumi version`