教程
Markdown 技术文档
什么是 Markdown?
Markdown 是一种轻量级标记语言,它使用易读易写的纯文本格式,并且能够被转换成 HTML 页面以及其他格式。Markdown 语法简单,易于学习,并且可以快速生成格式良好的文档。
Markdown 的语法
标题
Markdown 使用 #
表示一级标题,##
表示二级标题,以此类推,最多支持六级标题。
# 一级标题
## 二级标题
### 三级标题
段落和换行
段落和换行使用空行进行分割。
这是一段文字,后面有一个空行。
这是下一段文字。
如果需要在一行中进行换行,可以在末尾添加两个空格。
这是一行文字。
这是下一行文字。
粗体和斜体
粗体使用两个 *
或者两个 _
包裹文本,斜体使用一个 *
或者一个 _
包裹文本。
**粗体**
__粗体__
*斜体*
_斜体_
链接
链接分为行内式和引用式两种方式,行内式使用 [显示文本](链接地址)
,引用式使用 [显示文本][引用名称]
,然后在文档的其它位置再使用 [引用名称]: 链接地址
。
这是一个 [百度](https://www.baidu.com/) 链接。
这是一个 [另一个链接][1]。
[1]: https://www.google.com/
图片
图片的语法类似于链接,只需要在链接的前面添加一个 !
。
![图片说明](图片链接地址)
列表
Markdown 支持有序列表和无序列表,有序列表使用数字加一个英文句点,无序列表使用星号、加号或者减号。
1. 列表项 1
2. 列表项 2
- 嵌套列表项 1
- 嵌套列表项 2
* 列表项 A
* 列表项 B
代码块
代码块使用三个反引号包裹,后面跟着代码块所使用的编程语言。
```python
print("Hello, World!")
## Markdown 工具
### Typora
Typora 是一款跨平台的 Markdown 编辑器,可以实时预览文档效果,支持快捷键操作和实时搜索等特性。
### VS Code
Visual Studio Code 是一款流行的开发器工具,支持 Markdown 插件,可以实现代码高亮、文档大纲、预览等功能。
### GitLab
GitLab 是一款代码托管和管理工具,在 GitLab 的 Wiki 页面中可以使用 Markdown 语法来撰写文档。
## 结语
Markdown 是一种轻量级的标记语言,适用于编写技术文档、笔记、博客等各类文档。掌握 Markdown 语法和使用相关工具可以帮助我们更加高效地写作和管理文档。