Markdown 語法和寫作 使用說明

Markdown 的設計哲學

Markdown 的目標是實現 易讀易寫.
不過最需要強調的便是它的可讀性. 一份使用 Markdown 格式撰寫的文件應該可以直接以純文字發布,并且看起來不會像是由許多標簽或是格式指令所構成.
Markdown 的語法有個主要的目的:用來作為一種網絡內容的寫作用語.

標題

markdown 語法:

#第一級標題 `<h1>`
#第二級標題`<h2>`
######第六級標題`<h6>`

效果如下:

第一級標題<h1>

第二級標題<h2>

第六級標題<h6>

Markdown 語法:

*這些文字會生成`<em>`*
_這些文字會生成`<u>`_

**這些文字會生成`<strong>`**
__這些文字會生成`<strong>`__

快捷鍵:CMD + U, CMD + I, CMD + B

效果如下
這些文字會生成<em>

這些文字會生成<u>

這些文字會生成<strong>

這些文字會生成<strong>

列表

無序列表

Markdown 語法:

* 項目一 無序列表`* + 空格鍵`
*項目二
* 項目二的子項目已 無序列表 `TAB + * + 空格鍵`
* 項目二的子項目二

效果如下:

  • 項目一 無序列表 * + 空格鍵
  • 項目二
  • 項目二的子項目一 無序列表 TAB + * + 空格鍵
  • 項目二的子項目二

有序列表

Markdown 語法:

1. 項目一 有序列表 `數字 + . + 空格鍵`
2. 項目二 
3. 項目三
1. 項目三的子項目一 有序列表 `TAB + 數字 + . + 空格鍵`
2. 項目三的子項目二

效果如下:

  1. 項目一 有序列表 數字 + . + 空格鍵
  2. 項目二
  3. 項目三
  4. 項目三的子項目一 有序列表 TAB + 數字 + . + 空格鍵
  5. 項目三的子項目二

任務列表(Task lists)

Markdown 語法:

- [ ] 任務一 未做任務 `- + 空格 + [ ]`
- [x] 任務二 已做任務 `- + 空格 + [x]`

效果如下:

  • [ ] 任務一 未做任務 - + 空格 + [ ]
  • [x] 任務二 已做任務 - + 空格 + [x]

圖片

Markdown 語法:

![GitHub set up](http://upload-images.jianshu.io/upload_images/743671-070a4d040ece6277.gif?imageMogr2/auto-orient/strip)
格式: [站外圖片上傳中……(2)]

效果如下:

呵呵

鏈接

Markdown 語法:

email <example@example.com>
[GitHub](http://github.com)
自動生成連接  <http://www.github.com/>

效果如下:

Email 連接: example@example.com
連接標題Github網站
自動生成連接像: http://www.github.com/ 這樣

區塊引用

Markdown 語法:

某某說:
> 第一行引用
> 第二行費用文字

效果如下:

某某說:

第一行引用
第二行費用文字

行內代碼

Markdown 語法:

像這樣即可:`<addr>` `code`

效果如下:

像這樣即可:<addr> code

多行或者一段代碼

Markdown 語法:

```js
function fancyAlert(arg) {
    if(arg) {
    $.facebox({div:'#foo'})
    }

}
```

效果如下:

function fancyAlert(arg) {
    if(arg) {
    $.facebox({div:'#foo'})
    }

}

順序圖或流程圖

Markdown 語法:

```sequence
張三->李四: 嘿,小四兒, 寫博客了沒?
Note right of 李四: 李四愣了一下,說:
李四-->張三: 忙得吐血,哪有時間寫。
```

```flow
st=>start: 開始
e=>end: 結束
op=>operation: 我的操作
cond=>condition: 確認?

st->op->cond
cond(yes)->e
cond(no)->op
```

效果如下:

張三->李四: 嘿,小四兒, 寫博客了沒?
Note right of 李四: 李四愣了一下,說:
李四-->張三: 忙得吐血,哪有時間寫。
st=>start: 開始
e=>end: 結束
op=>operation: 我的操作
cond=>condition: 確認?

st->op->cond
cond(yes)->e
cond(no)->op

更多請參考:http://bramp.github.io/js-sequence-diagrams/, http://adrai.github.io/flowchart.js/

表格

Markdown 語法:

第一格表頭 | 第二格表頭
--------- | -------------
內容單元格 第一列第一格 | 內容單元格第二列第一格
內容單元格 第一列第二格 多加文字 | 內容單元格第二列第二格

效果如下:

第一格表頭 第二格表頭
內容單元格 第一列第一格 內容單元格第二列第一格
內容單元格 第一列第二格 多加文字 內容單元格第二列第二格

刪除線

Markdown 語法:

加刪除線像這樣用: 刪除這些

效果如下:

加刪除線像這樣用: 刪除這些

分隔線

以下三種方式都可以生成分隔線:




效果如下:




腳注(Footnote)

Markdown 語法:

這是一個腳注:[^sample_footnote]

效果如下:

這是一個腳注:[1]

注釋和閱讀更多


********注******** 閱讀更多的功能只用在生成網站或博客時,插入時注意要后空一行。


  1. 這里是腳注信息 ?

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容