Markdown Learning Notes


Markdown 教程

Markdown 是一種輕量級標記語言,它允許人們使用易讀易寫的純文本格式編寫文檔。

Markdown 語言在 2004 由約翰·格魯伯(英語:John Gruber)創建。

Markdown 編寫的文檔可以導出 HTML 、Word、圖像、PDF、Epub 等多種格式的文檔。

Markdown 編寫的文檔后綴為 .md, .markdown。

Markdown 應用

Markdown 能被使用來撰寫電子書,如:Gitbook。

當前許多網站都廣泛使用 Markdown 來撰寫幫助文檔或是用於論壇上發表消息。例如:GitHub、簡書、reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge等。

編輯器

本教程將使用 Typora 編輯器來講解 Markdown 的語法,Typora 支持 MacOS 、Windows、Linux 平台,且包含多種主題,編輯后直接渲染出效果。

支持導出HTML、PDF、Word、圖片等多種類型文件。

Typora 官網:https://typora.io/

你也可以使用我們的在線編輯器來測試:https://c.runoob.com/front-end/712

測試實例

Mardown 編寫 Hello World! 語法:

# Hello World! 

Markdown 標題

標識符:#

 

Markdown 段落

Markdown 段落沒有特殊的格式,直接編寫文字就好,段落的換行是使用兩個以上空格加上回車

字體

Markdown 可以使用以下幾種字體:

*斜體文本*
_斜體文本_
**粗體文本**
__粗體文本__
***粗斜體文本***
___粗斜體文本___

 

顯示效果如下所示:

分隔線

你可以在一行中用三個以上的星號、減號、底線來建立一個分隔線,行內不能有其他東西。你也可以在星號或是減號中間插入空格。下面每種寫法都可以建立分隔線:

***
* * *
*****
- - -
----------

顯示效果如下所示:

刪除線

如果段落上的文字要添加刪除線,只需要在文字的兩端加上兩個波浪線 ~~ 即可,實例如下:

下划線

下划線可以通過 HTML 的 <u> 標簽來實現:

<u>帶下划線文本</u>

顯示效果如下所示:

腳注

腳注是對文本的補充說明。

Markdown 腳注的格式如下:

[^要注明的文本]

以下實例演示了腳注的用法:

創建腳注格式類似這樣 [^hello world]。

演示效果如下:

 

Markdown 列表

Markdown 支持有序列表和無序列表。

無序列表使用星號(*)、加號(+)或是減號(-)作為列表標記

顯示結果如下:

 

有序列表使用數字並加上 . 號來表示,顯示結果如下:

 

列表嵌套

列表嵌套只需在子列表中的選項添加四個空格即可:

1. 第一項:
    - 第一項嵌套的第一個元素
    - 第一項嵌套的第二個元素
2. 第二項:
    - 第二項嵌套的第一個元素
    - 第二項嵌套的第二個元素

顯示結果如下:

 

Markdown 區塊

Markdown 區塊引用是在段落開頭使用 > 符號 ,然后后面緊跟一個空格符號:

 

另外區塊是可以嵌套的,一個 > 符號是最外層,兩個 > 符號是第一層嵌套,以此類推退:

> 最外層 > > 第一層嵌套 > > > 第二層嵌套

 

區塊中使用列表

區塊中使用列表實例如下:

> 區塊中使用列表
> 1. 第一項
> 2. 第二項
> + 第一項
> + 第二項
> + 第三項

顯示結果如下:

 

列表中使用區塊

如果要在列表項目內放進區塊,那么就需要在 > 前添加四個空格的縮進。

區塊中使用列表實例如下:

* 第一項
    > 菜鳥教程
    > 學的不僅是技術更是夢想
* 第二項

顯示結果如下:

 

Markdown 代碼

如果是段落上的一個函數或片段的代碼可以用反引號把它包起來(`),例如:

`fmt.println('hello markdown')`

顯示結果如下:

 

代碼區塊

代碼區塊使用 4 個空格或者一個制表符(Tab 鍵)

實例如下:

 

也可以用 ``` 包裹一段代碼,並指定一種語言(也可以不指定):

Markdown 鏈接

鏈接使用方法如下:

[鏈接名稱](鏈接地址) 或者 <鏈接地址>

例如:

 

高級鏈接

鏈接也可以用變量來代替,文檔末尾附帶變量地址:

 

Markdown 圖片

Markdown 圖片語法格式如下:

![alt 屬性文本](圖片地址)

![alt 屬性文本](圖片地址 "可選標題")
開頭一個感嘆號 !
接着一個方括號,里面放上圖片的替代文字
接着一個普通括號,里面放上圖片的網址,最后還可以用引號包住並加上選擇性的 'title' 屬性的文字。

使用實例:

當然,你也可以像網址那樣對圖片網址使用變量:

這個鏈接用 1 作為網址變量 [images][1]. 然后在文檔的結尾位變量賦值(網址) [1]: http://static.runoob.com/images/runoob-logo.png

 

Markdown 還沒有辦法指定圖片的高度與寬度,如果你需要的話,你可以使用普通的 <img> 標簽。

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

 

Markdown 表格

Markdown 制作表格使用 | 來分隔不同的單元格,使用 - 來分隔表頭和其他行。

語法格式如下:

|  表頭   | 表頭  |
|  ----  | ----  |
| 單元格  | 單元格 |
| 單元格  | 單元格 |

 

以上代碼顯示結果如下:

對齊方式

我們可以設置表格的對齊方式:

  • -: 設置內容和標題欄居右對齊。
  • :- 設置內容和標題欄居左對齊。
  • :-: 設置內容和標題欄居中對齊。

實例如下:

Markdown 高級技巧

支持的 HTML 元素

不在 Markdown 涵蓋范圍之內的標簽,都可以直接在文檔里面用 HTML 撰寫。

目前支持的 HTML 元素有:<kbd> <b> <i> <em> <sup> <sub> <br>等 ,如:

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

轉義

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

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

Markdown 支持以下這些符號前面加上反斜杠來幫助插入普通的符號:

\   反斜線
`   反引號
*   星號
_   下划線
{}  花括號
[]  方括號
()  小括號
#   井字號
+   加號
-   減號
.   英文句點
!   感嘆號

 

公式

當你需要在編輯器中插入數學公式時,可以使用兩個美元符 $$ 包裹 TeX 或 LaTeX 格式的數學公式來實現。提交后,問答和文章頁會根據需要加載 Mathjax 對數學公式進行渲染。如:

$$
\mathbf{V}_1 \times \mathbf{V}_2 =  \begin{vmatrix} 
\mathbf{i} & \mathbf{j} & \mathbf{k} \\
\frac{\partial X}{\partial u} &  \frac{\partial Y}{\partial u} & 0 \\
\frac{\partial X}{\partial v} &  \frac{\partial Y}{\partial v} & 0 \\
\end{vmatrix}
$$tep1}{\style{visibility:hidden}{(x+1)(x+1)}}
$$

 

更多參考:

https://www.runoob.com/markdown/md-tutorial.html

 

 

 

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM