2014年10月26日 星期日

使用Markdown在github上排版README.md

只針對github專案上README.md顯示有效

參考資源:
http://markdown.tw/
https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet

主標題
==========
副標題
--------------

#your word =>H1大小的your word
...
######your word =>H6大小的your word

有序的list => "1. " 數字+點+空白
1. ordered list one
2. ordered list two
...

無順序的list => "* "星號+空白
* list
* list

巢狀list => 用兩個空白縮排,可用有序或無序的list
1. ordered list one
  * nested list
  * nested list
2. ordered list two

斜體 => 一個*星號包住字
*斜體字*

粗體 => 兩個**星號包住字
**粗體字**

粗體斜體混合使用
**粗體字_粗體和斜體字_**

引言
> 一層引言 ("> "一個大於+空白)
> > 兩層引言("> "兩個大於+空白)

分隔線 => 三個*星號
***

超連結 => 直接打網址
http://tw.yahoo.com

刪除線 => 兩個~~引號包住字
~~文字上會有刪除線~~

寫程式碼 => 三個"`"(esc下面那個鍵) 包起來
```perl
use Data::Dumper;
print Dumper $bear;
```

表格 => 直接寫HTML的table(我常試過github table的寫法,但預覽時一直無效)
<table>
    <tr>
        <th>TO_BASE64('abc')</th>
        <th>FROM_BASE64(TO_BASE64('abc'))</th>
    </tr>
    <tr>
        <td>YWJj</td>
        <td>abc</td>
    </tr>
</table>


圖片連結
[Imgur](http://i.imgur.com/your_image.jpg)
註:imgur.com上傳圖片後可以直接選Markdown的圖片語法

沒有留言:

張貼留言