GitBook 默認(rèn)使用 Markdown 語(yǔ)法。
下面這些可以作為一個(gè)快速參考和展示。更多完整的信息,請(qǐng)參考 John Gruber's original spec 和 Github-flavored Markdown info page。
# H1
## H2
### H3
#### H4
##### H5
###### H6
對(duì)于 H1和 H2,有下劃線樣式可供選擇:
Alt-H1
======
Alt-H2
------
強(qiáng)調(diào),又叫做斜體,使用 *星號(hào)* 或 _下劃線_。
重點(diǎn)強(qiáng)調(diào),又叫做粗體,使用 **星號(hào)** 或 __下劃線__。
使用 **星號(hào)和_下劃線_** 組合使用強(qiáng)調(diào)。
刪除線使用兩個(gè)波浪線。~~劃掉這個(gè)~~
在這個(gè)例子中,前導(dǎo)空格和尾部空格顯示為圓點(diǎn) : ?)
1. 有序列表的第一項(xiàng)
2. 另外一個(gè)項(xiàng)
..* 無(wú)序子列表
1. 事實(shí)上序號(hào)不起作用,那只是一個(gè)數(shù)字而已
..1. 有序子列表
4. 最后一個(gè)項(xiàng)
...你可以適當(dāng)?shù)目s緊列表項(xiàng)中的段落。注意上面的空行和前導(dǎo)空格(至少一個(gè),但是這里我們使用三個(gè)來(lái)對(duì)齊原始的Markdown內(nèi)容)。
...換行而不形成段落,你需要使用兩個(gè)尾部空格。..
...注意這行是分開的,但還在同一個(gè)段落中。..
...(這個(gè)違背了不需要尾部空格的典型的GFM換行行為)。
* 無(wú)序列表可以使用星號(hào)
- 或者減號(hào)
+ 或者加號(hào)
有兩種創(chuàng)建鏈接的方式。
[內(nèi)嵌式鏈接](https://www.google.com)
[帶標(biāo)題的內(nèi)嵌式鏈接](https://www.google.com "谷歌的主頁(yè)")
[引用式鏈接][arbitrary case-insensitive reference text]
[相對(duì)引用一個(gè)庫(kù)文件](../blob/master/LICENSE)
[你可以在引用式鏈接定義中使用數(shù)字][1]
或者空著什么都不寫 [link text itself]
用來(lái)說(shuō)明引用鏈接的文字可以放在后面。
[arbitrary case-insensitive reference text]: https://www.mozilla.org
[1]: http://slashdot.org
[link text itself]: http://www.reddit.com
Markdown 默認(rèn)使用的腳注樣式鏈接不會(huì)在頁(yè)面中顯示。有時(shí)包含一個(gè)讀者可見的非超鏈接注腳很有用。對(duì)于這樣的注腳,GitBook 支持的一種簡(jiǎn)單的語(yǔ)法。
Text prior to footnote reference.[^2]
[^2]: Comment to include in footnote.
這是我們的logo(停留查看標(biāo)題)
內(nèi)嵌式
![alt text](https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png "Logo Title Text 1")
引用式
![alt text][logo]
[logo]: https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png "Logo Title Text 2"
代碼塊是 Markdown 規(guī)范的一部分,但是語(yǔ)法高亮不是。然而,很多渲染器,比如 GitHub 的和這里的 Markdown ,都支持語(yǔ)法高亮。支持哪種語(yǔ)言以及語(yǔ)言的名字應(yīng)該怎樣寫隨渲染器的不同而變化。這里的 Markdown 支持富文本語(yǔ)法;查看完整的列表,以及如何寫語(yǔ)言的名字,請(qǐng)參考 highlight.js 演示頁(yè).
內(nèi)嵌 `代碼` 有 `反引號(hào)` 包含它.
代碼塊要么被包含三個(gè)反引號(hào) ?```
? 的行包圍,要么被四個(gè)空格縮進(jìn)。推薦僅僅使用被包圍的代碼塊,它們使用方便并且只有它們支持語(yǔ)法高亮。
```javascript
var s = "JavaScript語(yǔ)法高亮";
alert(s);
```
```python
s = "Python語(yǔ)法高亮"
print s
```
```
沒有指明語(yǔ)言,所有沒有語(yǔ)法高亮。
讓我們隨便寫個(gè)標(biāo)簽試試 <b>tag</b>
```
表格不是 Markdown 規(guī)范的核心部分,但是它是 GFM 的一部分,這里的 Markdown 也支持它。
冒號(hào)可以用來(lái)對(duì)其列。
| Tables | Are | Cool |
| ------------- |:-------------:| -----:|
| col 3 is | right-aligned | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |
The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown.
外部的管道符 (|) 是可選的,而且不需要優(yōu)雅的排列Markdown。你還可以在表格中內(nèi)嵌其他Markdown。
Markdown | Less | Pretty
--- | --- | ---
*Still* | `renders` | **nicely**
1 | 2 | 3
> 在郵件中塊引用中很方便用來(lái)仿真文本的回復(fù)。
> 這行是同一個(gè)塊的一部分。
引用結(jié)束
> 當(dāng)這行很長(zhǎng)的文字被包裹的時(shí)候,它依然會(huì)被恰當(dāng)?shù)囊谩W屛覀兝^續(xù)寫下去來(lái)確保包裹它時(shí)對(duì)于每個(gè)人來(lái)說(shuō)它足夠長(zhǎng)。你可以在塊引用中使用其它**Markdown**。
你同樣可以在 Markdown 中使用 HTML ,并且它能很好的工作。
<dl>
<dt>W3Cschool在線教程</dt>
<dd>隨時(shí)隨地學(xué)編程</dd>
<dt>W3Cschool在線教程</dt>
<dd>隨時(shí)隨地學(xué)編程 <em>tags</em>.</dd>
</dl>
三個(gè)或者更多...
---
連字符
***
星號(hào)
___
下劃線
關(guān)于學(xué)習(xí)換行符是如何工作的,我的建議是去親身實(shí)踐并總結(jié) -- 敲擊鍵一次(也就是插入一個(gè)換行符),然后再敲擊它兩次(也就是插入兩個(gè)換行),看一下發(fā)生了什么。不久你就能學(xué)會(huì)它。"Markdown Toggle" 是你的朋友。
這里有一些東西可以嘗試一下:
我們以這行作為開始。
This line is separated from the one above by two newlines, so it will be a *separate paragraph*.
這行與上面那行被兩個(gè)換行符分隔,所以它會(huì)成為一個(gè) *單獨(dú)的段落*。
This line is also a separate paragraph, but...
This line is only separated by a single newline, so it's a separate line in the *same paragraph*.
這行同樣是一個(gè)單獨(dú)的段落,但是...
這行僅僅被一個(gè)換行符分隔,所以它是一個(gè)在 *同一段落* 中的單獨(dú)的行。
視頻不能被直接添加,但你可以添加一個(gè)鏈接至視頻的圖片,像這樣:
<a href="http://www.youtube.com/watch?feature=player_embedded&v=YOUTUBE_VIDEO_ID_HERE
" target="_blank"><img src="http://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg" rel="external nofollow"
alt="IMAGE ALT TEXT HERE" width="240" height="180" border="10" /></a>
或者使用純 Markdown ,但是會(huì)丟失掉圖片的大小和邊框:
[![IMAGE ALT TEXT HERE](http://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg)](http://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE)
更多建議: