Markdown 是一种纯文本标记方式。它使用容易阅读的符号表示标题、列表、链接和代码等结构，再由编辑器或网站转换成排版后的内容。纯文本便于搜索、比较修改，也不依赖某一种特定的文档软件。
先用层级组织信息
标题前的 # 数量表示层级。一个文档通常只有一个一级标题，下面按内容关系使用二级和三级标题。层级应该连续，不要仅仅为了字号大小从二级标题跳到四级标题。
# 文档标题
## 安装步骤
### 环境检查
## 常见问题段落之间留一个空行。无序列表使用 -，有顺序的操作使用数字列表。结构统一之后，读者只看标题就能了解文档的大致范围。
正确区分代码与说明
行内出现的命令、变量名或文件名，可以用一对反引号包围。多行代码则使用围栏代码块，并在开头标注语言名称；支持语法高亮的渲染工具会据此显示代码。
```javascript
const message = "hello";
console.log(message);
```代码块应保持可复制，并说明运行所需的前提。命令提示符、行号和解释文字最好不要混进需要直接执行的代码中。
让链接说明去向
链接的基本写法是 [说明文字](地址)。说明文字应表达目标内容，避免大量使用“点击这里”。图片语法在链接前增加感叹号，并需要提供能够说明图片内容的替代文字。技术文档如果不依赖图片，也可以优先使用文字、表格或代码示例。
语法之外更重要的原则
- 开头说明文档解决的问题和适用范围；
- 操作步骤按实际执行顺序编排，并写清必要条件；
- 一个术语尽量使用同一种称呼；
- 结论与示例相邻，避免读者来回寻找；
- 引用外部资料时标明来源，不把他人的表达当作自己的结论。
不同 Markdown 工具可能支持不同的扩展语法。需要跨平台使用时，优先选择标题、段落、列表、链接和代码块等通用写法。
好的技术文档并不取决于使用多少语法。Markdown 只是帮助表达结构，真正重要的是问题明确、顺序合理、示例可以验证，并且读者知道下一步该做什么。