MarkDown 基本語法

MarkDown基本語法

簡介

Markdown 是一種輕量級標(biāo)記語言,它允許人們使用易讀易寫的純文本格式編寫文檔。
Markdown 語言在 2004 由約翰·格魯伯(英語:John Gruber)創(chuàng)建。
Markdown 編寫的文檔可以導(dǎo)出 HTML 、Word、圖像、PDF、Epub 等多種格式的文檔。
Markdown 編寫的文檔后綴為 .md, .markdown。

心得

  • 先把心得放最前面,防止放最后沒人看到:)。
  • 本地GitBook Editor存放路徑:C:\Users\guzicheng\GitBook\Library\Import
  • 查看效果:管理員cmd --> cd openlayers --> git serve
  • 在使用MarkDown時(shí),只要熟記語法,寫文檔起來比文本編輯器方便很多。但是還是會(huì)有很多功能沒法實(shí)現(xiàn),首先可以嘗試用html標(biāo)簽解決。
  • 在語法標(biāo)簽后與文字中間,我喜歡加一個(gè)空格(如:#(空格)我是標(biāo)題),看起來比較舒服,但是有部分標(biāo)簽需要注意,如*斜體*,中間加空格(*(空格)斜體(空格)*)就會(huì)變成列表形式。
  • 本文是從網(wǎng)上搜集的資料加以綜合形成,發(fā)現(xiàn)有些地方描述不盡相同,推測可能是不同版本或不同編輯器導(dǎo)致的,文本用的是GitBook Editor Version7.0.12
  • GitBook Editor的預(yù)覽有時(shí)候不是實(shí)時(shí)同步的,view ---> Toggle Preview重新開一下即可。
  • 每寫完一行后,盡量用回車,避免上一行有特殊標(biāo)簽影響下一行,回車并不會(huì)影響MarkDown換行,MarkDown換行為三個(gè)空格。
  • 本文將根據(jù)實(shí)際遇到情況不定時(shí)更新

一、標(biāo)題

規(guī)則

設(shè)置為標(biāo)題的文字前加#(#(空格)文字),支持六級標(biāo)題

示例
# 一級標(biāo)題
## 二級標(biāo)題
### 三級標(biāo)題
#### 四級標(biāo)題
##### 五級標(biāo)題
###### 六級標(biāo)題
效果如下

一級標(biāo)題

二級標(biāo)題

三級標(biāo)題

四級標(biāo)題

五級標(biāo)題
六級標(biāo)題

二、字體

規(guī)則

字體用符號包起來,*與_效果一樣,中間盡量不加空格

示例
**這是加粗的文字**
__這是傾斜的文字__
*這是傾斜的文字*
_這是傾斜的文字_
***這是斜體加粗的文字***
___這是斜體加粗的文字___
~~這是加刪除線的文字~~
效果如下

這是加粗的文字
這是傾斜的文字
這是傾斜的文字
這是傾斜的文字
這是斜體加粗的文字
這是斜體加粗的文字
這是加刪除線的文字

三、引用

規(guī)則

在引用的文字前加>即可。引用也可以嵌套,如加兩個(gè)>>三個(gè)>>>

示例
> 引用內(nèi)容
>> 引用內(nèi)容
>>> 引用內(nèi)容
>>>>>>>> 引用內(nèi)容
效果如下

引用內(nèi)容

引用內(nèi)容

引用內(nèi)容

引用內(nèi)容

四、分割線

規(guī)則

三個(gè)以上的-或*,無論打多少個(gè)符號,效果是一樣的

示例
下面有分割線
---
下面有分割線
------
下面有分割線
***
下面有分割線
******
效果如下
下面有分割線

下面有分割線

下面有分割線

下面有分割線

五、 圖片

規(guī)則1
![alt屬性文本](圖片地址)
![alt屬性文本](圖片地址 "可選標(biāo)題")
alt屬性文本:對圖片的解釋,圖片裂開時(shí)顯示
圖片地址:圖片的地址
可選標(biāo)題:當(dāng)鼠標(biāo)移到圖片上時(shí)顯示的內(nèi)容,可加可不加
示例1
![RUNOOB 圖標(biāo)](https://upload-images.jianshu.io/upload_images/5978254-aa472d7e33a009f1.png)
![菜鳥](http://static.runoob.com/images/runoob-logo.png "這里是可選標(biāo)題")
效果如下1
RUNOOB 圖標(biāo)

規(guī)則2

MarkDown不支持控制圖片大小,可以用html標(biāo)簽替代

示例2
<img src="http://static.runoob.com/images/runoob-logo.png" width="100%">
效果如下2

<img src="http://static.runoob.com/images/runoob-logo.png" width="100%">

六、 超鏈接

規(guī)則
[超鏈接名](超鏈接地址 "超鏈接title")

超鏈接名:顯示的超鏈接名字
超鏈接地址:跳轉(zhuǎn)地址
超鏈接title:鼠標(biāo)移上顯示名稱
示例
[簡書](http://jianshu.com)
[百度](http://www.baidu.com "百度")
效果如下

簡書
百度

七、 列表

無序列表

規(guī)則

+或-或*,加空格,加文字,三種標(biāo)簽效果都一樣,如:+(空格)列表內(nèi)容

示例
- 列表內(nèi)容
* 列表內(nèi)容
+ 列表內(nèi)容
效果如下
  • 列表內(nèi)容
  • 列表內(nèi)容
  • 列表內(nèi)容

有序列表

規(guī)則

數(shù)字加.,加空格,如:1.(空格)列表內(nèi)容

示例
1. 列表內(nèi)容
2. 列表內(nèi)容
3. 列表內(nèi)容
效果如下
  1. 列表內(nèi)容
  2. 列表內(nèi)容
  3. 列表內(nèi)容

自定義列表

規(guī)則

只要在下級節(jié)點(diǎn)前,加三個(gè)空格即可

示例(順便測試一下樣式)
* 第一章
1. 第一節(jié)
2. 第二節(jié)
* 第二章
7. 第四節(jié)(這里前面的編號會(huì)自動(dòng)默認(rèn)從1開始,無法更改)
8. 第五節(jié)
3. 第三章(這里列表樣式會(huì)默認(rèn)跟前面同級節(jié)點(diǎn))
1. 第六節(jié)
2. 第七節(jié)
3. 第八節(jié)(這里前面的編號會(huì)自動(dòng)默認(rèn)從1開始,無法更改)
2. 第九節(jié)
效果如下
  • 第一章
  1. 第一節(jié)
  2. 第二節(jié)
  • 第二章
  1. 第四節(jié)(這里前面的編號會(huì)自動(dòng)默認(rèn)從1開始,無法更改)
  2. 第五節(jié)
  3. 第三章(這里列表樣式會(huì)默認(rèn)跟前面同級節(jié)點(diǎn))
  • 第六節(jié)
  • 第七節(jié)
  1. 第八節(jié)(這里前面的編號會(huì)自動(dòng)默認(rèn)從1開始,無法更改)
  2. 第九節(jié)

八、 表格

規(guī)則
表頭1 | 表頭2 | 表頭3
:- | :-: | -:
11 | 12 | 13
21 | 22 | 23

用|表示分隔線,分割不同單元格。
用-隔開表頭和其他行,還可以表示對齊方式:
文字默認(rèn)居左
-左邊加:(:-)表示文字居左
-兩邊加:(:-:)表示文字居中
-右邊加:(-:)表示文字居右
示例
表頭1 | 表頭2 | 表頭3
:- | :-: | -:
11 | 12 | 13
21 | 22 | 23
效果如下
表頭1 表頭2 表頭3
11 12 13
21 22 23

九、 代碼

規(guī)則

單行代碼:用`將代碼包起來,如:代碼
多行代碼:用```將代碼包起來,如:我是代碼塊

效果如下

單行代碼:
Hello World!

代碼塊:

function sayHi(){
console.log("Hello World");
}

十、 段落

規(guī)則

段落沒有特殊規(guī)則,換行是使用兩個(gè)以上空格加上回車。

示例

我是段落第一行(空格)(空格)(空格)(回車)
我是段落第二行

效果如下

我是段落第一行
我是段落第二行

十一、腳注

規(guī)則
[^要注明的文本]
示例
創(chuàng)建腳注格式類似這樣 [^RUNOOB]。
[^RUNOOB]: 菜鳥教程 -- 學(xué)的不僅是技術(shù),更是夢想?。。?
效果如下

創(chuàng)建腳注格式類似這樣 [1]

十二、HTML

規(guī)則
MarkDown支持html標(biāo)簽,如<kbd> <b> <i> <em> <sup> <sub> <br>等
示例
使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重啟電腦
效果如下

使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重啟電腦

十三、轉(zhuǎn)義

規(guī)則

Markdown 使用了很多特殊符號來表示特定的意義,如果需要顯示特定的符號則需要使用轉(zhuǎn)義字符,Markdown 使用反斜杠轉(zhuǎn)義特殊字符

示例
**文本加粗**
\*\* 正常顯示星號 \*\*
效果如下

文本加粗
** 正常顯示星號 **

更多高級功能

上面列舉了很多基本的常用的語法,實(shí)際上MarkDown還能做更多,在此先記錄,等用到再補(bǔ)充。
參考:菜鳥教程
數(shù)學(xué)公式
橫向流程圖
豎向流程圖
標(biāo)準(zhǔn)流程圖
標(biāo)準(zhǔn)流程圖(橫向)
UML時(shí)序圖(簡單版)
UML時(shí)序圖(復(fù)雜版)
UML時(shí)序圖(標(biāo)準(zhǔn))
甘特圖


  1. 菜鳥教程 -- 學(xué)的不僅是技術(shù),更是夢想?。。??

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請結(jié)合常識與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • markdown是一種純文本格式的標(biāo)記語言。通過簡單的標(biāo)記語法,它可以使普通文本內(nèi)容具有一定的格式。 相比WYSI...
    像計(jì)算機(jī)一樣思考閱讀 483評論 0 0
  • 文章內(nèi)容 markdown是一種純文本格式的標(biāo)記語言。通過簡單的標(biāo)記語法,它可以使普通文本內(nèi)容具有一定的格式。 相...
    拒絕奢望的leaf閱讀 295評論 0 0
  • Markdown是一種純文本格式的標(biāo)記語言。通過簡單的標(biāo)記語法,它可以使普通文本內(nèi)容具有一定的格式。 相比WYSI...
    jeffrey_hjf閱讀 251評論 0 0
  • Markdown是一種純文本格式的標(biāo)記語言。通過簡單的標(biāo)記語法,它可以使普通文本內(nèi)容具有一定的格式。 相比WYSI...
    高鴻祥閱讀 2,503,034評論 215 2,908
  • 同學(xué)們以超過花甲之年的年紀(jì),以浩浩25人的龐大隊(duì)伍,作晉陜之游,實(shí)在是罕見,又讓人感慨,還讓人驚嘆。早在同...
    喬延賓閱讀 375評論 0 0

友情鏈接更多精彩內(nèi)容