GitHub 上README.md語法
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
有序列表則使用數字接著一個英文句點:
- Bird
- McHale
- Parish
很重要的一點是,你在列表標記上使用的數字並不會影響輸出的 HTML 結果,上面的列表所產生的 HTML 標記為:
- Bird
- McHale
- Parish
如果你的列表標記寫成:
- Bird
- McHale
Parish
或甚至是:Bird
- McHale
- Parish
程式碼區塊
和程式相關的寫作或是標籤語言原始碼通常會有已經排版好的程式碼區塊,通常這些區塊我們並不希望它以一般段落檔案的方式去排版,而是照原來的樣子顯示,Markdown 會用
和 標籤來把程式碼區塊包起來。
要在 Markdown 中建立程式碼區塊很簡單,只要簡單地縮排 4 個空格或是 1 個製表符就可以,例如,下面的輸入:
這是一個普通段落:
這是一個程式碼區塊。
Markdown 會轉換成:
這是一個普通段落:
這是一個程式碼區塊。
分隔線
你可以在一行中用三個以上的星號、減號、底線來建立一個分隔線,行內不能有其他東西。你也可以在星號或是減號中間插入空格。下面每種寫法都可以建立分隔線:
圖片
很明顯地,要在純文字應用中設計一個「自然」的語法來插入圖片是有一定難度的。
Markdown 使用一種和連結很相似的語法來標記圖片,同樣也允許兩種樣式: 行內式和參考式。
行內式的圖片語法看起來像是:
一個驚歎號 !
接著一個方括號,裡面放上圖片的替代文字
接著一個普通括號,裡面放上圖片的網址,最後還可以用引號包住並加上 選擇性的 ‘title’ 文字。
參考式的圖片語法則長得像這樣:
id是圖片參考的名稱,圖片參考的定義方式則和連結參考一樣:
到目前為止, Markdown 還沒有辦法指定圖片的寬高,如果你需要的話,你可以使用普通的 標籤。
=============================================================================
指令碼如下圖:
效果如下圖:
指令碼內容如下:
[html] view plain copy
alarmclock
alarmclock
alarmclock
single asterisks
double asterisks
tripple asterisks
這是一個普通段落:
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
iniView();
}