Markdown編寫github README.md

Markdown編寫github README.md

1、在線編輯器StackEdit

Markdown在線編輯器地址
中文：https://www.zybuluo.com/mdeditor
英文：https://stackedit.io/

今天推薦一款web應用StackEdit，體驗一流，功能強大。

進入後就是編輯界面，和通常的markdown相同，左邊是MD代碼，右側是渲染後的文檔預覽。

貌似沒神馬特色嘛~markdown編輯器就是這樣啦，基本功能上都同樣，支持拼寫檢查，排版風格簡潔美觀。網站提供4種主題，都挺抗疲勞的。

特點功能1：豐富的導出和同步功能
==============================

點擊頂部左側的按鈕，會彈出來一個菜單，裏面有兩組選項：同步和發佈。

同步是指將當前文檔與Google Docs或Dropbox中的文檔同步，這樣在StackEdit中的任何改動就都會同步到第三方網站。

發佈是單純地導出，提供的選項不少，除了常見的Dropbox、Blogger，還支持Github或SSH。

特點功能2：支持自定義導出模版
==============================
StackEdit能夠導出HTML和PDF格式的文檔，這兩種文檔的格式是能夠由用戶自定義的。打開Setting裏面的Services便可找到。

特點功能3：便捷的瀏覽工具
==============================
在瀏覽界面，StackEdit也提供了十分人性化的工具。

Markdown syntax是介紹markdown基本語法的界面。

Table of contents是根據標籤提取出來的文檔目錄

Statistics是當前文檔的統計數據

HTML code是當前文檔渲染後額html代碼

來源：http://www.guokr.com/post/544861/

2、基本語法

Markdown語法

Markdown 語法速查表
1 標題與文字格式
標題
# 這是 H1 <一級標題>
## 這是 H2 <二級標題>
###### 這是 H6 <六級標題>
文字格式
**這是文字粗體格式**
*這是文字斜體格式*
~~在文字上添加刪除線~~
2 列表
無序列表
* 項目1
* 項目2
* 項目3
有序列表
1. 項目1
2. 項目2
3. 項目3
   * 項目1
   * 項目2
3 其它
圖片
![圖片名稱](http://gitcafe.com/image.png)
連接
[連接名稱](http://gitcafe.com)
引用
> 第一行引用文字
> 第二行引用文字
水平線
***
代碼
`<hello world>`
代碼塊高亮
「`ruby
  def add(a, b)
    return a + b
  end
「`
表格
  表頭  | 表頭
  ————- | ————-
 單元格內容  | 單元格內容
 單元格內容l  | 單元格內容

大標題
===================================
  大標題通常顯示工程名,相似html的\<h1\><br />
  你只要在標題下面跟上=====便可

  
中標題
-----------------------------------
  中標題通常顯示重點項,相似html的\<h2\><br />
  你只要在標題下面輸入------便可
  
### 小標題
  小標題相似html的\<h3\><br />
  小標題的格式以下 ### 小標題<br />
  注意#和標題字符中間要有空格

### 注意!!!下面全部語法的提示我都先用小標題提醒了!!! 

### 單行文本框
    這是一個單行的文本框,只要兩個Tab再輸入文字便可
        
### 多行文本框  
    這是一個有多行的文本框
    你能夠寫入代碼等,每行文字只要輸入兩個Tab再輸入文字便可
    這裏你能夠輸入一段代碼

### 好比咱們能夠在多行文本框裏輸入一段代碼,來一個Java版本的HelloWorld吧
    public class HelloWorld {

      /**
      * @param args
   */
   public static void main(String[] args) {
   System.out.println("HelloWorld!");

   }

    }
### 連接
1.[點擊這裏你能夠連接到www.google.com](http://www.google.com)<br />
2.[點擊這裏我你能夠連接到個人博客](http://guoyunsky.iteye.com)<br />

###只是顯示圖片
![github](http://github.com/unicorn.png "github")

###想點擊某個圖片進入一個網頁,好比我想點擊github的icorn而後再進入www.github.com
[![image]](http://www.github.com/)
[image]: http://github.com/github.png "github"

### 文字被些字符包圍
> 文字被些字符包圍
>
> 只要再文字前面加上>空格便可
>
> 若是你要換行的話,新起一行,輸入>空格便可,後面不接文字
> 但> 只能放在行首纔有效

### 文字被些字符包圍,多重包圍
> 文字被些字符包圍開始
>
> > 只要再文字前面加上>空格便可
>
>  > > 若是你要換行的話,新起一行,輸入>空格便可,後面不接文字
>
> > > > 但> 只能放在行首纔有效

### 特殊字符處理
有一些特殊字符如<,#等,只要在特殊字符前面加上轉義字符\便可<br />
你想換行的話其實能夠直接用html標籤\<br /\>

來源： http://guoyunsky.iteye.com/blog/1781885