Markdown For Typora 中文版使用指南

Markdown For Typora 中文版使用指南

5 人贊了文章

一、概述

Markdown誕生自 Daring Fireball之手,點擊這裡可以找到最早版本的語法標準。然而,它的語法標準因解析器和編輯器而異,Typora使用的是GitHub Flavored Markdown標準。

需要注意的是在Markdown中的HTML代碼塊可以被識別但並不會被解析和編譯。同樣要注意的是,保存之後的文檔格式可能會對最初的編寫的文檔格式有所微調。

大綱

[TOC]

二、塊元件

1. 段落和行間隔

段落,顧名思義就是由一行或多行文本組成的,以段為形式的結構。在Markdown語法中,段落間以一行以上的空行作分隔。在Typora中,你只需要按一下Enter就可以插入一個新的段落。

Shift+Enter可以創建一個比段落間距更小的行間距。然而,大多數的Markdown解析器會忽略這個方式創建的行間距,但是你可以通過在這一行的最後插入兩個空格Space或者插入<br/>令解析器強制識別。

2.標題

可以通過在一行的開頭使用1-6個#符號來創建標題,對應1-6個級別的標題。栗如:

# 這是一個一級標題## 這是一個二級標題###### 這是一個六級標題

在Typora中,在標題文本前輸入#,然後按下Enter可以創建一個標題。

3.引用

Markdown使用郵件風格的>符號來創建引用塊。栗如:

> 這是一個由兩個段落組成的引用塊,這是第一個段落。>> 這是第二個段落,愛飯打森,愛乖出台,請曾愛薩菲,撒?,經愛撫,百分賽法。> 這是另一個只有一個段落的引用塊。兩個代碼塊間可以用一空行來分隔。

在Typora中,只需要輸入>之後輸入需要的引用內容就可以生成引用塊格式。Typora在隨後的輸入過程中會自動為你添加>和行間隔。引用塊內的引用也是被允許的,只需要在引用塊內同樣使用>即可。

4. 普通清單

輸入* 清單事項1就會創建一個無序列表,這裡的*符號可以用-+代替。

輸入1. 清單事項1就會創建一個有序列表,它們的語法如下所示:

## 無序列表* 紅色* 綠色* 藍色## 有序列表1. 紅色2. 綠色3. 藍色

5.任務清單

任務清單是一種特殊的列表,列表中的事項用「 」或者「X」分別標記未完成已完成。栗如:

- 「 」一個任務列表事項- 「 」可以有如下格式- 「 」正常 **加粗** @提及 #1234 等- 「 」未完成- 「x」已完成

你可以通過滑鼠點擊事項前的任務框,從而切換任務清單事項中的狀態。

6.代碼塊

Typora僅僅支持GFM的代碼塊,源碼塊是不支持的。[^此處翻譯不確定]使用代碼塊的語法非常簡單,輸入```然後按下Enter 就可以。

另外還可以自定義代碼塊的語言,只需要在 ```後追加輸入所需要的語法名稱後,我們就會通過語法高亮來實現它,栗如:

這是一個栗子:?```function test() { console.log("notice the blank line before this function?");}?```syntax highlighting:?```rubyrequire redcarpetmarkdown = Redcarpet.new("Hello World!")puts markdown.to_html?```

7.數學公式

你可以通過使用MathJax來實現LaTeX的數學符號的表達。

輸入$$,然後按下Enter鍵就會彈出一個支持TeX/LaTeX語法的輸入框,下面是一個栗子:

$$

mathbf{V}_1 imes mathbf{V}_2 = egin{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}

$$

在Markdown源文件中,數學的公式塊是通過利用$$標記借用LaTeX語言來實現的:

$$mathbf{V}_1 imes mathbf{V}_2 = egin{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}$$

8.表格

輸入|標題一|標題二|然後按下Enter將會創建一個有兩個列的表格。

表格創建之後,你會看到一個頂部工具欄也會隨之出現,通過工具欄你可以實現調整大小,增添和刪除表格的功能,你也可以使用

下面的描述可以跳過,因為表格的源碼語法是Typora自動生成的。

在markdown語法中,它們如下所示:

| First Header | Second Header || ------------- | ------------- || Content Cell | Content Cell || Content Cell | Content Cell |

