markdown——文檔神器


2015年才開始接觸MD,當(dāng)時看著一小兄弟使用Mou行云流水般的寫著接口文檔麦到,我愣了半天虹茶。后來,我也嘗試使用之隅要,漸漸地,離不開了董济,會議紀(jì)要步清、筆記、文檔都必用MD。MD實(shí)在是太簡潔廓啊,大幅提升寫作效率的同時幾乎無學(xué)習(xí)成本欢搜。但目前仍有一些網(wǎng)站未作好適配,實(shí)在可惜谴轮,比如知乎專欄炒瘟、wiki、微信公眾號等第步。

MD 簡介

  • Markdown 是一種輕量級標(biāo)記語言疮装,它允許人們使用易讀易寫的純文本格式編寫文檔,然后轉(zhuǎn)換成格式豐富的HTML頁面粘都。 —— 維基百科

  • 約翰·格魯伯亞倫·斯沃茨 于2004年發(fā)明廓推,制定了標(biāo)準(zhǔn)語法

  • ** Markdown 的特點(diǎn)**

    • 易讀、直觀翩隧、極簡
    • 專注內(nèi)容而非排版樣式
    • 輕松的導(dǎo)出 HTML樊展、PDF 和本身的 .md 文件

    由于這些優(yōu)點(diǎn),md已被作家堆生、博客愛好者专缠、程序員等各類人群廣泛使用及推廣。

  • 工具及應(yīng)用

    • Mou for mac淑仆、sublime text涝婉、 MarkdownPad for win
    • github 、 簡書
    • 拓展

