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

 轉載請註明出處：http://blog.csdn.net/zhaokaiqiang1992

 

以前一直在使用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編輯器

     http://mahua.jser.me/

     http://maxiang.info/

    第一個是我的開發的，無償使用，很是贊！

    第二個是一個已經發布的產品，能夠免費在線編輯。除此以外，還能夠將內容同步到印象筆記，不過只能試用10天，以後須要79/年，仍是很是不錯的。

 

    3.經常使用語法介紹

      這裏只介紹最經常使用和最多見的功能，若想查看所有的語法，請移步 http://wowubuntu.com/markdown/index.html

（1）標題

    標題使用不一樣數量的"#"來標識是什麼層級，能夠對應於HTML裏面的H1-H6，下面是示例代碼和效果

 

 

    「========」風格的也能夠，可是我不喜歡，趕不上"#"的好用

 

   （2）圖片

    咱們可使用下面的語法，添加一個圖片

    

    詳細敘述以下：
    一個驚歎號 !
    接着一個方括號，裏面放上圖片的替代文字
    接着一個普通括號，裏面放上圖片的網址

 

    下面是一個示例

 

 

    （3）強調

    咱們可使用下面的方式給咱們的文本添增強調的效果

 

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

 

    下面是一個示例：

 

 

 

    （4）代碼

    若是咱們想在文章中添加代碼，咱們有兩種方式

    第一種方式是使用反引號(esc鍵下面的按鈕)將代碼包裹起來

    下面是一個示例代碼

 

 

    第二種方式則是使用製表符或者至少4個空格進行縮進的行

    下面是一個示例代碼

 

 

 

    （5）換行

    若是咱們想把一行文本進行換行，咱們能夠在須要換行的地方輸入至少兩個空格，而後回車便可，注意，若是不回車，是沒有效果的，就像下面這樣

 

 

 

   （6）引用

   若是咱們在文章中引用了資料，那麼咱們能夠經過一個右尖括號">"來表示這是一段引用內容。咱們能夠在開頭加一個，也能夠在每一行的前面都加一個。咱們還能夠在引用裏面嵌套其餘的引用，下面是一個示例：

 

 

 

（7）連接

    若是咱們文章中加入一個連接，那麼咱們經過下面的方式添加

[連接文字](連接地址)
例子： [Markdown](http://blog.csdn.net/zhaokaiqiang1992)

 

 

 

    （8）分割線

    若是咱們想用分割線對內容進行分割，咱們能夠在單獨一行裏輸入3個或以上的短橫線、星號或者下劃線實現。短橫線和星號之間能夠輸入任意空格。如下每一行都產生一條水平分割線。

 

 

 

    （9）列表標記

    若是咱們的內容須要進行標記，那麼咱們可使用下面的方式

 

 

 

    好了，這些東西徹底夠用了，休息，休息一下...