使用dumi搭建文档(二)

2,378 阅读1分钟

前言


笔者在上一篇文章使用dumi搭建文档(一)中介绍了使用dumi搭建文档的初始化工作,今天我们就来学习dumi文档的配置。

正文


目录结构

  • docs # 组件库文档目录
    1、index.md # 组件库文档首页
  • src # 组件库源码目录
    1、Foo # 单个组件
  • .umirc.ts # dumi配置文件

.umirc.ts 配置

类型默认值详细预览
titleString{package.name}配置文档的名称
logoStringUmi的Logo配置文档的Logo
descriptionStringnull配置文档的介绍,显示在菜单标题下方,仅doc可用
modedoc | sitedoc设定文档的展现模式
localesArray<[String, String]>[['en-US', 'English'], ['zh-CN', '中文']]设定文档显示语言
outputPathStringdocs-dist指定输出路径

FrontMatter 配置

类型默认值详细预览
titleString正文第一个标题配置该页面的标题
sidemenuBooleantrue控制侧边栏菜单的显示或隐藏
tocfalse | 'content' | 'menu''content'控制锚点目录的显示或位置
orderNumbernull控制该文档的显示顺序,数值越小排序越靠前
groupObjectnull对当前页面进行分组
group:titleString分组名
group:pathString分组路由
group:orderNumbernull分组的显示顺序

最终效果

最后


如果想学习更多关于dumi的配置,欢迎在dumi配置共同探索。欢迎关注《一条咸鱼的狗》一起学习讨论