dumi 的 Demo 理念 原则一：能看能用 原则二：依赖清晰 原则三：易于维护 dumi 的 Demo 理念 dumi 只有一个理念——开发者应该像用户一样写 Demo 。 这句话如何理解？用户的 Demo 就是实际项目，像用户一样写 Demo 意味着这个 Demo 能直接为实际项目所用，所以它必定要满足下面几个原则。 原则一：能看...

Demo 的类型 代码块 外部引入 嵌入式 Demo 的类型 在 dumi 中，一共有 3 种 Demo 类型。 代码块 dumi 默认会将 jsx 和 tsx 语言的代码块当做 React Component 进行渲染，该代码块和普通的 module 一样，都需要具备 export default 导出，就像这样： ```jsx...

环境准备 脚手架初始化 组件开发脚手架 静态站点脚手架 手动初始化 安装 开始写文档 写个 Demo 试试看 环境准备 首先得有 node ，并确保 node 版本是 10.13 或以上。 $ node - v v10 . 13.0 脚手架初始化 为了方便使用，dumi 提供了两种不同的脚手架。我们需要先找个地方建个...

什么是 dumi？ 特性 参与贡献 什么是 dumi？ dumi，暂时就叫它嘟米 吧，是一款基于 Umi 打造、为组件开发场景而生的文档工具，与 father 一起为开发者提供一站式的组件开发体验，father 负责构建，而 dumi 负责组件开发及组件文档生成 。 和 Umi 类似，dumi 也是以路由为基础的，会自动根据目录结构和 Fro...

dumi 和 Umi 的关系是什么？ 配置项只有这些吗？想实现更多的功能怎么办？ 为什么 README.md 会出现在文档的首页？ 如何将文档部署到域名的非根目录？ 如何完全自定义首页？ dumi 支持使用 .md 之外的其他方式编写文档吗？ dumi 支持基于其他技术框架、例如 Vue、Angular 编写文档和 Demo 吗？ 如何添加...

多语言支持 最小示例 默认语言和翻译缺失 其他约定 默认 locale 文件后缀可选 locale 的有效性 README.md 的多语言 多语言支持 通常我们的组件文档都会编写不止一种语言，以覆盖不同国家、地区开发者的需要。基于 dumi，仅需给 .md 添加 locale 后缀，即可为你的文档启用多语言切换功能。 最小示例 ...

控制路由生成 约定式路由规则 控制页面名称 控制页面排序 控制页面路由 配置式路由 控制路由生成 约定式路由规则 dumi 和 Umi 一样，有一套路由生成的约定。 生成均以 resolve.includes 配置项的值作为基础检测路径，倘若我们不配置该值，则会默认探测 docs 目录、src 目录（普通项目）、package...

控制导航生成 约定式导航规则 控制导航名称 控制导航路径 控制导航顺序 控制菜单生成 配置式导航 控制导航生成 注意：导航仅在 site 模式下可用。 约定式导航规则 和菜单项及菜单分组一样，dumi 的导航也是建立在路由结构上生成的。路由的嵌套关系会被 dumi 解析为导航及导航下的菜单分组，还是看看 dumi 会怎么识别路由...

Config mode title description logo locales menus navs resolve includes previewLangs routes 其他配置 提示：dumi 基于 Umi，即除了本页提到的配置项以外，还支持 所有 Umi 的配置项 ，并且也支持 Umi 生态的插件 。 ...

文档示例 Demo 嵌入 外部 Demo TS 转 JS 一级标题 二级标题 三级标题 四级标题 五级标题 六级标题 水平线 强调样式 引用 列表 代码 表格 超链接 文档示例 此页面列举了 dumi 渲染各项 Markdown 样式以及 Demo 的效果。 Demo 嵌入 import React ...