跳到主要内容

1 篇博文 含有标签「markdown」

查看所有标签

· 阅读需 4 分钟
Hanbin Che

什么是 Markdown?

Markdown 是一种简单的文本格式化方式,在任何设备上都能呈现出色的效果。它不会 做任何花哨的事情,比如改变字体大小、颜色或类型——只是使用你已经知道的键盘符号来处 理基本格式。

基础语法

类型或者效果
*斜体*_斜体_斜体
**粗体**__粗体__粗体
# 一级标题一级标题
=========
# 一级标题
## 二级标题二级标题
---------
## 二级标题
[链接](http://a.com)[链接][1]

[1]: http://b.org
链接
![图片](http://url/a.png)![图片][1]

[1]: http://url/b.jpg
图片
> 引用块
引用块
* 列表
* 列表
* 列表
- 列表
- 列表
- 列表
• 列表
• 列表
• 列表
1. 第一项
2. 第二项
3. 第三项
1) 第一项
2) 第二项
3) 第三项
1. 第一项
2. 第二项
3. 第三项
水平分割线:
---
水平分割线:
***
水平分割线:

`内联代码` 使用反引号内联代码 使用反引号
<br />```<br /># 代码块<br />print '3个反引号或'<br />print '缩进4个空格'<br />```<br />····# 代码块
····print '3个反引号或'
····print '缩进4个空格'
<br /># 代码块<br />print '3个反引号或'<br />print '缩进4个空格'<br />

扩展语法

表格

| 左对齐 | 居中对齐 | 右对齐 |
| :----- | :------: | -----: |
| 内容 | 内容 | 内容 |
| 内容 | 内容 | 内容 |

效果:

左对齐居中对齐右对齐
内容内容内容
内容内容内容

删除线

~~删除的文本~~

效果:删除的文本

任务列表

- [x] 已完成的任务
- [ ] 未完成的任务
- [ ] 另一个未完成的任务

效果:

  • 已完成的任务
  • 未完成的任务
  • 另一个未完成的任务

脚注

这是一个带脚注的文本[^1]。

[^1]: 这是脚注的内容。

转义字符

如果你想显示 Markdown 语法字符本身,可以使用反斜杠进行转义:

\*这不是斜体\* \# 这不是标题 \[这不是链接\]

常需要转义的字符:

  • \ 反斜杠
  • ` 反引号
  • * 星号
  • _ 下划线
  • {} 大括号
  • [] 方括号
  • () 圆括号
  • # 井号
  • + 加号
  • - 减号
  • . 点号
  • ! 感叹号

最佳实践

1. 标题层级

  • 每个文档只使用一个一级标题
  • 不要跳过标题层级(如从 # 直接跳到 ###)
  • 标题前后留空行

2. 列表格式

  • 列表项前后保持一致的缩进
  • 列表前后留空行
  • 嵌套列表使用适当的缩进

3. 代码块

  • 为代码块指定语言以获得语法高亮
  • 长代码块考虑分割或添加注释

4. 链接

  • 使用描述性的链接文本
  • 对于重复使用的链接,考虑使用引用式链接

5. 图片

  • 始终提供有意义的替代文本
  • 考虑图片的加载性能

工具推荐

在线编辑器

桌面编辑器

浏览器扩展

  • Markdown Here(Chrome/Firefox)
  • Markdown Editor(Chrome)

学习资源

总结

Markdown 是一种简单而强大的标记语言,它让你能够:

  1. 快速格式化文本 - 使用简单的符号
  2. 保持内容专注 - 不被复杂的格式分散注意力
  3. 跨平台兼容 - 在任何支持 Markdown 的平台上都能正确显示
  4. 易于学习 - 语法简单直观
  5. 广泛支持 - 被众多平台和工具支持

开始使用 Markdown,让你的文档写作更加高效和专业!