MD 語法的簡要規(guī)則

  1. 標(biāo)題(#)

    • 代碼

      # 一級標(biāo)題
      ## 二級標(biāo)題
      ### 三級標(biāo)題
      #### 四級標(biāo)題
      ##### 五級標(biāo)題
      ###### 六級標(biāo)題
      ###### 七級標(biāo)題
      
      
    • 效果

      • 一級標(biāo)題

      • 二級標(biāo)題

      • 三級標(biāo)題

      • 四級標(biāo)題

      • 五級標(biāo)題
      • 六級標(biāo)題
      • 七級標(biāo)題
  2. 列表

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

      代碼

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

      效果

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

      代碼

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

      效果

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

    • 引用

    引用只需要在被引用的內(nèi)容段落開頭加上右尖括號('>')即可嘁圈。你可以選擇只在開頭加一個。也可以在每行前面都加一個蟀淮,效果是一樣的最住。
    * 嵌套引用

     代碼
     
     ```
     >  markdown真好用,好自為知
     >> 二級引用
     >>> 三級引用    
     >>  
     >> 知難而退(前面需要一個視覺上的空行表示內(nèi)層嵌套的結(jié)束怠惶,空行前面的'>'可以有可以沒有)
     >   
     > 退一步涨缚,海闊天空
     
     ```
     效果
     >  markdown真好用,好自為知
     >> 二級引用
     >>> 三級引用    
     >>  
     >> 知難而退 
     >   
     > 退一步策治,海闊天空
    
  4. 分割線

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

    華麗的分割線***


    華麗的分割線---


    華麗的分割線___


  5. 鏈接及圖片

    支持兩種鏈接方式:行內(nèi)式和參數(shù)式,不管是哪一種履腋,鏈接文字都是用 [方括號] 來標(biāo)記珊燎。

  • 行內(nèi)式

    代碼

    ```
    
    • 百度是個什么網(wǎng)站
    • 圖片
      photo
      photo
      
      

    效果

    • 百度是個什么網(wǎng)站
    • 圖片
      photo
      photo
    • 參數(shù)式

    代碼

    ```
     * [百度] [1] 是個什么網(wǎng)站
     * 圖片 ![photo] [2]         
     * [1]: http://www.baidu.com            
     * [2]:  http://www.ccarting.com/img/opus/photograph/h000/h41/img201008181910520.jpg    "Optional title"
    ```
    

效果同行內(nèi)式

  1. 代碼框

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

      代碼

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

      效果

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

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

      代碼

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

      效果

      import java.lang.String;
      
      public class Fuck(){
          public static void main(String args[]){
              System.out.println("xxxxxxx")
          }
      }
      
  2. 強(qiáng)調(diào)突出

    Markdown 使用星號(*)和底線(_)作為標(biāo)記強(qiáng)調(diào)字詞的符號悔政,被 * 或 _ 包圍的字詞會被轉(zhuǎn)成用 <em> 標(biāo)簽包圍晚吞,用兩個 * 或 _ 包起來的話,則會被轉(zhuǎn)成 <strong>谋国。
    另外md兼容HTML語言槽地,因此顏色、字體芦瘾、大小都可用<font/> 標(biāo)簽來控制

    代碼

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

    效果

    • 斜體 —— 是不是斜了 是不是斜了
    • 加粗 —— 是不是粗了 是不是粗了
    • 刪除線 —— 求刪除
  3. 換行

在文本中輸入的換行會從最終生成的結(jié)果中刪除捌蚊,瀏覽器會根據(jù)可用空間自動換行。如果想強(qiáng)迫換行旅急,可以在行尾插入至少兩個空格逢勾。

  1. 表格

    有多種表達(dá)方式,下面是我最常用的一種藐吮,很簡練

    代碼

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

    效果

姓名 年齡 性別
張三 4
李四 5
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末溺拱,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子谣辞,更是在濱河造成了極大的恐慌迫摔,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,036評論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件泥从,死亡現(xiàn)場離奇詭異句占,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)躯嫉,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,046評論 3 395
  • 文/潘曉璐 我一進(jìn)店門纱烘,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人祈餐,你說我怎么就攤上這事擂啥。” “怎么了帆阳?”我有些...
    開封第一講書人閱讀 164,411評論 0 354
  • 文/不壞的土叔 我叫張陵哺壶,是天一觀的道長。 經(jīng)常有香客問我蜒谤,道長山宾,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,622評論 1 293
  • 正文 為了忘掉前任鳍徽,我火速辦了婚禮资锰,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘阶祭。我一直安慰自己台妆,他們只是感情好翎猛,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,661評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著接剩,像睡著了一般。 火紅的嫁衣襯著肌膚如雪萨咳。 梳的紋絲不亂的頭發(fā)上懊缺,一...
    開封第一講書人閱讀 51,521評論 1 304
  • 那天,我揣著相機(jī)與錄音培他,去河邊找鬼鹃两。 笑死,一個胖子當(dāng)著我的面吹牛舀凛,可吹牛的內(nèi)容都是我干的俊扳。 我是一名探鬼主播,決...
    沈念sama閱讀 40,288評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼猛遍,長吁一口氣:“原來是場噩夢啊……” “哼馋记!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起懊烤,我...
    開封第一講書人閱讀 39,200評論 0 276
  • 序言:老撾萬榮一對情侶失蹤梯醒,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后腌紧,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體茸习,經(jīng)...
    沈念sama閱讀 45,644評論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,837評論 3 336
  • 正文 我和宋清朗相戀三年壁肋,在試婚紗的時候發(fā)現(xiàn)自己被綠了号胚。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,953評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡浸遗,死狀恐怖猫胁,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情乙帮,我是刑警寧澤杜漠,帶...
    沈念sama閱讀 35,673評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站察净,受9級特大地震影響驾茴,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜氢卡,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,281評論 3 329
  • 文/蒙蒙 一锈至、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧译秦,春花似錦峡捡、人聲如沸击碗。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,889評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽稍途。三九已至,卻和暖如春砚婆,著一層夾襖步出監(jiān)牢的瞬間械拍,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,011評論 1 269
  • 我被黑心中介騙來泰國打工装盯, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留坷虑,地道東北人。 一個月前我還...
    沈念sama閱讀 48,119評論 3 370
  • 正文 我出身青樓埂奈,卻偏偏與公主長得像迄损,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子账磺,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,901評論 2 355

推薦閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理芹敌,服務(wù)發(fā)現(xiàn),斷路器绑谣,智...
    卡卡羅2017閱讀 134,656評論 18 139
  • 1. Java基礎(chǔ)部分 基礎(chǔ)部分的順序:基本語法党窜,類相關(guān)的語法,內(nèi)部類的語法借宵,繼承相關(guān)的語法幌衣,異常的語法,線程的語...
    子非魚_t_閱讀 31,631評論 18 399
  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,129評論 25 707
  • 2015.8.9 星期日 陣雨昨天陣雨躲著我偷偷了下了壤玫,中午吃完飯豁护,趕上一小陣兒。它還遮遮...
    北境之風(fēng)閱讀 238評論 0 1
  • 日子還是要繼續(xù)的欲间。每次出操的時候楚里,我們老師會檢查我們女生的頭發(fā),那個時候?qū)W校有好多女同學(xué)都染了虱子猎贴,學(xué)校要求老師一...
    什么樣的幸福閱讀 172評論 0 0