Sphinx+github+ReadtheDocs書寫筆記
948
2022-05-30
markdown基本語法整理
markdown基本知識
Markdown 是一種輕量級標記語言,允許使用純文本格式編寫文檔。
Markdown 編寫的文檔后綴為 .md, .markdown。
markdown語法
1. 標題
我是一級標題 ============ 我是二級標題 ------------
效果如下:
我是一級標題
我是二級標題
> # 我是一級標題 > ## 我是二級標題 > ### 我是三級標題 > #### 我是四級標題 > ##### 我是五級標題 > ###### 我是六級標題
效果如下:
我是一級標題
我是二級標題
我是三級標題
2. 列表
使用*標記
* 第一項 * 第二項 * 第三項
效果如下:
第一項
第二項
第三項
使用-標記
- 第一項 - 第二項 - 第三項
效果如下:
第一項
第二項
第三項
使用+標記
+ 第一項 + 第二項 + 第三項
效果如下:
第一項
第二項
第三項
使用數字加.標記
1. 第一項 2. 第二項 3. 第三項
效果如下:
第一項
第二項
第三項
子列表選項前添加四個空格
1. 第一項: - 1.1 第一項嵌套的第一個元素 - 1.2 第一項嵌套的第二個元素 2. 第二項: - 2.1 第二項嵌套的第一個元素 - 2.2 第二項嵌套的第二個元素
效果如下:
第一項:
1.1 第一項嵌套的第一個元素
1.2 第一項嵌套的第二個元素
第二項:
2.1 第二項嵌套的第一個元素
2.2 第二項嵌套的第二個元素
3. 代碼
使用```標記(中括號[ ]內部內容)
[``` // 這是一段代碼 print("Hello world"); ```]
效果如下(中括號[ ]內部內容):
// 這是一段代碼 print("Hello world");
4. 表格
使用 | 來分隔不同的單元格,使用 - 來分隔表頭和其他行
| 表頭1 | 表頭2 | | ----- | ----- | | 單元格1.1 | 單元格1.2 | | 單元格2.1 | 單元格2.2 |
效果如下:
表格的對齊方式:
-: 設置內容和標題欄居右對齊。
:- 設置內容和標題欄居左對齊。
:-: 設置內容和標題欄居中對齊。
| 左對齊示例 | 居中對齊示例 | 右對齊示例 | | :---------| :---------: | --------: | | 單元格 | 單元格 | 單元格 | | 單元格 | 單元格 | 單元格 |
效果如下:
5. 區塊
使用 > 標記
> 區塊引用1 > 區塊引用2 > 區塊引用3 > 區塊引用4
效果如下:
區塊引用1
區塊引用2
區塊引用3
區塊引用4
> 區塊引用最外層 > > 區塊引用第一層嵌套 > > > 區塊引用第二層嵌套 > > 區塊引用第一層嵌套
效果如下:
區塊引用最外層
區塊引用第一層嵌套
區塊引用第二層嵌套
區塊引用第一層嵌套
6. 鏈接
鏈接名稱和鏈接地址
這是一個鏈接[鏈接示例](https://www.huaweicloud.com/?locale=zh-cn)
效果如下:
這是一個鏈接鏈接示例
顯示鏈接地址
效果如下:
https://www.huaweicloud.com/?locale=zh-cn
字體
斜體
_斜體示例_ *斜體示例*
效果如下:
斜體示例
斜體示例
粗體:
__粗體示例__ **粗體示例**
效果如下:
粗體示例
粗體示例
斜體+粗體
___粗體示例___ ***粗體示例***
效果如下:
粗體示例
粗體示例
Markdown
版權聲明:本文內容由網絡用戶投稿,版權歸原作者所有,本站不擁有其著作權,亦不承擔相應法律責任。如果您發現本站中有涉嫌抄襲或描述失實的內容,請聯系我們jiasou666@gmail.com 處理,核實后本網站將在24小時內刪除侵權內容。