Markdown 使用指南¶
Markdown 是一种轻量级标记语言,创建于2004年,现在已经成为世界上最流行的标记语言之一。它允许人们使用易读易写的纯文本格式编写文档,然后转换成有效的HTML文档。
基础语法¶
标题¶
强调¶
列表¶
无序列表:
有序列表:
链接¶
图片¶
引用¶
代码¶
行内代码:
代码块:
水平线¶
扩展语法¶
表格¶
任务列表¶
脚注¶
上标和下标¶
MkDocs Material 特有功能¶
提示框¶
代码标签页¶
=== "C"
```c
#include <stdio.h>
int main(void) {
printf("Hello world!\n");
return 0;
}
```
=== "Python"
```python
print("Hello world!")
```
Mermaid 图表¶
总结¶
Markdown 是一种非常实用的文档格式,特别适合用于:
- 技术文档
- 博客文章
- 笔记记录
- README 文件
通过使用 MkDocs Material 主题,我们还可以利用更多扩展功能,使文档更加丰富和交互性强。