標籤:

markdown——文檔神器

2015年才開始接觸MD,當時看著一小兄弟使用Mou行雲流水般的寫著介面文檔,我愣了半天。後來,我也嘗試使用之,漸漸地,離不開了,會議紀要、筆記、文檔都必用MD。MD實在是太簡潔,幾乎無學習成本,能大幅提升寫作效率。但目前仍有一些網站未作好適配,實在可惜,比如知乎專欄、wiki、微信公眾號等tffu。

MD 簡介

  • Markdown 是一種輕量級標記語言,它允許人們使用易讀易寫的純文本格式編寫文檔,然後轉換成格式豐富的HTML頁面。 —— 維基百科
  • 由約翰·格魯伯 及亞倫·斯沃茨 於2004年發明,制定了標準語法
  • Markdown 的特點

    • 易讀、直觀、極簡
    • 專註內容而非排版樣式
    • 輕鬆的導出 HTML、PDF 和本身的 .md 文件

      由於這些優點,md已被作家、博客愛好者、程序員等各類人群廣泛使用及推廣。

  • 工具及應用
    • Mou for mac、sublime text、 MarkdownPad for win
    • github 、 簡書
    • 拓展

MD 語法的簡要規則

  1. 標題(#)

    • 代碼

      # 一級標題n ## 二級標題n ### 三級標題n #### 四級標題n ##### 五級標題n ###### 六級標題n ###### 七級標題n

    • 效果
      • 一級標題

      • 二級標題

      • 三級標題

      • 四級標題

      • 五級標題
      • 六級標題
      • 七級標題
  2. 列表

    • 無序列表(*、-或+ )

      代碼

      * 第一行n * 第二行n * 第三行n

      效果

      • 第一行
      • 第二行
      • 第三行
    • 有序列表 (行如1. 2. 3. )

      代碼

      1. 第一行n 2. 第二行n 3. 第三行n

      效果

      1. 第一行
      2. 第二行
      3. 第三行
  3. 區塊引用(> )

    • 引用

      引用只需要在被引用的內容段落開頭加上右尖括弧(>)即可。你可以選擇只在開頭加一個。也可以在每行前面都加一個,效果是一樣的。

    • 嵌套引用

      代碼

      > markdown真好用,好自為知n >> 二級引用n >>> 三級引用 n >> n >> 知難而退(前面需要一個視覺上的空行表示內層嵌套的結束,空行前面的>可以有可以沒有)n > n > 退一步,海闊天空n

      效果

      markdown真好用,好自為知

      二級引用

      三級引用

      知難而退 (前面需要一個視覺上的空行表示內層嵌套的結束,空行前面的>可以有可以沒有)

      退一步,海闊天空

  4. 分割線

    分割線可以由* - _(星號,減號,底線)這3個符號的至少3個符號表示,注意至少要3個,不需要連續

    華麗的分割線*

    華麗的分割線---

    華麗的分割線_

  5. 鏈接及圖片

    支持兩種鏈接方式:行內式和參數式,不管是哪一種,鏈接文字都是用 [方括弧] 來標記。

    • 行內式

      代碼

      * [百度](www.baidu.com)是個什麼網站n* 圖片 ![photo](http://www.ccarting.com/img/opus/photograph/h000/h41/img201008181910520.jpg "Optional title")n

      效果

      • 百度是個什麼網站
      • 圖片

      • 參數式

      代碼

      * [百度] [1] 是個什麼網站n * 圖片 ![photo] [2] n * [1]: http://www.baidu.com n * [2]: http://www.ccarting.com/img/opus/photograph/h000/h41/img201008181910520.jpg "Optional title"n

      效果同行內式

  6. 代碼框

    • 如果代碼量比較少,只有單行的話,可以用單反引號包起來``

      代碼

      ` public static void main(String args[]){}`n

      效果

      public static void main(String args[]){}

    • 多行可以用兩個 ``` 包夾

      代碼

      ``` n import java.lang.String;n public class Fuck(){n public static void main(String args[]){n System.out.println("xxxxxxx")n }n }n ```n

      效果

      import java.lang.String;nn public class Fuck(){n public static void main(String args[]){n System.out.println("xxxxxxx")n }n }n

  7. 強調突出

    Markdown 使用星號()和底線(_)作為標記強調字詞的符號,被 包圍的字詞會被轉成用 標籤包圍,用兩個 * 或 包起來的話,則會被轉成 。

    另外md兼容HTML語言,因此顏色、字體、大小都可用<font/> 標籤來控制

    代碼

    <font color=red size=3 face="黑體">n - 斜體 —— *是不是斜了* _是不是斜了_n - 加粗 —— **是不是粗了** __是不是粗了__n - 刪除線 —— ~~求刪除~~n </font>n

    效果

  8. 換行

    在文本中輸入的換行會從最終生成的結果中刪除,瀏覽器會根據可用空間自動換行。如果想強迫換行,可以在行尾插入至少兩個空格。

  9. 表格

    有多種表達方式,下面是我最常用的一種,很簡練

    代碼

    姓名|年齡|性別n -|-|-n 張三|4|男n 李四|5|女n

    效果

推薦閱讀:

前端的學習之路-markdown語法
Markdown 語法說明 (簡體中文版)
Stata連享會:Markdown 筆記

TAG:Markdown语法 |