Markdown文法學習（Github/git.oschina.net上README.md書寫規範）

標籤：prot   比較   決定   參考   net   分隔線   fill   手冊   activity   

晚上在更新git.oschina.net項目時，突然想知道README.md尾碼的來源，於是搜了下，發現README.md使用了一種小標記語言Markdown的文法，於是簡單的看了一個，特轉載如下，為了下次參考方便（http://blog.csdn.net/kaitiren/article/details/38513715也不錯）。中文參考手冊可以參考http://wowubuntu.com/markdown/index.html

Markdown 的目標是實現「易讀易寫」，相容HTML。

但是，在 HTML 區塊標籤間的 Markdown 格式文法將不會被處理。比如，你在 HTML 區塊內使用 Markdown 樣式的*強調*會沒有效果。也就是說，Markdown 與HTML標籤不能嵌套使用

 

 

標題

 

Markdown 支援兩種標題的文法，類 Setext 和類 atx 形式。

類 Setext 形式是用底線的形式，利用 = （最高階標題）和 - （第二階標題），例如：

This is an H1=============This is an H2-------------

任何數量的 = 和 - 都可以有效果。

類 Atx 形式則是在行首插入 1 到 6 個 # ，對應到標題 1 到 6 階，例如：

# 這是 H1## 這是 H2###### 這是 H6

你可以選擇性地「閉合」類 atx 樣式的標題，這純粹只是美觀用的，若是覺得這樣看起來比較舒適，你就可以在行尾加上 #，而行尾的# 數量也不用和開頭一樣（行首的井字元數量決定標題的階數）：

# 這是 H1 ### 這是 H2 ##### 這是 H3 ######

 

 

 

列表

 

Markdown 支援有序列表和無序列表。

無序列表使用星號、加號或是減號作為列表標記：

*   Red*   Green*   Blue

等同於：

+   Red+   Green+   Blue

也等同於：

-   Red-   Green-   Blue

有序列表則使用數字接著一個英文句點：

1.  Bird2.  McHale3.  Parish

很重要的一點是，你在列表標記上使用的數字並不會影響輸出的 HTML 結果，上面的列表所產生的 HTML 標籤為：

<ol><li>Bird</li><li>McHale</li><li>Parish</li></ol>

如果你的列表標記寫成：

1.  Bird1.  McHale1.  Parish

或甚至是：

3. Bird1. McHale8. Parish

 

 

 

代碼區塊

 

和程式相關的寫作或是標籤語言原始碼通常會有已經排版好的代碼區塊，通常這些區塊我們並不希望它以一般段落檔案的方式去排版，而是照原來的樣子顯示，Markdown 會用 <pre> 和 <code> 標籤來把代碼區塊包起來。

要在 Markdown 中建立代碼區塊很簡單，只要簡單地縮排 4 個空格或是 1 個定位字元就可以，例如，下面的輸入：

這是一個普通段落：    這是一個代碼區塊。

Markdown 會轉換成：

<p>這是一個普通段落：</p><pre><code>這是一個代碼區塊。</code></pre>

 

 

 

分隔線

 

你可以在一行中用三個以上的星號、減號、底線來建立一個分隔線，行內不能有其他東西。你也可以在星號或是減號中間插入空格。下面每種寫法都可以建立分隔線：

* * *********- - ----------------------------------------

 

 

 

圖片

 

很明顯地，要在純文字應用中設計一個「自然」的文法來插入圖片是有一定難度的。

Markdown 使用一種和連結很相似的文法來標記圖片，同樣也允許兩種樣式： 行內式和參考式。

行內式的圖片文法看起來像是：

![Alt text](/path/to/img.jpg)![Alt text](/path/to/img.jpg "Optional title")

• 一個驚歎號 !
• 接著一個方括弧，裡面放片的替代文字
• 接著一個普通括弧，裡面放片的網址，最後還可以用引號包住並加上 選擇性的 ‘title‘ 文字。

參考式的圖片文法則長得像這樣：

![Alt text][id][id]是圖片參考的名稱，圖片參考的定義方式則和連結參考一樣：

[id]: url/to/image  "Optional title attribute"

到目前為止， Markdown 還沒有辦法指定圖片的寬高，如果你需要的話，你可以使用普通的 <img> 標籤。

=============================================================================指令碼如：  效果如：   指令碼內容如下： [html] view plain copy 

1. alarmclock  
2. ==  
3. alarmclock  
4. -  
5. alarmclock  
6.   
7. *single asterisks*  
8.   
9. **double asterisks**  
10.   
11. ***tripple asterisks***  
12.   
13. - - -  
14. * * *  
15.   
16. 這是一個普通段落：  
17.   
18. protected void onCreate(Bundle savedInstanceState) {  
19. super.onCreate(savedInstanceState);  
20. setContentView(R.layout.activity_main);  
21. iniView();   
22. }  
23.   
24.   

Markdown文法學習（Github/git.oschina.net上README.md書寫規範）（轉）