什么是Markdown?

Markdown是一种轻量级标记语言,创始人为约翰·格鲁伯。它允许人们使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档。[4]这种语言吸收了很多在电子邮件中已有的纯文本标记的特性。

由于Markdown的轻量化、易读易写特性,并且对于图片,图表、数学式都有支持,目前许多网站都广泛使用Markdown来撰写帮助文档或是用于论坛上发表消息。如GitHubRedditDiscordDiasporaStack ExchangeOpenStreetMap 、SourceForge简书等,甚至还能被用来撰写电子书

——引用自Wiki

笔者推荐Markdown的理由

Markdown 的核心特点

简洁性:使用直观的符号来表示格式,比如用 # 表示标题,用 * 表示列表项。这些符号在视觉上就能传达其含义,即使不进行渲染也具有良好的可读性。

可读性:即使是纯文本形式的 Markdown 文档,也能清晰地展现文档的结构和层次。读者无需专门的软件就能理解内容的组织方式。

便携性:Markdown 文件是纯文本格式,可以在任何文本编辑器中打开和编辑,不依赖特定的软件或操作系统。

转换性:可以轻松转换为 HTML、PDF、Word 文档等多种格式,满足不同的发布需求。

与 HTML 相比,Markdown 的优势

  • 学习成本低,几分钟就能掌握基本语法
  • 编写效率高,无需输入复杂的标签
  • 专注内容,而非格式细节
  • 版本控制友好,便于协作和变更追踪

为什么选择 Markdown

提高写作效率:无需频繁使用鼠标进行格式设置,可以保持思路的连贯性。写作者可以专注于内容创作,而不被格式问题分散注意力。

降低学习门槛:相比于 LaTeX、HTML 等标记语言,Markdown 的语法极其简单,大多数人可以在一小时内掌握基本用法。

广泛兼容性:几乎所有的现代文本编辑器、代码编辑器、笔记应用都支持 Markdown。从简单的记事本到专业的 IDE,你都能找到 Markdown 的身影。

版本控制友好:由于是纯文本格式,Markdown 文件可以很好地与 Git 等版本控制系统配合,便于追踪文档的修改历史和团队协作。

未来适应性:即使特定的软件或平台消失,Markdown 文件作为纯文本仍然可以被访问和编辑,确保了内容的长期可用性。

思索

个人认为,一些小内容文章,若是没有强制格式字体需求,完全可以使用markdown文本来代替word来写,word相比之下有些臃肿,开启速度也更慢,使用起来没有直接写markdown来的流畅方便舒适。

并且许多博客、文章、代码托管平台都会支持Markdown格式来记录文本,以及大部分博客生成框架都支持使用markdown来创建网站。

Markdown编辑器

可以使用VSCode来编辑Markdown文件,VSCode强大的扩展社区支持非常多功能,笔者所学领域包括嵌入式单片机(c/c++)、html、qt等都可以使用VSCode配合插件来进行环境搭建与使用。

VScode 支持 Markdown 的扩展包括:

  • Markdown All in One:提供快捷键、目录生成、数学公式支持
  • Markdown Preview Enhanced:增强的预览功能,支持图表和演示模式
  • markdownlint:语法检查和格式规范

Markdown格式

1. 标题

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

2. 文本格式

**粗体文本**  
*斜体文本*  
***粗斜体文本***  
~~删除线文本~~  
<u>下划线文本</u>(需HTML标签)  
`行内代码`

3. 列表

无序列表

markdown

- 项目1
- 项目2
  - 子项目1
  - 子项目2

有序列表

1. 第一步
2. 第二步
   1. 子步骤1
   2. 子步骤2

任务列表

- [x] 已完成任务
- [ ] 未完成任务

4. 引用

> 这是一级引用
>> 这是嵌套的二级引用

5. 代码块

普通代码块
```
function helloWorld() {
console.log("Hello, world!");
}
```

带语法高亮的代码块
```javascript
function helloWorld() {
console.log("Hello, world!");
}
```

6. 链接

[文本链接](https://example.com "可选标题")  
<https://example.com> (自动链接)  
[引用式链接][id]  
[id]: https://example.com "引用链接标题"

7. 图片

![替代文本](https://example.com/image.jpg "可选标题")  
![本地图片](path/to/image.png)  
[引用式图片][logo]  
[logo]: https://example.com/logo.png "Logo"

8. 水平线

--- (使用三个或更多连字符)
*** (使用三个或更多星号)
___ (使用三个或更多下划线)

9. 表格

| 表头1 | 表头2 | 表头3 |
|-------|-------|-------|
| 单元格1 | 单元格2 | 单元格3 |
| 单元格4 | 单元格5 | 单元格6 |

(对齐方式)
| 左对齐 | 居中对齐 | 右对齐 |
| :-----| :------: | -----: |
| 内容 | 内容 | 内容 |

10. 特殊字符转义

需要在符号前添加 “\” 反斜杠来转义字符,否则无法显示字符

其他使用方法

等待更新


本篇文章参考文献:

Markdown 教程——菜鸟教程
Markdown——中文维基百科