`标签，方便搜索引擎爬取，比如
```markdown
---
title: teedoc
---
## 标题一
内容。。。
## 标题二
内容。。。
```
## 标题
### 三级标题
#### 四级标题
#### 四级标题2
#### 四级标题3
##### 五级标题
###### 六级标题
### 标题自定义id {#custom-id}
这里自定义 `id` 为 `custom-id`
最多 6 级标题
.. details::Markdown 源码，点击展开
```markdown
### 三级标题
#### 四级标题
#### 四级标题2
#### 四级标题3
##### 五级标题
###### 六级标题
### 标题自定义id {#custom-id}
这里自定义 `id` 为 `custom-id`
```
## 强调，斜体，删除线
我们只知道**地球**具有让人类生存的环境，还有~~火星~~，也许还有*其它星球*。
.. details::Markdown 源码，点击展开
```markdown
我们只知道**地球**具有让人类生存的环境，还有~~火星~~，也许还有*其它星球*。
```
## 分隔符
分隔符
```markdown
---
***
```
---
***
## 链接
[相对路径， README.md 文件](../README.md): `../README.md`， 会自动转换成`index.html`
[相对路径， md 文件](./syntax_markdown.md)： `./syntax_markdown.md`， 会转成文档的 `.html` 结尾的链接
[绝对路径， http 文件](https://storage.googleapis.com/tensorflow_docs/docs-l10n/site/zh-cn/tutorials/quickstart/beginner.ipynb)： `https://。。。/beginner.ipynb`，原链接，不会修改
[相对路径， ipynb 文件](./syntax_jupyter.ipynb)： `./syntax_jupyter.ipynb`， 会转成文档的 `.html` 结尾的链接
.. details::Markdown 源码，点击展开
```markdown
[相对路径， README.md 文件](../README.md)
[相对路径， md 文件](./syntax_markdown.md)
[绝对路径， http 文件](https://storage.googleapis.com/tensorflow_docs/docs-l10n/site/zh-cn/tutorials/quickstart/beginner.ipynb)
[相对路径， ipynb 文件](./syntax_jupyter.ipynb)
```
## 列表
列表项:
* 包子
* 馒头
* 茶叶蛋
* aaaaaaa
* 二级列表
* 二级列表
* 二级列表
* 三级列表
* 三级列表
* bbbbbb
.. details::Markdown 源码，点击展开
```markdown
列表项:
* 包子
* 馒头
* 茶叶蛋
* aaaaaaa
* 二级列表
* 二级列表
* 二级列表
* 三级列表
* 三级列表
* bbbbbb
```
## 代码段
这是一段行内代码`print("hello")`，或者强调`teedoc`
```python
print("hello")
print("world")
```
```c
#include "stdio.h"
int main()
{
printf("hello world");
}
```
.. details::Markdown 源码，点击展开
```markdown
这是一段行内代码`print("hello")`，或者强调`teedoc`
```python
print("hello")
print("world")
```
```c
#include "stdio.h"
int main()
{
printf("hello world");
}
```
```
## 注释(引用块)
下面是一段注释
> 这里是一段注释 (``)
> 这是注释的第二行
```python
# 这里是注释里面的代码段
print("hello")
```
> 注释
>> 注释嵌套
>> 注释嵌套
在块引用中使用 markdown 语法
> #### The quarterly results look great!
>
> - Revenue was off the chart.
> - Profits were higher than ever.
>
> *Everything* is going according to **plan**.
> ```c
> printf("hello");
> ```
.. details::Markdown 源码，点击展开
```markdown
下面是一段注释
> 这里是一段注释 (``)
> 这是注释的第二行
```python
# 这里是注释里面的代码段
print("hello")
```
> 注释
>> 注释嵌套
>> 注释嵌套
在块引用中使用 markdown 语法
> #### The quarterly results look great!
>
> - Revenue was off the chart.
> - Profits were higher than ever.
>
> *Everything* is going according to **plan**.
> ```c
> printf("hello");
> ```
```
## 警告
下面是一段警告信息
>! 这是一段警告信息(``)
.. details::Markdown 源码，点击展开
```markdown
>! 这是一段警告信息(``)
```
## Emoji 表情
暂不支持`emoji`语法，但是可以直接从`emoji`表情大全拷贝表情到文档，比如:
🍊 🍇 😀 😅 😇
## 上下标
H~2~O， y = x^2^
.. details::Markdown 源码，点击展开
```markdown
H~2~O， y = x^2^
```
## 图片
资源文件会被拷贝到输出文件夹（`out`）, 所以最重要的是怎么在文档中引用
* 最简单和推荐的方法
使用相对路径：
资源文件可以放在文档对应的目录，比如文档`docs/get_started/zh`， 可以创建`docs/get_started/zh/assets/images/logo.png`,
然后在`docs/get_started/zh/README.md`中使用相对路径引用，即``
* 进阶方法
这种情况适用于多份文档都引用同一个文件夹下（`url`）的资源， 方便维护多份文档，比如多语言翻译，或者减少 `CDN` 流量消耗。
使用文档路径外的资源，在`site_config.json` 中配置
```json
{
"route": {
"docs": {
"/get_started/zh/": "docs/get_started/zh",
},
"assets": {
"/get_started/assets/": "docs/get_started/assets"
}
}
}
```
这个设置会将`docs/get_started/assets`整个目录拷贝为`/get_started/assets`
所以只需要在`docs/get_started/zh/README.md`中使用相对路径引用，即``
要显示这张图片，需要在`site_config.json`中设置`route`键值
.. details::Markdown 源码，点击展开
```markdown
```
## 视频
直接使用 HTML 的 `video` 标签：
```html
```
这里没有放视频， 所以是空白, 放入正确的视频就可以播放了
## iframe 嵌入网页
一般视频平台分享的代码直接能使用，可以稍微设置一下宽高
.. details::Markdown 源码，点击展开
```html
```
## 引用标记
我能干饭我自豪。[^干饭人]
[^干饭人]: 老子说道
这会在文章末尾进行注解
.. details::Markdown 源码，点击展开
```markdown
我能干饭我自豪。[^干饭人]
[^干饭人]: 老子说道
这会在文章末尾进行注解
```
## 表格
| Header 1 | *Header* 2 |
| -------- | -------- |
| `Cell 1` | [Cell 2](http://example.com) link |
| Cell 3 | **Cell 4** |
.. details::Markdown 源码，点击展开
```markdown
| Header 1 | *Header* 2 |
| -------- | -------- |
| `Cell 1` | [Cell 2](http://example.com) link |
| Cell 3 | **Cell 4** |
```
## 任务列表
- [x] 任务1
- [x] 任务2
- [ ] 任务3
- [ ] 任务4
.. details::Markdown 源码，点击展开
```markdown
- [x] 任务1
- [x] 任务2
- [ ] 任务3
- [ ] 任务4
```
## 标题链接(页内跳转)
比如要跳转到标题[iframe 嵌入网页](#iframe-嵌入网页), 只需
```markdown
[iframe 嵌入网页](#iframe-嵌入网页)
```
这里空格使用了减号`-`替换。
另外，如果标题也可以自定义`id`，比如
```markdown
## iframe 嵌入网页 {#iframe-embed}
```
## HTML
能直接在`md`文件中写`HTML`：
hello
.. details::Markdown 源码，点击展开
注意没有空行
```html
hello
```
## 数学
支持`tex`和`Latex`语法，以及`MathML`标签
两种写法，
* 一种是行内内嵌，用`$`符号将方程包起来，比如
质能方程 $E=mc^2$大家很熟悉吧
.. details::Markdown 源码，点击展开
```markdown
质能方程 $E=mc^2$大家很熟悉吧
```
* 另一种，块方程，用`$$`将方程包起来，比如
$$
E=mc^2
$$
.. details::Markdown 源码，点击展开
```markdown
$$
E=mc^2
$$
```
其他例子：
常见：
When $a \ne 0$, there are two solutions to $ax^2 + bx + c = 0$ and they are
$$
x = {-b \pm \sqrt{b^2-4ac} \over 2a}.
$$
.. details::Markdown 源码，点击展开
```markdown
When $a \ne 0$, there are two solutions to $ax^2 + bx + c = 0$ and they are
$$
x = {-b \pm \sqrt{b^2-4ac} \over 2a}.
$$
```
除法式：
$$
\require{enclose}
\begin{array}{r}
13 \\[-3pt]
4 \enclose{longdiv}{52} \\[-3pt]
\underline{4}\phantom{2} \\[-3pt]
12 \\[-3pt]
\underline{12}\\0
\end{array}\\
$$
.. details::Markdown 源码，点击展开
```markdown
$$
\require{enclose}
\begin{array}{r}
13 \\[-3pt]
4 \enclose{longdiv}{52} \\[-3pt]
\underline{4}\phantom{2} \\[-3pt]
12 \\[-3pt]
\underline{12}\\0
\end{array}\\
$$
```
加框：
$$
\bbox[#cde, 3px,border:1px solid blue]{y=x^2-1}
$$
.. details::Markdown 源码，点击展开
```markdown
$$
\bbox[#cde, 3px,border:1px solid blue]{y=x^2-1}
$$
```
## mermaid 支持
使用 mermaid 可以画很多类型的图表， 详细的语法和支持请看[官网](https://mermaid-js.github.io/)
```mermaid
sequenceDiagram
Alice->>John: Hello John, how are you?
loop Healthcheck
John->>John: Fight against hypochondria
end
Note right of John: Rational thoughts!
John-->>Alice: Great!
John->>Bob: How about you?
Bob-->>John: Jolly good!
```
.. details::Markdown 源码，点击展开
```markdown
```mermaid
sequenceDiagram
Alice->>John: Hello John, how are you?
loop Healthcheck
John->>John: Fight against hypochondria
end
Note right of John: Rational thoughts!
John-->>Alice: Great!
John->>Bob: How about you?
Bob-->>John: Jolly good!
```
```
或者直接 `html`:
```html
sequenceDiagram
Alice->>John: Hello John, how are you?
loop Healthcheck
John->>John: Fight against hypochondria
end
Note right of John: Rational thoughts!
John-->>Alice: Great!
John->>Bob: How about you?
Bob-->>John: Jolly good!
```
## 标签页（tabset）支持
> 因为不是标准 Markdown 语法，目前仅 teedoc 支持，所以根据你的需求选择使用
> 当然也欢迎将格式推广到其它解析器
效果：
.. tabset::标签页标题（可选）
:id: tabset1
## 标签一
内容一，可以使用 Markdown 语法
```kotlin
fun main() {
println("Hello World")
}
```
## 标签二
内容二，可以使用 Markdown 语法
```java
public class Main {
public static void main(String[] args) {
System.out.println("Hello World");
}
}
```
在选中一个页面中的某个标签时，会自动选中相同`id`的标签页中的相应标签，不相同`id`或者没设置`id`则不会。
.. tabset::
:id: tabset1
## 标签一
内容一，可以使用 Markdown 语法
```kotlin
fun main() {
println("Hello World")
}
```
## 标签二
内容二，可以使用 Markdown 语法
```java
public class Main {
public static void main(String[] args) {
System.out.println("Hello World");
}
}
```
.. tabset::
## 标签一
内容一，可以使用 Markdown 语法
```kotlin
fun main() {
println("Hello World")
}
```
## 标签二
内容二，可以使用 Markdown 语法
```java
public class Main {
public static void main(String[] args) {
System.out.println("Hello World");
}
}
```
.. details::Markdown 源码，点击展开
```markdown
效果：
（注意这里需要空一行）
.. tabset::标签页标题（可选）
:id: tabset1
(注意必须和上面的 tabset 对齐或者更多空格)
## 标签一
内容一，可以使用 Markdown 语法
```kotlin
fun main() {
println("Hello World")
}
```
## 标签二
内容二，可以使用 Markdown 语法
```java
public class Main {
public static void main(String[] args) {
System.out.println("Hello World");
}
}
```
```
## 详情页（details）支持
> 因为不是标准 Markdown 语法，目前仅 teedoc 支持，所以根据你的需求选择使用
> 当然也欢迎将格式推广到其它解析器
这是对 `HTML5` `details`标签的一种 `Markdown` 语法， `HTML`这样写:
```html
标题，点击展开
这里是内容
```
效果：
.. details::标题，点击展开
内容一，可以使用 Markdown 语法
```kotlin
fun main() {
println("Hello World")
}
```
.. details::标题，默认展开
:open: true
内容一，可以使用 Markdown 语法
```kotlin
fun main() {
println("Hello World")
}
```
.. details::Markdown 源码，点击展开
```markdown
.. details::标题，点击展开
内容一，可以使用 Markdown 语法
```kotlin
fun main() {
println("Hello World")
}
```
.. details::标题，默认展开
:open: true
内容一，可以使用 Markdown 语法
```kotlin
fun main() {
println("Hello World")
}
```
```
标题，点击展开
这里是内容