markdown指南

什么是Markdown？

Markdown 是一种轻量级标记语言，允许人们使用易读易写的纯文本格式编写文档。 它广泛用于编写说明文档、博客文章和技术文档。

Markdown的优点

  • 简洁高效：学习成本低，语法简洁，用文本编辑器即可。
  • 跨平台兼容：所有支持Markdown的平台（如GitHub、知乎、简书）都能完美渲染，还可转换为HTML、PDF等多种格式。
  • 版本控制友好：纯文本格式，方便用Git进行版本管理。适合笔记、博客、文档编写。

Markdown的基本语法速览

Markdown语法详解效果
*斜体*用单星号包围文本斜体
**粗体**用双星号包围文本粗体
# 一级标题"#"后需加空格一级标题
## 二级标题以此类推三级标题为三个"#"二级标题
[链接](http://a)"[]"内为显示的超文本链接
![图片](http://url/a.png)"[]"内为图片名图片显示
> 引用" > "后需加空格引用块
* 无序列表无列表项
1. 有序列表无编号列表
---水平分割线----
`内联代码` | 用反引号包围 | 内联代码
```代码块开始/结束标记代码块
颜色代码无无
***粗体+斜体***三个星号包围粗体+斜体
居中格式使用HTML标签居中文字

语法示例

文本格式化

*这是斜体文本*
**这是粗体文本**
***这是粗体斜体文本***

标题层级

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

链接和图片

[这是一个链接](https://www.example.com)
![这是图片描述](https://example.com/image.jpg)

引用

> 这是一个引用
> 
> 可以有多行

列表

* 无序列表项1
* 无序列表项2
* 无序列表项3

1. 有序列表项1
2. 有序列表项2
3. 有序列表项3

代码

这是`内联代码`的示例

这是代码块 可以包含多行代码

function hello(){
    alert("hello");
}

分割线

---

实用技巧

  • 用标题和列表规划大纲。
  • 用引用块添加注释或补充说明。
  • 常用快捷键：
    • 加粗：Ctrl+B/Cmd+B
    • 斜体：Ctrl+I/Cmd+I
    • 插入链接：Ctrl+K/Cmd+K
  • 导出为其他格式：可用Typora、VS Code、在线工具导出为HTML、PDF等。
  • 不同编辑器对缩进和空格渲染略有差异，建议预览检查。

使用场景

  • 技术文档编写：广泛用于编写API文档、用户手册和技术说明
  • 博客写作：许多博客平台（如GitHub Pages、Hexo）支持Markdown格式
  • 笔记记录：适合用作个人知识管理系统，如Obsidian、Typora等工具
  • 简历制作：可以创建结构清晰、易于转换的简历文档

工具推荐

  • Typora：所见即所得的Markdown编辑器，支持导出多种格式, 新手友好。
  • VS Code：强大的代码编辑器，安装Markdown插件后即可使用，程序员必备。
  • MarkText：开源的Markdown编辑器，界面简洁，支持实时预览。
  • Dillinger：在线工具，无需安装。

练习案例

  • 任务：用Markdown写一篇简单的日记