Ant Design Style Dumi ThemeAnt Design Style Dumi Theme
Guide
Components
Config
Changelog
⌘ K

Table of Contents

Basic Config
github
description
actions
features
高级配置
apiHeader
Config
Document Configuration
Custom
ApiHeader
Configuration
Footer
NEXT
Document Configuration

相关资源

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-theme-antd-style For better customizability, some special fields are added, and they are placed in the themeConfig field of the dumi theme configuration item. The specific configuration fields are as follows:

Basic Config

github

  • type: string
  • default: null

The navigation bar Github icon link, if this field is not configured, it will not be displayed.

description

  • type: string | Record<string, string>
  • default: null

配置首页首屏区域的简介文字。

actions

  • type: IAction[] | Record<string, IAction[]>
  • default: null
ts

配置首页首屏区域的操作按钮。

features

  • type: IFeature[] | Record<string, IFeature[]>
  • default: null
ts

该配置底层使用本主题包的 Feature 组件,详见 Features 文档。

高级配置

apiHeader

搭配组件文档中的 atomId 字段

  • type: ApiHeaderConfig | false
  • default: undefined
ts

sourceUrl 和 docUrl 可以尝试匹配的动态字段有:

  • github: 在 themeConfig 中配置的 github 字段;
  • atomId: 在 markdown 文件中标记的 atomId ;
  • atomId.${'camel' | 'kebab' | 'snake' | 'pascal' }: 在 markdown 文件中标记的 atomId ;
    • kebab:小写加中划线;例如 {atomId.kebab}, atomId 设为 test-atomId,实际转换为 test-atom-id
    • camel:小驼峰;例如 {atomId.camel}, atomId 设为 test-atomId,实际转换为 testAtomId
    • snake:小写加下划线;例如 {atomId.snake}, atomId 设为 test-atomId,实际转换为 test_atom_id
    • pascal:大驼峰;例如 {atomId.pascal}, atomId 设为 test-atomId,实际转换为 TestAtomId
  • title: 在 markdown 文件中标记的 title 字段 ;