Ant Design Style Dumi ThemeAnt Design Style Dumi Theme
指南
配置
组件
Changelog
⌘ K

Table of Contents

apiHeader
token
codePlacement
主题配置
文档配置
自定义
ApiHeader
Footer
上一篇
主题配置
下一篇
ApiHeader

相关资源

Ant Design
Ant Design Pro
Ant Design Pro Components
Umi-React 应用开发框架
Dumi-组件/文档研发工具
qiankun-微前端框架

社区

Medium
Twitter
yuqueAnt Design 语雀专栏
Ant Design 知乎专栏
体验科技专栏
seeconfSEE Conf-SEE Conf-蚂蚁体验科技大会

帮助

GitHub
更新日志
讨论

more products更多产品

yuque语雀-知识创作与分享工具
AntVAntV-数据可视化解决方案
EggEgg-企业级 Node.js 框架
kitchenKitchen-Sketch 工具集
xtech蚂蚁体验科技
Copyright © 2022-2024
Made with ❤️ by 蚂蚁集团 - AFX & 数字科技
‌
‌
‌
‌

文档配置

在 dumi 默认的 MarkDown 配置上,额外增加了一些字段,以满足更多的自定义需求。

apiHeader

示例

md

字段表格

字段名说明默认值示例
pkg引入的组件库package.nameantd
defaultImport是否开启 defaultImportfalse-
docUrl该篇文档的 md 地址-https://github.com/xxx/xxx
sourceUrl指向该方法源码的地址-https://path/to/soure.tsx

token

token 配置字段用于在文档中使用 token 控制文档的内容尺寸展示。

md

支持的 token 列表如下:

属性名类型默认值描述
footerHeightnumber300网站底部高度
sidebarWidthnumber240侧边栏宽度
tocWidthnumber176目录宽度
contentMaxWidthnumber1152内容最大宽度

codePlacement