效果如下:

| First Header | Second Header |

| ------------ | ------------- |

| Content Cell | Content Cell |

| Content Cell | Content Cell |

你也可以修飾內部的文本格式,比如鏈接、粗體、斜體、刪除線等。

最後,通過使用冒號你可以實現標題欄文字的對齊功能,比如向左對齊、向右對齊和居中對齊:

| Left-Aligned | Center Aligned | Right Aligned || :------------ |:---------------:| -----:|| col 3 is | some wordy text | $1600 || col 2 is | centered | $12 || zebra stripes | are neat | $1 |

效果如下:

| Left-Aligned | Center Aligned | Right Aligned |

| :------------ | :-------------: | ------------: |

| col 3 is | some wordy text | $1600 |

| col 2 is | centered | $12 |

| zebra stripes | are neat | $1 |

最左側的是向左對齊;最右側的是向右對齊;兩側各一個是居中對齊。

9.腳註

你可以創建一個腳註,如下所示:腳註示範[^這是一個腳註]

上面的語法會編譯成:

腳註示範[^這是一個腳註]

滑鼠移動到這是一個腳註超鏈接可以看到腳註的文本內容。

10.分割線

在一空行輸入***或者--- 然後按下Enter可以創建一條分隔線。


11.YAML Front Matter

Typora現在支持 YAML Front Matter了,在文章的頂部輸入---然後按下Enter就會創建。或者從菜單插入一個元數據塊。

12.目錄

輸入[toc]然後按下Enter就會產生一個自動根據標題和標題等級自動創建的目錄框。

13.示意圖

Typora支持 sequence, flowchart 和 mermaid,之後的版本將會在設置面板中實現設置。

三、實時元件

實時元件將會在你輸入完成後立即解碼和編譯完成。通過滑鼠移動到這些語法元件上會顯示出這些元件的源碼內容,下面就將逐一介紹這些實時元件。

1.鏈接

Markdown支持兩種類型的鏈接:直連鏈接和間接鏈接。

在上面兩種鏈接類型中,鏈接文本都用[方框]來定義。

通過在[ ]後追加帶有鏈接地址的( )來創建一個直接鏈接。在括弧中,插入你需轉到的網址鏈接,還可以在鏈接後追加一個"文本"來自定義所通往鏈接的網站標題。栗子如下:

這是一個[栗子](http://example.com/ "栗子網站")網站的鏈接實例。這個[栗子](http://example.com/)沒有網站標題。

上面語法效果如下:

這是一個栗子網站的鏈接實例。

這個栗子沒有網站標題。

1).內部鏈接

你可以把( )中的鏈接換成所在文檔的標題,這樣通過點擊這個鏈接就能實現文檔內部的跳轉。

例如:

Ctrl(在Mac上是Command)+ Click 這個鏈接就會跳轉到標題二、塊元素。如果你想看這是怎麼做到的,你可以將滑鼠移動到這個鏈接然後點擊就可以看到此鏈接方式的markdown的語法結構。

2).引用鏈接

引用類型的鏈接會使用第二個[ ]用來放置一個對應相應鏈接地址的標籤,栗子如下:

這是個引用鏈接的[栗子][id]呦。然後,你需要在文檔的任何位置對標籤作出有效的定義。[id]:http://example/com/ "可選標題"

效果如下:

這是個引用鏈接的栗子呦。

然後,你需要在文檔的任何位置對標籤作出有效的定義。

另一種簡潔的語法可以使用文本本身作為鏈接的名稱,因而允許忽略掉鏈接的名稱也可以實現地址追蹤,所以第二個[ ]只需要空著就好了,但是還是需要對文本本身作出定義以提供追蹤地址。

[baidu][]然後輸入對文本本身的定義:[baidu]:http://baidu.com/

在Typora中,Click鏈接就會展開語法結構供你編輯,Ctrl + Click會在內置瀏覽器中此超鏈接。

2.URLs

Typora允許你插入urls作為鏈接內容,用<括弧>修飾。

<i@typora.io>就變成如下效果:i@typora.io。

Typora也支持鏈接標準的URLs,栗如:

3.圖片

圖片也類似鏈接,但是需要額外的符號!放置在這一行的最開頭。圖片的語法結構如下所示:

