Markdown 簡明教程

主要內容

(一)Markdown 是什麼java

(二)爲何要使用 Markdowngit

(三)如何使用 Markdowngithub

(四)Markdown 編輯器markdown

正文

(一)Markdown是什麼

Markdown 是一種輕量級的 標記語言,以 純文本 的形式編寫文檔,經過簡潔的語法代替排版,而且能夠導出 HTMLPDF 等格式。編輯器

(二)爲何要使用 Markdown

  • 格式清晰,讀起來很舒服
  • 語法簡潔,編寫時能夠更專一於內容而非排版格式
  • 純文本形式,兼容全部的文本編輯器
  • 可導出 HTML、PDF 等常見格式

(三)如何使用 Markdown

Markdown 的語法很是簡單,主要包含如下幾個部分:標題段落列表強調區塊引用代碼區塊行內代碼分割線連接自動連接圖片反斜槓表格(擴展)url

1. 標題

標題有兩種形式,一種形式爲在文字下方添加 =====-----,分別表示一級標題和二級標題,如spa

一級標題 =====

二級標題 -----
複製代碼

效果爲code

一級標題

二級標題

另外一種形式在標題前添加 #,添加一個 # 爲一級標題,兩個爲二級標題,最多可至六級標題,如cdn

# 一級標題
## 二級標題
### 三級標題
#### 四級標題
##### 五級標題
###### 六級標題
複製代碼

效果爲xml

一級標題

二級標題

三級標題

四級標題

五級標題
六級標題

2. 段落

一個 Markdown 段落是由一個或多個連續的文本行組成,段落先後要有一個以上沒有文字的空行。使用 兩個以上的空格加回車 可強制在 段落內換行

段落的開頭 不該該使用空格或者製表符(Tab)縮進

3. 列表

Markdown 支持無序列表和有序列表。無序列表使用**星號*、加號+或減號-加至少一個空格或製表符(Tab)**做爲列表標記,如

* 第一項
* 第二項
* 第三項
複製代碼

效果爲

  • 第一項
  • 第二項
  • 第三項

有序列表使用 數字加點 . 再加至少一個空格或製表符 做爲列表標記,如

1. 第一項
2. 第二項
3. 第三項
複製代碼

效果爲

  1. 第一項
  2. 第二項
  3. 第三項

4. 強調

內容先後加上 星號 * 或 下劃線_ 表示 強調。先後加一個星號或下劃線爲 斜體,兩個爲 粗體,三個爲 粗斜體。如

*強調*
**強調**
***強調***
複製代碼

效果爲

強調

強調

強調

5. 區塊引用

在段落的 第一行或每行開頭 使用 > 表示引用,多個 > 表示嵌套,如

> 區塊引用
>> 嵌套引用
複製代碼

效果爲

區塊引用

嵌套引用

6. 代碼區塊

代碼區塊能夠按以下格式輸入

```java public static void main(string[] args) { System.out.println("Hello, world"); } ​``` 複製代碼

效果爲

public static void main(string[] args) {
	System.out.println("Hello, world");
}
複製代碼

7. 行內代碼

先後含 反引號( ` ) 的內容爲行內代碼,如

`System.out.println("Hello, world")` 表示輸出"Hello, world"。
複製代碼

效果爲

System.out.println("Hello, world") 表示輸出"Hello, world"。

8. 分割線

三個或三個以上的星號 *、減號 -及下劃線 _表示 分割線,中間可插入空格,如

***
- - -
複製代碼

效果爲



9. 連接

Markdown 支持兩種形式的連接,行內式參考式
行內式 的連接文字用中括號 [] 標記,方括號後緊接小括號 () 標記網址連接,可在網址連接後用引號標記連接的 title 文字,如

[GitHub](https://github.com/ "Github")
複製代碼

效果爲

GitHub

參考式 的連接文字一樣使用中括號 [] 標記,後面再接一箇中括號標記連接的標識,須要在文件的任意處經過 [id]:url "title" 標記連接,如

[GitHub][1]  
[1]:https://github.com/ "GitHub"
複製代碼

效果爲

GitHub

10. 自動連接

Markdown 支持以 簡短的自動連接 形式處理網址和電子郵箱,用尖括號 <> 標記,如

<https://github.com>
複製代碼

效果爲

github.com

11. 圖片

Markdown 中標記圖片的方式與標記連接相似,一樣容許 行內式參考式 兩種形式,只需在連接文字的標記前加一個感嘆號 !,如

![GitHub Icon](https://user-gold-cdn.xitu.io/2018/12/25/167e47b357d82282?w=512&h=512&f=png&s=33270 "GitHub Icon")
複製代碼

效果爲

GitHub Icon
GitHub Icon

遺憾的是 Markdown 不支持指定圖片的寬高

12. 反斜槓

經過反斜槓 \ 可插入一些在 Markdown 語法中有其餘意義的符號,如

\*先後爲星號\*
複製代碼

效果爲

*先後爲星號*

Markdown 支持在如下符號前加反斜槓 \ 來幫助插入普通的符號:

\	反斜槓   
`	反引號
*	星號
_	下劃線
{}	大括號
[]	中括號
()	小括號
#	井號
+	加好
-	減號
.	英文句號
!	感嘆號
複製代碼

13. 表格(擴展)

表格爲 擴展 的 Markdown 語法,| 表示縱向的邊界,表頭和內容之間用 三個或三個以上減號 - 隔開,可使用冒號 : 設置 對齊方式。冒號 : 在左邊表示左對齊,在右邊表示右對齊,兩邊都有冒號 : 表示居中,不使用冒號 : 時默認 左對齊,如

| name | gender | age |
| :---: | :---: | :---: |
| Jack | boy | 4 |
| Amy | girl | 5 |
複製代碼

效果爲

name gender age
Jack boy 4
Amy girl 5

(四)Markdown 編輯器

Mac 下好用的 Markdown 編輯器有不少,如 MacDownMouTypora 等。

Windows 下可使用 MarkdownPad馬克飛象有道雲筆記 等。

Github 地址,歡迎 Star。

相關文章
相關標籤/搜索