原來Github上的README.md文件這麼有意思——Markdown語言詳解

原來Github上的README.md文件這麼有意思——Markdown語言詳解

轉自

http://blog.csdn.net/zhaokaiqiang1992/article/details/41349819


之前一直在使用github,也在上面分享了不少的項目和Demo,每次創建新項目的時候,使用的都是默認的README.md文件,也不曾對這個文件有過什麼瞭解。但是在看到別人寫的項目的README.md裏面竟然有圖片、鏈接什麼的,就感到很好奇,這效果是什麼加上去的?於是便查了一下資料,結果,竟遷出了一門從來沒有了解過的語言— —Markdown!

    github上的README.md文件就是使用的Markdown語言編寫的,我們先簡單介紹下這門語言的來龍去脈,然後再介紹一些基本的語法和使用。


    1.來龍去脈和語法特點

    Markdown 是一種輕量級標記語言,創始人爲約翰·格魯伯(John Gruber)。它允許人們“使用易讀易寫的純文本格式編寫文檔,然後轉換成有效的XHTML(或者HTML)文檔”。這種語言吸收了很多在電子郵件中已有的純文本標記的特性。


   Markdown 的目標是實現「易讀易寫」。可讀性,無論如何,都是最重要的。一份使用 Markdown 格式撰寫的文件應該可以直接以純文本發佈,並且看起來不會像是由許多標籤或是格式指令所構成。Markdown 語法受到一些既有 text-to-HTML 格式的影響,包括Setext、atx、Textile、reStructuredText、Grutatext 和 EtText,而最大靈感來源其實是純文本電子郵件的格式。總之, Markdown 的語法全由一些符號所組成,這些符號經過精挑細選,其作用一目瞭然。比如:在文字兩旁加上星號,看起來就像*強調*。Markdown 的列表看起來,嗯,就是列表。Markdown 的區塊引用看起來就真的像是引用一段文字,就像你曾在電子郵件中見過的那樣。


    Markdown 語法的目標是:成爲一種適用於網絡的書寫語言。Markdown 不是想要取代 HTML,甚至也沒有要和它相近,它的語法種類很少,只對應 HTML 標記的一小部分。Markdown 的構想不是要使得 HTML 文檔更容易書寫。在我看來, HTML 已經很容易寫了。Markdown 的理念是,能讓文檔更容易讀、寫和隨意改。HTML 是一種發佈的格式,Markdown 是一種書寫的格式。就這樣,Markdown 的格式語法只涵蓋純文本可以涵蓋的範圍。


    正是因爲Markdown的這些特點,而且功能比純文本更強,因此有很多人用它寫博客。世界上最流行的博客平臺WordPress和大型CMS如joomla、drupal都能很好的支持Markdown。


          2.編輯軟件

    如果我們要寫Markdown代碼的話,我們首先需要一個編輯器,因爲我使用的是Mac,所以推薦使用Mou,非常的強大,非常的好用。
    下面是Mou的界面,左邊是Markdown代碼,右邊是實時的展示效果,而且可以選擇不同的主題色,非常的漂亮!



    當然,如果你使用的是其他的平臺的話,你可以選擇在線的編輯器,效果也非常棒。
    給出兩個在線的Markdown編輯器
    第一個是個人開發的,免費使用,非常贊!
    第二個是一個已經發布的產品,可以免費在線編輯。除此之外,還可以將內容同步到印象筆記,不過只能試用10天,之後需要79/年,還是非常不錯的。

    3.常用語法介紹

      這裏只介紹最常用和最常見的功能,若想查看全部的語法,請移步http://wowubuntu.com/markdown/index.html
(1)標題
    標題使用不同數量的"#"來標識是什麼層級,可以對應於HTML裏面的H1-H6,下面是示例代碼和效果



    “========”風格的也可以,但是我不喜歡,趕不上"#"的好用

   (2)圖片
    我們可以使用下面的語法,添加一個圖片
    ![Alt text](/path/to/img.jpg)
    詳細敘述如下:
    一個驚歎號 !
    接着一個方括號,裏面放上圖片的替代文字
    接着一個普通括號,裏面放上圖片的網址

    下面是一個示例



    (3)強調
    我們可以使用下面的方式給我們的文本添加強調的效果

*強調* 或者 _強調_  (示例:斜體)
**加重強調** 或者 __加重強調__ (示例:粗體)
***特別強調*** 或者 ___特別強調___ (示例:粗斜體)

    下面是一個示例:




    (4)代碼
    如果我們想在文章中添加代碼,我們有兩種方式
    第一種方式是使用反引號(esc鍵下面的按鈕)將代碼包裹起來
    下面是一個示例代碼



    第二種方式則是使用製表符或者至少4個空格進行縮進的行
    下面是一個示例代碼




    (5)換行
    如果我們想把一行文本進行換行,我們可以在需要換行的地方輸入至少兩個空格,然後回車即可,注意,如果不回車,是沒有效果的,就像下面這樣




   (6)引用
   如果我們在文章中引用了資料,那麼我們可以通過一個右尖括號">"來表示這是一段引用內容。我們可以在開頭加一個,也可以在每一行的前面都加一個。我們還可以在引用裏面嵌套其他的引用,下面是一個示例:




(7)鏈接
    如果我們文章中加入一個鏈接,那麼我們通過下面的方式添加
[鏈接文字](鏈接地址)
例子: [Markdown](http://blog.csdn.net/zhaokaiqiang1992)





    (8)分割線
    如果我們想用分割線對內容進行分割,我們可以在單獨一行裏輸入3個或以上的短橫線、星號或者下劃線實現。短橫線和星號之間可以輸入任意空格。以下每一行都產生一條水平分割線。




    (9)列表標記
    如果我們的內容需要進行標記,那麼我們可以使用下面的方式




    Over.
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章