markdown 語法和工具

markdown 是非常不錯的輕量級文本編輯語法，簡書 和 GitHub 都支持。
我們從 七月份 開始使用 markdown 語法編輯接口文檔，效果不錯。

語法
links 鏈接

行內式（inline-style） 和 參考式（reference-style）。
注：在閱讀原文時，參考式比較流暢，不會有一堆鏈接妨礙思考，但在編輯時，因為需要把鏈接剝離出去單獨定義（link definition），所以存在一致性維護問題，注意一下即可。

Links Example

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

工具
避免 list 的方法

假如你不想使用列表（有時列表上下空間占有太多），則遇到 number-period-space （數字-點-空格）情況時，使用反斜杠 \ 將 . 轉義即可：
1\. What a great season.

刪除線（Strikethrough）

使用~~（兩個波浪符號 tildes）標記刪除線。

~~這句話將標記為刪除~~

效果：
這句話將標記為刪除

寫技術文章的命令語法約定
  • 對于互斥的元素用豎線（|）隔開；
  • 可選元素用方括號（[]）括起；
  • 必不可少的選項用花括號（{}）括起；
  • 對于可選元素中必不可少的選項用 [{}] 括起；
  • 對于需要逐字輸入的命令和關鍵字，用 粗體 表示。在配置范例和輸出（而不是命令語法）中，需要用戶手工輸入的命令用 粗體 表示；
  • 對于你必須提供實際值的參數，用 斜體 表示或者<>括起；
最后編輯于 ：
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發布，文章內容僅代表作者本人觀點，簡書系信息發布平臺，僅提供信息存儲服務。

推薦閱讀更多精彩內容