markdown 语法和工具

markdown 是非常不错的轻量级文本编辑语法， 和 GitHub 都支持。
我们从 七月份 开始使用 markdown 语法编辑接口文档，效果不错。

• why markdown？

语法

• Markdown: Syntax
• Markdown 语法简体中文版
• Writing on GitHub：GitHub 支持的 markdown 语法。
• MultiMarkdown
• Adam Pritchard: Markdown Cheatsheet
• 帮助中心 之 献给写作者的 Markdown 新手指南

links 链接

行内式（inline-style） 和 参考式（reference-style）。
注：在阅读原文时，参考式比较流畅，不会有一堆链接妨碍思考，但在编辑时，因为需要把链接剥离出去单独定义（link definition），所以存在一致性维护问题，注意一下即可。

Links Example

I get 10 times more traffic from 谷歌 than from
Yahoo or MSN.

工具

• sublime text 3
• Atom
• Mou
• Pandoc
• Markdown 最强最快贴图方法

避免 list 的方法

假如你不想使用列表（有时列表上下空间占有太多），则遇到 number-period-space （数字-点-空格）情况时，使用反斜杠 \ 将 . 转义即可：
1\. What a great season.

删除线（Strikethrough）

使用~~（两个波浪符号 tildes）标记删除线。

~~这句话将标记为删除~~

效果：
这句话将标记为删除

写技术文章的命令语法约定

• 对于互斥的元素用竖线（|）隔开；
• 可选元素用方括号（[]）括起；
• 必不可少的选项用花括号（{}）括起；
• 对于可选元素中必不可少的选项用 [{}] 括起；
• 对于需要逐字输入的命令和关键字，用 粗体 表示。在配置范例和输出（而不是命令语法）中，需要用户手工输入的命令用 粗体 表示；
• 对于你必须提供实际值的参数，用 斜体 表示或者<>括起；

---