RunToolz iconRunToolz
Welcome to RunToolz!
Markdown写作文档

Markdown:写一次,到处发布

Markdown是格式化文本的最简单方法,适用于GitHub、Notion和博客。学习标题、列表、链接、代码块等基础语法,掌握高效写作和文档编写技巧。

RunToolz Team2026年1月27日3 min read

你需要写文档。或README。或博客文章。或带格式的Slack消息。

HTML太复杂。Word文档不是到处都能用。纯文本没有格式。

Markdown处在最佳位置。简单的语法,作为纯文本可读,需要时转换为HTML。

基础

# 标题1
## 标题2
### 标题3

**粗体**和*斜体*

- 项目符号
- 另一个要点
  - 嵌套要点

1. 编号列表
2. 第二项

[链接文本](https://example.com)

![图片替代文本](image.jpg)

这就是你需要的大部分。

想亲自试试吗?写Markdown

代码格式化

用反引号的内联代码:console.log('hello')

用三重反引号的代码块:

function hello() {
  return 'world';
}

在开头反引号后指定语言以获得语法高亮。

表格

| 名字  | 角色       |
|-------|------------|
| Alice | 开发者     |
| Bob   | 设计师     |

表格输入很麻烦。大多数编辑器有快捷方式。

引用块

> 这是引用。
> 它可以跨多行。

用于标注、引用或强调重要文本。

为什么Markdown有效

可读源。 即使不渲染,Markdown也容易阅读。**粗体**明显是粗体。

可移植。 GitHub、Notion、Slack、Reddit、无数静态网站生成器。写一次,到处粘贴。

版本控制友好。 它是纯文本。Git diff有意义。合并有效。

面向未来。 没有专有格式。你的内容永远可访问。

风格差异

GitHub Flavored Markdown(GFM)添加复选框、表格和语法高亮。

CommonMark是标准化努力。大多数平台支持它。

有些平台添加额外功能:Obsidian有wiki链接,Notion有数据库。

为了最大可移植性,坚持基本语法。

常见错误

忘记空行。 段落之间需要空行。没有它们,所有东西都挤在一起。

标题后的空格。 #标题不工作。# 标题可以。注意空格。

链接损坏。 缺少https://在某些平台上使链接失败。

没有替代文本的图片。 ![](image.jpg)有效但不可访问。添加描述。

写作技巧

使用标题来组织结构。读者在阅读前先扫描。

保持段落简短。空白有助于可读性。

发布前预览。不同的渲染器处理边缘情况的方式不同。


Markdown消除写作的摩擦。学一次基础,到处使用。简单性就是特性。