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

Table of Contents

Api 说明头部
默认使用
frontMatter 配置
组件化使用
介绍
简介
进展
特性
Builtin 内置组件
目录 Toc
页面 Tab
进阶特性
Demo 研发
Theme 主题
SyntaxHighlighter 代码高亮
ApiHeader API 概要

ApiHeader API 概要

ApiHeader 可以清楚地呈现出 API 的基础使用方式
引入方法
js
import { Button } from 'antd';
NPM
UNPKG
BundlePhobia
PackagePhobia
Anvaka Graph
查看源码
编辑文档
上一篇
SyntaxHighlighter 代码高亮

相关资源

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 & 数字科技
‌
‌
‌
‌

Api 说明头部

该组件用于展示 API 的基础使用方式，以及 API 的文档地址和源码地址，以便用户快速了解 API 的基础使用方式。

同时提供了一个 apiHeader 的配置项，用于配置 API 的文档地址和源码地址。

默认使用

通过在 themeConfig 中 添加 apiHeader 的配置项，即可开启该特性。

详细配置参见：高级设置 - apiHeader

frontMatter 配置

如果存在特异性的文档的配置（比如 monorepo、特殊的文件部分），可以在 md 头部添加 apiHeader 元数据标记，来声明该组件

md

组件化使用

详见：ApiHeader 引用说明