寫在前面
最近沒怎麼寫東西,精力全放在GTA5上面了。玩過頭了,面壁思過...不過Android還在繼續做的,周末再總結點東西出來。因為在弄github,要往readme裡面寫東西,發現是.md的格式,原來是要用markdown來寫,索性看了看md的文法,發現蠻簡單的,加上本來就會寫html,是以了解起來很快,網上看了一點資料,就總結一下吧。我在ubuntu下使用的編輯器叫 haroopad,感覺不錯。。這個也是我第一次用md寫部落格,排版渣就湊合看看吧。。另外上面的目錄是js提的,下面的目錄是md的。最後如果有錯誤的話給我指明一下,謝謝了。
目錄
輸入[TOC] 就能獲得目錄
特殊字元自動轉換
HTML中,© 可以寫成©也可以直接輸 ©
HTML中 < 和 & 都要轉碼 但markdown不必,輸入& 和 & 都顯示 &,< 也一樣
4 < 5 輸
4<5 輸字元碼<不用考慮這個問題
段落和換行
一個 Markdown 段落的前後要有一個以上的空行。普通段落不該用空格或制表符來縮進。如果想在段前加縮進 是一個中文字元 是半個中文字元 是1/4中文字元
标題有兩種形式
1.用=或者-表示兩階标題,符号數量建議3個以上,緊挨着顯示的标題下一行輸入
第一階标題
=======
第二階标題顯示效果有下劃線
---
效果:
第一階标題
第二階标題顯示效果有下劃線
2.開頭用#的數量表示1-6階的标題,結尾可以以任意數量#結尾(包括0個)
H1#####
H2有下劃線
H3
H4
H5
H6
#######H7 超過6個#就是這個樣子
區塊引用
在每行前面使用> 或者隻在段落中第一行前加>
This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
id sem consectetuer libero luctus adipiscing.
區塊引用也可以嵌套,在嵌套的地方加多個>>就好
這裡空行可以不加 > 隻要前後段落沒有其他不加>的段落就不影響效果,自己可以試試
資料結構
樹
二叉樹
平衡二叉樹
滿二叉樹
引用的區塊内也可以使用其他的 Markdown 文法,包括标題、清單、代碼區塊等:
這是一個标題。
這是第一行清單項。
這是第二行清單項。
給出一些例子代碼:
return shell_exec("echo $input | $markdown_script");
清單
支援有序清單和無序清單,就是清單項前面是數字還是點
無序可用 * + - 顯示都是點
比如輸入
* Red
+ Green
- Blue
顯示為
Red
Green
Blue
有序用數字加英文. 數字是幾無所謂的 生成的html代碼是一樣的
建議第一個項目最好還是從 1. 開始,因為 Markdown 未來可能會支援有序清單的 start 屬性。
Red
Green
Blue
清單項目标記通常是放在最左邊,但是其實也可以縮進,最多 3 個空格,項目标記後面則一定要接着至少一個空格或制表符。每一項換行後前面不對齊也沒關系,産生的效果還是好的
* Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi,
viverra nec, fringilla in, laoreet vitae, risus.
* Donec sit amet nisl. Aliquam semper ipsum sit amet velit.
Suspendisse id sem consectetuer libero luctus adipiscing.
如果清單項之間用空格隔開,輸出html會給每一項加
标簽
一個清單項也可以包含多個段落 每一項下的段落都必須縮進4個空格或者一個制表符
This is a list item with two paragraphs. Lorem ipsum dolor
sit amet, consectetuer adipiscing elit. Aliquam hendrerit
mi posuere lectus.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet
vitae, risus. Donec sit amet nisl. Aliquam semper ipsum
sit amet velit.
Suspendisse id sem consectetuer libero luctus adipiscing.
如果清單項内的引用需要縮進,在>前面加上縮進,引用就在清單項内顯示
A list item with a blockquote:
This is a blockquote
inside a list item
如果要在list中放代碼,該區塊需要縮進2次 即8個空格或2個tab
a list item with a codeblock
private void fun(int x){
}
代碼區塊
開頭加4個空格或一個tab即可,markdown會在生成的html代碼包上 pre code 标簽
這是代碼區塊
一個代碼區塊會一直持續到沒有縮進的那一行(或是檔案結尾)。
© 2004 Foo Corporation
代碼區塊中的 & 和 < > 符号會自動轉成html應該顯示的代碼,輸 & 就會轉換成 &,顯示為 & ,也就是輸什麼顯示什麼。
代碼區塊中 markdown 文法不會轉換,比如
* Red
+ Green
- Blue
分割線
可以在一行用3個以上的 *,-,_來建立一條分割線,行内除了空格不能有其他東西,當然三條線效果是不同的,按順序是很明顯,不明顯,一般。第二種不仔細看真看不到有線,我是換了暗色主題才看清。
連結
連結文字都是用 [方括号] 來标記。分為兩種方式:(我直接用如何呢)
行内式
隻要在方塊括号後面緊接着圓括号并插入網址連結即可,如果你還想要加上連結的 title 文字,隻要在網址後面,用雙引号把 title 文字包起來即可,如:
This is an example inline link with title.
This link has no title.
2.參考式
是在連結文字的括号後面再接上另一個方括号,而在第二個方括号裡面要填入用以辨識連結的标記,兩個括号間可以最多加上一個空格:
This is [an example] id reference-style link.
接着,在檔案的任意處,你可以把這個标記的連結内容定義出來:
[id]: http://www.cnblogs.com/rossoneri/ "我的部落格園"
連結内容定義的形式為:
方括号(前面可以選擇性地加上至多三個空格來縮進),裡面輸傳入連結接文字
接着一個冒号
接着一個以上的空格或制表符
接着連結的網址
選擇性地接着 title 内容,可以用單引号、雙引号或是括弧包着
下面這三種連結的定義都是相同的:
[foo]: http://example.com/ "Optional Title Here"
[foo]: http://example.com/ 'Optional Title Here'
[foo]: http://example.com/ (Optional Title Here)
請注意:有一個已知的問題是 Markdown.pl 1.0.1 會忽略單引号包起來的連結 title。
連結網址也可以用尖括号包起來,其中title屬性可以換行:
id: http://example.com/ "Optional Title Here"
隐式連結标記功能讓你可以省略指定連結标記,這種情形下,連結标記會視為等同于連結文字,要用隐式連結标記隻要在連結文字後面加上一個空的方括号.
如果你要讓 "Google" 連結到 google.com,你可以簡化成:[Google co.][]
然後定義連結内容:[Google co.]: http://google.com/
效果如下:
[Google co.][]
[Google co.]: http://google.com/
下面列出三種寫法,推薦參考式,連結放在段落最後寫起來會比較清晰。
參考式1
I get 10 times more traffic from [Google] [1] than from [Yahoo] [2] or [MSN] [3].
[1]: http://google.com/ "Google"
[2]: http://search.yahoo.com/ "Yahoo Search"
[3]: http://search.msn.com/ "MSN Search"
參考式2
get 10 times more traffic from [Google][] than from [Yahoo][] or [MSN][].
[google]: http://google.com/ "Google"
[yahoo]: http://search.yahoo.com/ "Yahoo Search"
[msn]: http://search.msn.com/ "MSN Search"
行内式
I get 10 times more traffic from [Google (http://google.com/ "Google") than from [Yahoo](http://search.yahoo.com/ "Yahoo Search") or [MSN](http://search.msn.com/ "MSN Search").
效果:
I get 10 times more traffic from [Google] 1 than from [Yahoo] 2 or [MSN] 3.
強調
兩端各用一個 *或者 _包起來是斜體,各用兩個包起來是粗體:
single asterisks
single underscores
double asterisks
double underscores
如果符号兩邊都是空白,沒有緊貼着文字,将會當普通符号。
如果就是要輸出符号則要反斜杠\* 或者 \_
删除線
文本兩端加上兩個~~即可
删除我
代碼
要标記一小段行内代碼,用反引号包起來 Use theprintf()` function.
如果要在代碼區段内插入反引号,你可以用多個反引号來開啟和結束代碼區段
像這樣輸入 ``There is a literal backtick (`) here.``
效果為 There is a literal backtick (`) here.
代碼區段起始前和結束後都可以放一個空格,友善代碼段隔開
比如可以輸入 `` `foo` ``
就顯示為 `foo`
代碼内可以直接放入 < > & 符号
另外還可以設定代碼高亮,根據代碼類型來選擇,輸入格式為:
```java (type)
code here
```
幾種代碼效果如下:
public static void main(String[]args){} //Java
int main(int argc, char *argv[]) //C
echo "hello GitHub"#Bash
document.getElementById("myH1").innerHTML="Welcome to my Homepage"; //javascipt
string &operator+(const string& A,const string& B) //cpp
圖檔
也分為行内式和連結式
行内式格式:! + [替代圖檔的文字,可空] + (路徑 title)
連結式格式:! + [替代圖檔的文字,可空] + [id]
[id]: 路徑 title
反斜杠
反斜杠可以輸出顯示一些符号,支援的有
\ 反斜線
` 反引号
* 星号
_ 底線
{} 花括号
[] 方括号
() 括弧
# 井字号
+ 加号
- 減号
. 英文句點
! 驚歎号
表格
表頭1 | 表頭2
------------- | -------------
Content Cell | Content Cell
Content Cell | Content Cell
| 表頭1 | 表頭2|
| ------------- | ------------- |
| Content Cell | Content Cell |
| Content Cell | Content Cell |
| 名字 | 描述 |
| ------------- | ----------- |
| Help | Display the help window.|
| Close | Closes a window |
表格中也可以使用普通文本的删除線,斜體等效果
| 名字 | 描述 |
| ------------- | ----------- |
| Help | ~~Display the~~ help window.|
| Close | _Closes_ a window |
表格可以指定對齊方式
| 左對齊 | 居中 | 右對齊 |
| :------------ |:---------------:| -----:|
| col 3 is | some wordy text | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |
效果:
github 特有的特性
複選框清單
在清單符号後面加上[]或者[x]代表選中或者未選中情況
[x] C
[x] C++
[x] Java
[x] Qt
[x] Android
[ ] C#
[ ] .NET
效果如圖:
emoji表情
Github的Markdown文法支援添加emoji表情,輸入不同的符号碼(兩個冒号包圍的字元)可以顯示出不同的表情。
比如:blush:,可以顯示
。
有待補充
其實在haroopad左側有一個 Quick Markdown 的選項,裡面還有不少沒用過的指令,看名字大概能猜出意思,這個往後慢慢研究再補充吧。
參考