dumidumi
  • 指南
  • 配置项
  • 主题
  • Internal
  • 插件
⌘ K
介绍
什么是 dumi
基础
初始化
目录结构
约定式路由
页面渲染配置
写组件 demo
Markdown 增强
进阶
多语言
页面 Tab
移动端组件研发
自动 API 表格
使用vue
安装插件
自动 API 表格
其他
命令行
从 dumi 1.x 升级
常见问题
最后更新时间:
帮助改进此文档
Open-source MIT Licensed | Copyright © 2019-present
Powered by self

页面 Tab

为了便于开发者更优雅地组织复杂文档,比如将 API、示例、设计规范等内容组合呈现,dumi 提供了开箱即用的约定式页面 Tab 特性,以该篇文档为例:

bash
.
└── docs
└── guide
├── page-tab.md
└── page-tab.$tab-example.md # Tab 示例内容

dumi 约定同名 Markdown 文件的 $tab-{key} 修饰符该文档的 Tab 内容,如上所示,page-tab.$tab-example.md 会作为 page-tab.md 的 Tab 呈现。此处 example 作为 Tab 的 key 值,如果需要配置 Tab 标题,可以使用 FrontMatter 来定义,用法同普通文档:

md
---
title: Tab 示例
---

如此一来,我们就能得到和当前页面一样的 Tab 效果。

如果你是 dumi 的主题包或插件开发者,还可以通过插件 API 来为指定路由添加 Tab,具体用法请参考 插件 API - addContentTab。