Markdown 基础语法
基于 CommonMark 与 GFM 扩展,常用语法:
标题层级
# 一级标题是页面标题(每页一个);## / ### 进入右侧页内大纲 Minimap。
表格
| HTTP Status | Meaning | Notes |
| ----------- | ------- | ----- |
| 200 | 成功 | … |
任务列表与删除线
- [x] 已完成
- [ ] 待办
~~废弃的描述~~
代码块
围栏标注语言即获得语法高亮:
```bash
docdoc build ./my-docs --output ./site
```
行内代码用反引号:`docdoc.json`。
代码块 Tabs
围栏完整签名为 ```language:type#tab:三段均可选组合——language 决定语法高亮;:type 将围栏交给接口渲染器(如 jsonschema:parameters);#tab 标注标签名,参与 Tabs 合并。
相邻(之间只允许空行)且**每个块都带 #标签**的代码块,合并为一组可切换的 Tabs:
```bash#pnpm
pnpm add example
```
```bash#npm
npm install example
```
```bash#yarn
yarn add example
```
渲染效果:
pnpm add example
npm install example
yarn add example
合并规则:
- 整组每个块都必须带
#标签;单个带标签的块、被其他内容隔开的块,都保持普通代码块 - 标签可含空格;不写
#标签的普通代码块不会被并入 Tabs d2图围栏不参与合并- typed 围栏(
jsonschema:*等)在接口页照常渲染 Table ⇄ TypeScript 双视图块,可与代码块一起并入 Tabs
