MarkDown的基本用法

最新推荐文章于 2024-06-26 09:41:44 发布

原创最新推荐文章于 2024-06-26 09:41:44 发布 · 368 阅读

0 ·

CC 4.0 BY-SA版权

软件测试专栏收录该内容

14 篇文章

订阅专栏

本文介绍了Markdown的基本用法，包括标题、引用、图片与链接、粗体与斜体、表格、代码框及分割线等元素的书写规则，并推荐了一些实用的Markdown编辑工具。

今天特地google了下MD的基本用法,学习笔记以及摘抄如下：

Markdown 的优势，大概有以下几点：
1. 基于纯文本，只保留内容，很少保留额外的东西。源文件可读可编辑，任意文本编辑器均支持（word 之类的编辑工具虽然丰富了文档格式，但添加了许多格式化的数据，而且是私有格式，被限制在少数几款工具中使用）；
2. 在纯文本的基础上，通过简单的标记语法（或者叫约定），即可通过程序转换成 HTML 等其他格式的文档；
3. 转换程序已经遍布前后端、各种平台、各种语言了；
4. 转换支持的格式，或间接支持的格式也有很多（HTML、word、PDF、epub 等）；
5. 扩展语法丰富，能支持的功能被无限扩充（Github 的扩展就很不错： GitHub Flavored Markdown · GitHub Help ）；
6. 编辑工具丰富（可以参考我的 Learning-Markdown，以及其他回复中的举例）；
7. 主流网站支持比较好（Github 等）。

用 Markdown 写文章，不会因为要注意语法而导致写作速度变慢，还会从它标准的格式中获得一些方便之处：
1. 所有人、所有工具都共享统一的语法，不会出现 docx、PDF 打不开等问题；
2. 几乎是任意工具都可以打开编辑（普通文本编辑器、Markdown 专用编辑器）；
3. 产生的内容语法是一致的，方便阅读和再编辑，共享给他人也是。

MarkDown工具：

Windows：

MarkPad https://www.microsoft.com/en-us/store/apps/markpad/9wzdncrdcfsb

Mac：

Mou http://25.io/mou/

Web：

简书 http://www.jianshu.com/

Dillinger http://dillinger.io/

標題

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

換行與段落

一個換行字元會轉成換行<br />
兩個換行字元會轉成段落<p></p>

第一段
第一行
第二行

第二段
第一行
第二行

字體

*斜體*
**粗體**
***粗斜體***
~~刪除線~~

引言

> 用>和一個空白表示
>> 多個>表示嵌套

水平分隔線

三個以上的星號、連字號、底線表示
不能有空白或其他的文字
***
---
___

無序清單

* 星號加空白
    * 加Tab可嵌套清單
+ 加號也可以
- 減號也可以

有序清單

1. 格式為一個數字加小數點加空白
2. 數字本身順序不重要會自動遞增
    1. 一樣用加Tab可以嵌套

超連結

* [行內連結](https://www.google.com)
* [帶標題的行內連結](https://www.google.com "Google WebSite")
* [參考連結][Google Link]
[Google Link]: https://www.google.com

圖片

行內格式：
![圖片文字](01.png "圖片Alt")

參考連結格式：
![圖片文字][logo]
[logo]: 01.png "圖片Alt"

程式代碼與語法高亮

單行代碼用一個`前後包起來
多行代碼用三個`前後包起來
語法高亮在`符號後加入語法的名稱

Console.WriteLine("Hello");

表格

冒號用來對齊的
預設為靠左對齊
放在右邊就是靠右對齊
左右都放就是靠中對齊

| 欄位一        | 欄位二           |  欄位三 |
| ------------- |-------------:| :-----:|
| col 3 is      | right-aligned | $1600 |
| col 2 is      | centered      |   $12 |
| zebra stripes | are neat      |    $1 |

表示中要跳脫表格用到的符號，需要用html編碼的方式表示
空白是&nbsp;
|是&#124;

MarkDown语法的简要规则：

标题：

在Markdown中，若一段文字被定义为标题，只要在这段文字前加 # 号即可。

注意：需要在 # 后加一个空格，这是最标准的Markdown语法。

引用：

如果你需要引用一小段别处的句子，那么就要用引用的格式。

只需要在文本前加入 > 这种尖括号（大于号）即可。&lt;img src="https://i-blog.csdnimg.cn/blog_migrate/29094e86be36f542d06618e38ee7e0ac.png" data-rawwidth="800" data-rawheight="600" class="origin_image zh-lightbox-thumb" width="800" data-original="https://pic1.zhimg.com/928ce94bc1dc28811365f6c0dc9e4a10_r.png"&gt;

图片与链接：

插入链接与插入图片的语法很像，区别在于一个 ! 号。

&lt;img src="https://i-blog.csdnimg.cn/blog_migrate/13af66165e6fd3998bee9b98fba47712.png" data-rawwidth="800" data-rawheight="600" class="origin_image zh-lightbox-thumb" width="800" data-original="https://pic3.zhimg.com/1f5cce6d1e1b72f6e5c3991129336b16_r.png"&gt;

粗体与斜体：

Markdown的粗体和斜体也非常简单，用两个 * 包含一段文本就是粗体的语法，用一个 * 包含一段文本就是斜体的语法。&lt;img src="https://i-blog.csdnimg.cn/blog_migrate/0c49d6d964a63506cf6b1cf986e33be0.png" data-rawwidth="800" data-rawheight="600" class="origin_image zh-lightbox-thumb" width="800" data-original="https://pic1.zhimg.com/75f55c4fac0cd217deb51640b5622640_r.png"&gt;

表格：

表格的语法稍微复杂一些，如图所示：&lt;img src="https://i-blog.csdnimg.cn/blog_migrate/dab242a69844466a0f9138e5a5d7454e.png" data-rawwidth="800" data-rawheight="600" class="origin_image zh-lightbox-thumb" width="800" data-original="https://pic2.zhimg.com/7ad74526f0f12d18e8d5840fedce2ebd_r.png"&gt;

代码框：

如果你是个程序猿，需要在文章里优雅的引用代码框，只需要用两个 ` 把中间的代码包裹起来，使用Tab键即可缩进。&lt;img src="https://i-blog.csdnimg.cn/blog_migrate/898dfea4d881ee47fdbb1649210627eb.png" data-rawwidth="800" data-rawheight="600" class="origin_image zh-lightbox-thumb" width="800" data-original="https://pic2.zhimg.com/75da9088a2cd67910a07554cdfc39e15_r.png"&gt;

分割线：

分割线的语法只需要另起一行，连续输入三个星号 *** 即可。&lt;img src="https://i-blog.csdnimg.cn/blog_migrate/011e334811fa55ac400d9e8b6b79c97f.png" data-rawwidth="800" data-rawheight="600" class="origin_image zh-lightbox-thumb" width="800" data-original="https://pic2.zhimg.com/d9eaf93d02465af3eb7ab94cf1a2dce9_r.png"&gt;