![圖片名稱](/path/to/img.jpg)![圖片名稱](/path/to/img.jpg "可選名字")

你也可以使用drag&drop動作從圖片文件或者網頁瀏覽器實現插入圖片的操作。隨後可以通過點擊圖片來編輯語法的源碼達到進一步修飾圖片的效果。如果圖片文件和所編輯的markdown文檔在相同目錄或亞目錄則drop&drop操作會自動生成對應的相對路徑。

如果你想查看更多插入圖片的技巧,請閱讀 support.typora.io//Imag

4.斜體

Markdown識別*_作為斜體語法的標識。用一個*_修飾的文本會有一個HTML的標籤<em>,栗如:

*一個乘號*_一個下劃線_

效果如下:

一個乘號

一個下劃線

GFM會忽視掉文本中的下劃線,而下劃線在編碼和名字中使用普遍,栗如:

wow_great_stuff

do_this_and_do_that_and_another_thing.

另一需要注意的問題是如果你需要*_本身而不想讓它編譯成此處的強調標識,你可以使用來免除編譯,栗如:

*這個文本是被乘號修飾的,但是但不會變成斜體*

效果如下:

*這個文本是被乘號修飾的,但是但不會變成斜體*

附:Typora推薦使用*符號。

5.強調

兩個*或者_連用就會產生一個HTML標籤<strong>實現強調加粗的效果。

**兩個乘號連用**__兩個下劃線連用__

效果如下:

兩個乘號連用兩個下劃線連用

附:Typora推薦使用*符號。

6.代碼

想要創建一個實時顯示的代碼,用兩個` ``符號修飾就可以了。不像預格式化的代碼塊,這裡的實時代碼使用正常的段落來表達代碼形式。栗如:

使用 `printf()`功能。

效果如下:

使用 printf()功能。

7.刪除線

GFM增添了使用符號添加刪除線的語法,而標準的Markdown無此功能。

~~錯誤的文本~~ 顯示為 ~~錯誤的文本~~。

8.下劃線

下劃線功能由來源HTML的標籤代碼實現。

<u>下劃線</u> 顯示為下劃線

9.表情

輸出表情需要藉助 符號。

栗子::smile 顯示為 :smile:。

使用者可以通過使用ESC鍵觸發表情建議補全功能,也可在功能面板啟用後自動觸發此功能。同時,直接從菜單欄Edit -> Emoji & Symbols插入UTF8表情符號也是可以的。

10.HTML

Typora不能使用HTML元素,但是Typora可以解析和編譯非常有限的HTML元素,作為Markdown功能的補充,這些有限的功能包括:

  • 下劃線: <u>underline</u>
  • 圖片:<img src="http://www.w3.org/html/logo/img/mark-word-icon.png" width_="200px" />(HTML標籤中的width, height 以及屬於樣式的width, height, zoom樣式可以被識別和應用。)
  • 評論:<!-- This is some comments -->
  • 超鏈接: <a href="http://typora.io" target="_blank">link</a>

大多數這些屬性、樣式或分類會被忽略。對其他的標籤,Typora會將它們以HTML片段的形式表達。

11.行內嵌數學符號

想要使用這個功能,需要在設置面板的 Markdown欄啟用它。然後使用$來啟動TeX命令,栗如:$lim_{x o infty} exp(-x) = 0$ 會以LaTeX的命令形式表達出來。

為了觸發行內內嵌數學符號的實時編譯你需要:輸入$然後按下ESC鍵之後輸入TeX命令,之後就會彈出一個如圖所示的工具提示欄:

12.下標

想要使用這個功能,需要在設置面板的 Markdown 欄啟動它,之後使用~來修飾下標文本。栗如:

H~2~OX~long text~ 顯示為 H~2~O 和X~long text~ 。

#### 13.上標

想要使用這個功能,需要在設置面板的 Markdown 欄啟動它,之後使用^來修飾下標文本。栗如:

X^2^ 顯示為 X^2^ 。

14.高亮

想要使用這個功能,需要在設置面板的Markdown 欄啟動它,之後使用==來修飾高亮文本,栗如:

==highlight== 顯示為 ==highlight== 。


translated by zhen__dong


推薦閱讀:

TAG:Typora | Markdown語法 |