前言
笔者在上一篇文章使用dumi搭建文档(一)中介绍了使用dumi搭建文档的初始化工作,今天我们就来学习dumi文档的配置。
正文
目录结构
docs# 组件库文档目录
1、index.md# 组件库文档首页src# 组件库源码目录
1、Foo# 单个组件.umirc.ts# dumi配置文件
.umirc.ts 配置
| 类型 | 默认值 | 详细 | 预览 | |
|---|---|---|---|---|
| title | String | {package.name} | 配置文档的名称 | |
| logo | String | Umi的Logo | 配置文档的Logo | |
| description | String | null | 配置文档的介绍,显示在菜单标题下方,仅doc可用 | |
| mode | doc | site | doc | 设定文档的展现模式 | |
| locales | Array<[String, String]> | [['en-US', 'English'], ['zh-CN', '中文']] | 设定文档显示语言 | |
| outputPath | String | docs-dist | 指定输出路径 |
FrontMatter 配置
| 类型 | 默认值 | 详细 | 预览 | |
|---|---|---|---|---|
| title | String | 正文第一个标题 | 配置该页面的标题 | |
| sidemenu | Boolean | true | 控制侧边栏菜单的显示或隐藏 | |
| toc | false | 'content' | 'menu' | 'content' | 控制锚点目录的显示或位置 | |
| order | Number | null | 控制该文档的显示顺序,数值越小排序越靠前 | |
| group | Object | null | 对当前页面进行分组 | |
| group:title | String | 分组名 | ||
| group:path | String | 分组路由 | ||
| group:order | Number | null | 分组的显示顺序 |
最终效果
最后
如果想学习更多关于dumi的配置,欢迎在dumi配置共同探索。欢迎关注《一条咸鱼的狗》一起学习讨论