MarkDown 基本語法

簡介

Markdown 是一種輕量級標記語言,它容許人們使用易讀易寫的純文本格式編寫文檔。
Markdown 語言在 2004 由約翰·格魯伯(英語:John Gruber)建立。
Markdown 編寫的文檔能夠導出 HTML 、Word、圖像、PDF、Epub 等多種格式的文檔。
Markdown 編寫的文檔後綴爲 .md, .markdown。html

心得

  • 先把心得放最前面,防止放最後沒人看到:)。
  • 本地GitBook Editor存放路徑:C:\Users\guzicheng\GitBook\Library\Import
  • 查看效果:管理員cmd --> cd openlayers --> git serve
  • 在使用MarkDown時,只要熟記語法,寫文檔起來比文本編輯器方便不少。可是仍是會有不少功能無法實現,首先能夠嘗試用html標籤解決。
  • 在語法標籤後與文字中間,我喜歡加一個空格(如:#(空格)我是標題),看起來比較舒服,可是有部分標籤須要注意,如*斜體*,中間加空格(*(空格)斜體(空格)*)就會變成列表形式。
  • 本文是從網上搜集的資料加以綜合造成,發現有些地方描述不盡相同,推測多是不一樣版本或不一樣編輯器致使的,文本用的是GitBook Editor Version7.0.12
  • GitBook Editor的預覽有時候不是實時同步的,view ---> Toggle Preview從新開一下便可。
  • 每寫完一行後,儘可能用回車,避免上一行有特殊標籤影響下一行,回車並不會影響MarkDown換行,MarkDown換行爲三個空格。
  • 本文將根據實際遇到狀況不定時更新

1、標題

規則

設置爲標題的文字前加#(#(空格)文字),支持六級標題git

示例
# 一級標題
 ## 二級標題
 ### 三級標題
 #### 四級標題
 ##### 五級標題
 ###### 六級標題
效果以下

一級標題

二級標題

三級標題

四級標題

五級標題
六級標題

2、字體

規則

字體用符號包起來,*與_效果同樣,中間儘可能不加空格markdown

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

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

3、引用

規則

在引用的文字前加>便可。引用也能夠嵌套,如加兩個>>三個>>>測試

示例
> 引用內容
>> 引用內容
>>> 引用內容
>>>>>>>> 引用內容
效果以下

引用內容字體

引用內容code

引用內容htm

引用內容blog

4、分割線

規則

三個以上的-或*,不管打多少個符號,效果是同樣的教程

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

下面有分割線

#####下面有分割線

#####下面有分割線

5、 圖片

規則1
![alt屬性文本](圖片地址)
![alt屬性文本](圖片地址 "可選標題")
alt屬性文本:對圖片的解釋,圖片裂開時顯示
圖片地址:圖片的地址
可選標題:當鼠標移到圖片上時顯示的內容,可加可不加
示例1
![RUNOOB 圖標](https://img2018.cnblogs.com/blog/365445/201911/365445-20191127140421532-627819498.png)
![菜鳥](http://static.runoob.com/images/runoob-logo.png "這裏是可選標題")
效果以下1

RUNOOB 圖標

菜鳥

規則2

MarkDown不支持控制圖片大小,能夠用html標籤替代

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

6、 超連接

規則
[超連接名](超連接地址 "超連接title")

超連接名:顯示的超連接名字
超連接地址:跳轉地址
超連接title:鼠標移上顯示名稱
示例
[簡書](http://jianshu.com)
[百度](http://www.baidu.com "百度")
效果以下

簡書
百度

7、 列表

無序列表

規則

+或-或*,加空格,加文字,三種標籤效果都同樣,如:+(空格)列表內容

示例
- 列表內容
* 列表內容
+ 列表內容
效果以下
  • 列表內容
  • 列表內容
  • 列表內容

有序列表

規則

數字加.,加空格,如:1.(空格)列表內容

示例
1. 列表內容
2. 列表內容
3. 列表內容
效果以下
  1. 列表內容
  2. 列表內容
  3. 列表內容

自定義列表

規則

只要在下級節點前,加三個空格便可

示例(順便測試一下樣式)
* 第一章
1. 第一節
2. 第二節
* 第二章
7. 第四節(這裏前面的編號會自動默認從1開始,沒法更改)
8. 第五節
3. 第三章(這裏列表樣式會默認跟前面同級節點)
1. 第六節
2. 第七節
3. 第八節(這裏前面的編號會自動默認從1開始,沒法更改)
2. 第九節
效果以下
  • 第一章
  1. 第一節
  2. 第二節
  • 第二章
  1. 第四節(這裏前面的編號會自動默認從1開始,沒法更改)
  2. 第五節
  3. 第三章(這裏列表樣式會默認跟前面同級節點)
  • 第六節
  • 第七節
  1. 第八節(這裏前面的編號會自動默認從1開始,沒法更改)
  2. 第九節

8、 表格

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

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

9、 代碼

規則

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

效果以下

單行代碼:
Hello World!

代碼塊:

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

10、 段落

規則

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

示例

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

效果以下

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

11、腳註

規則
[^要註明的文本]
示例
建立腳註格式相似這樣 [^RUNOOB]。   
[^RUNOOB]: 菜鳥教程 -- 學的不只是技術,更是夢想!!!
效果以下

建立腳註格式相似這樣 [^RUNOOB]
[^RUNOOB]: 菜鳥教程 -- 學的不只是技術,更是夢想!!!

12、HTML

規則
MarkDown支持html標籤,如<kbd> <b> <i> <em> <sup> <sub> <br>等
示例
使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重啓電腦
效果以下

使用 Ctrl+Alt+Del 重啓電腦

十3、轉義

規則

Markdown 使用了不少特殊符號來表示特定的意義,若是須要顯示特定的符號則須要使用轉義字符,Markdown 使用反斜槓轉義特殊字符

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

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

更多高級功能

上面列舉了不少基本的經常使用的語法,實際上MarkDown還能作更多,在此先記錄,等用到再補充。
參考:菜鳥教程
數學公式
橫向流程圖
豎向流程圖
標準流程圖
標準流程圖(橫向)
UML時序圖(簡單版)
UML時序圖(複雜版)
UML時序圖(標準)
甘特圖

相關文章
相關標籤/搜索