GitBook Markdown

2021-03-02 15:59 更新

GitBook 默認使用 Markdown 語法。

下面這些可以作為一個快速參考和展示。更多完整的信息,請參考 John Gruber's original spec 和 Github-flavored Markdown info page。

標題

# H1
## H2
### H3
#### H4
##### H5
###### H6

對于 H1和 H2,有下劃線樣式可供選擇:

Alt-H1
======

Alt-H2
------

強調

強調,又叫做斜體,使用 *星號* 或 _下劃線_。

重點強調,又叫做粗體,使用 **星號** 或 __下劃線__。

使用 **星號和_下劃線_** 組合使用強調。

刪除線使用兩個波浪線。~~劃掉這個~~

列表

在這個例子中,前導空格和尾部空格顯示為圓點 : ?)

1. 有序列表的第一項
2. 另外一個項
..* 無序子列表
1. 事實上序號不起作用,那只是一個數(shù)字而已
..1. 有序子列表
4. 最后一個項

...你可以適當?shù)目s緊列表項中的段落。注意上面的空行和前導空格(至少一個,但是這里我們使用三個來對齊原始的Markdown內(nèi)容)。

...換行而不形成段落,你需要使用兩個尾部空格。..
...注意這行是分開的,但還在同一個段落中。..
...(這個違背了不需要尾部空格的典型的GFM換行行為)。

* 無序列表可以使用星號
- 或者減號
+ 或者加號

鏈接

有兩種創(chuàng)建鏈接的方式。

[內(nèi)嵌式鏈接](https://www.google.com)

[帶標題的內(nèi)嵌式鏈接](https://www.google.com "谷歌的主頁")

[引用式鏈接][arbitrary case-insensitive reference text]

[相對引用一個庫文件](../blob/master/LICENSE)

[你可以在引用式鏈接定義中使用數(shù)字][1]

或者空著什么都不寫 [link text itself]

用來說明引用鏈接的文字可以放在后面。

[arbitrary case-insensitive reference text]: https://www.mozilla.org
[1]: http://slashdot.org
[link text itself]: http://www.reddit.com

腳注

Markdown 默認使用的腳注樣式鏈接不會在頁面中顯示。有時包含一個讀者可見的非超鏈接注腳很有用。對于這樣的注腳,GitBook 支持的一種簡單的語法。

Text prior to footnote reference.[^2]
[^2]: Comment to include in footnote.

圖片

這是我們的logo(停留查看標題)

內(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ī)范的一部分,但是語法高亮不是。然而,很多渲染器,比如 GitHub 的和這里的 Markdown ,都支持語法高亮。支持哪種語言以及語言的名字應該怎樣寫隨渲染器的不同而變化。這里的 Markdown 支持富文本語法;查看完整的列表,以及如何寫語言的名字,請參考 highlight.js 演示頁.

內(nèi)嵌 `代碼` 有 `反引號` 包含它.


    

代碼塊要么被包含三個反引號 ?```? 的行包圍,要么被四個空格縮進。推薦僅僅使用被包圍的代碼塊,它們使用方便并且只有它們支持語法高亮。

```javascript
var s = "JavaScript語法高亮";
alert(s);
```

```python
s = "Python語法高亮"
print s
```

```
沒有指明語言,所有沒有語法高亮。
讓我們隨便寫個標簽試試 <b>tag</b>
```

表格

表格不是 Markdown 規(guī)范的核心部分,但是它是 GFM 的一部分,這里的 Markdown 也支持它。

冒號可以用來對其列。

| 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

塊引用

> 在郵件中塊引用中很方便用來仿真文本的回復。
> 這行是同一個塊的一部分。

引用結束

> 當這行很長的文字被包裹的時候,它依然會被恰當?shù)囊?。讓我們繼續(xù)寫下去來確保包裹它時對于每個人來說它足夠長。你可以在塊引用中使用其它**Markdown**。

內(nèi)嵌HTML

你同樣可以在 Markdown 中使用 HTML ,并且它能很好的工作。

<dl>
  <dt>W3Cschool在線教程</dt>
  <dd>隨時隨地學編程</dd>

  <dt>W3Cschool在線教程</dt>
  <dd>隨時隨地學編程 <em>tags</em>.</dd>
</dl>

水平線

三個或者更多...

---

連字符

***

星號

___

下劃線

換行符

關于學習換行符是如何工作的,我的建議是去親身實踐并總結 -- 敲擊鍵一次(也就是插入一個換行符),然后再敲擊它兩次(也就是插入兩個換行),看一下發(fā)生了什么。不久你就能學會它。"Markdown Toggle" 是你的朋友。

這里有一些東西可以嘗試一下:

我們以這行作為開始。

This line is separated from the one above by two newlines, so it will be a *separate paragraph*.

這行與上面那行被兩個換行符分隔,所以它會成為一個 *單獨的段落*。

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*.

這行同樣是一個單獨的段落,但是...
這行僅僅被一個換行符分隔,所以它是一個在 *同一段落* 中的單獨的行。

Youtube視頻

視頻不能被直接添加,但你可以添加一個鏈接至視頻的圖片,像這樣:

<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 ,但是會丟失掉圖片的大小和邊框:

[![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)


以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號