多种呈现模式

目前,dumi 支持两种呈现模式,分别是文档模式和站点模式。在两种模式之间切换也非常地简单:

// config/config.ts 或 .umirc.ts
export default {
// 文档模式(默认值)
mode: 'doc',
// 站点模式
mode: 'site',
};

在组件库比较轻量、不需要繁杂文档的时候,可以以文档模式呈现;在它羽翼丰满、需要有教程和周边生态时,建议以站点模式呈现。以 dumi 的官网为例展示效果分别如下:

文档模式

文档模式的特点是:

  • 没有导航头
  • 没有搜索框
  • 没有定制化的首页
  • 支持 description 配置项展示简介
  • 支持通过 package.json 中的 repository 配置自动展示 GitHub Stars 数
  • 支持通过 package.json 中的 repository 配置自动展示 markdown 文件 footerEdit this doc on GitHub 的超链接
  • 支持通过 package.json 中的 repository.branch 配置可修改 Edit this doc on GitHub 该超链接跳转的分支,默认为 master 分支

站点模式

官网模式的特点是: