Markdown For Typora中文文檔


work by Albert


Markdown For Typora1

概述

Markdown是由Daring Fireball所編寫;它的最初的使用說明書在這裏。但是,它的語法、變量在不同的解析器和編輯器中是不同的。Typora使用GitHub Flavored Markdown

塊元素

段落和句子的斷開

簡單來說,一個段落是一句話或者是多個連續句子的組合。在Markdown的源碼中,段落是由兩條或者兩條以上的空行來分割的。在Typora中,只需要一個空行(按一下回車鍵)就可以創建一個新的段落了。

Shift+Enterke可以創建一個單獨的行分隔符(不同於段分割符)。大多數的Markdown解析器會忽略單行作爲分隔符,因此爲了使其他的Markdown解析器能夠識別你的行分隔符,你可以在行的末尾留兩個空行,或者插入<br/>

標題

對於標題的設置由1-6個hash(#)符號作爲行的開始,對應於標題文字的六個等級。如下,

#  這是一級標題

## 這是二級標題

####### 這是六級標題

在Typora中,輸入’#'加上標題內容,再按下回車鍵就可以成功創建標題了。

塊引用

Markdown使用電子郵件風格的>符來創建塊引用。如下:

> 這是含有兩個段落的塊引用。這是第一段。
> 
>這是第二段。盡是些看不懂的話


>這是含有一個段落的另一個塊引用。兩個塊引用之間用三個空行來分割。

效果如下:

這是含有兩個段落的塊引用。這是第一段。

這是第二段。盡是些看不懂的話

這是含有一個段落的另一個塊引用。兩個塊引用之間用三個空行來分割。

在Typora中,輸入符’>‘加上所用引用的內容會生成一個引用塊。Typora隨後會爲你插入一個合適的’>‘或者行分隔符。嵌套的塊引用(在一個塊引用中嵌入另一個塊引用)是通過增加額外的’>'來實現。

列表

輸入*list item 1會創建一個無序列表——*符可以用+或者-替代。

輸入*1. list item 1會創建一個有序列表——它們的markdown源碼如下:

**無序列表**
* Red
* Green
* Blue

**有序列表**
1. Red
2. Green
3. Blue

顯示效果如下:

無序列表

  • Red
  • Green
  • Blue

有序列表

  1. Red
  2. Green
  3. Blue

任務列表

任務列表可以用來標記[]或者[x] (分別代表未完成和完成)。如下:

- [ ] a task list item
- [ ] list syntax required
- [ ] normal **formattong**,@mentions,#1234
refs
- [ ] incomplete
- [x] completed

顯示效果如下:

  • a task list item
  • list syntax required
  • normal formattong,@mentions,#1234
    refs
  • incomplete
  • completed

你可以通過點擊內容前的檢查框來改變完成/未完成狀態。

(Fenced)代碼塊

Typora只支持GitHub Flavored Markdown中的圍欄。不支持Markdown中的原始代碼塊。

使用圍欄的方法很簡單:輸入並按下`enter`。在之後添加語言的名稱,Markdown會對代碼中的關鍵字進行高亮:

舉個例子:

​```
function test() {
  console.log("notice the blank line before this function?");
}
​```

語法高亮:
​```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
​```

顯示效果如下:

舉個例子:

function test() {
  console.log("notice the blank line before this function?");
}

語法高亮:

require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html

數學塊

用戶可以使用MathJax來渲染LaTeX數學表達式。

輸入$$然後按enter鍵,可以添加數學表達式。上述命令會觸發一塊能接受Tex/LaTex表達式的區域。例如:
v1×v2=ijkXuYu0XvYv0 \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}
更多細節可以在這裏查詢。

表格

輸入| First Hesder | Second Header |並按下enter鍵。上述操作會創建一個有兩列的表格。

在表格被創建之後,表格會打開一個工具條。使用該工具條可以實現表格的重塑、對齊和刪除。你也可以使用語境目錄來複制和添加/刪除獨立的列/行。

創建一個表格的所有語法如下,但是沒有必要去知道所有詳細的語法。因爲生成一個表格的markdown源碼會有Typora自動生成。

在markdown的源碼中,生成表格的源碼如下:

|	first Header	|	Second Header	|
|-------------------|-------------------|
|	Content Cell	|	Content Cell	|
|	Content Cell	|	Contnet Cell	|

顯示效果如下:

first Header Second Header
Content Cell Content Cell
Content Cell Content Cell

在表格中依舊可以使用在線Markdown比如,鏈接、加粗,斜體,或者刪除線。

最後,通過在表頭行中添加冒號(:)可以實現文字在表格中的左對齊,右對齊或者中間對齊:

|	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

腳註

我們可以像這樣來創建腳註[^腳註].
[^腳註]:Here is the *text* of the **footnote**.

顯示效果如下:

我們可以像這樣來創建腳註2.

將鼠標懸停在’腳註‘上標上可以查看腳註的內容。

水平分隔線

在空白行輸入***或者---並按下enter鍵將會畫出一條水平線。

***

顯示效果如下:


YAML Front Matter

Typora現在支持YAML Front Matter。在文章的頂部輸入---然後按下enter鍵會引出一個元數據塊。或者,用戶也可以在Typora的頂端目錄插入元數據區。

目錄表格(TOC)

輸入[TOC]並按下enter鍵。上述操作會創建一個“目錄表格”部分。TOC會從文檔中提取出所有的標題,它的內容會隨着用戶向文檔增加內容而自動更新。

延展性元素

在輸入之後延展性元素會被正確的解析和渲染。將光標移到那些延展性元素中間會將這些元素拓展到markdown源。接下來是對於每一個延展性元素的語法解釋。

鏈接

Markdown支持兩種風格的鏈接:行內式和參考式。

在兩種風格的鏈接中,鏈接文字都被寫在[方括號]中。以及作爲鏈接可選項的標題,標題由引號引起開。例如:

這是一個行內鏈接的[例子](http://example.com/ "Title")。

這個[例子](http://example.com/)沒有標題這個量。

顯示效果如下:

這是一個行內鏈接的例子

這個例子沒有標題這個量。

行內鏈接

用戶可以設置一個指向標題的herf。這個可以創造一個允許你在點擊之後跳向所指向的那部分。
例如:

(在Windows系統中)Ctrl+點擊這個鏈接將會跳轉到標題BlockElements。讀者可以按住Ctrl鍵並點擊該鏈接來查看該元素的markdown源碼,以學習如何編寫該操作。

參考鏈接

參考鏈接會用到兩個方括號,在第二個方括號中放入你所選擇的指向特定鏈接的標籤。

這是一個關於參考式鏈接的[例子][id]。

之後,你可以在文檔的任意一個地方,定義你的鏈接標籤,如下:
[id]:http://example.com/  "Optional Title Here"

渲染效果如下:

這是一個關於參考式鏈接的例子

之後,你可以在文檔的任意一個地方,定義你的鏈接標籤,如下:

這之中含蓄的鏈接名便捷方法可以讓你略去鏈接的名稱,在這種情況下,鏈接的本身是用它的名字來代替的。也將對二個方括號置空——例如,將單詞‘Google’鏈接到google.com,你可做如下操作:

[Google][]
之後再定義鏈接:

[Google]:http://google.com/

渲染效果如下:

Google
之後再定義鏈接:

在Typora中,點擊鏈接會將它拓展開用於編輯。ctrl+點擊會在瀏覽器中打開這個超鏈接。

URLs

Typora允許用戶插入URLs作爲鏈接,用<尖括號>括起來。

<[email protected]>會變成[email protected]

Typora會自動的鏈接標準的URLs,例如:www.google.com

圖片

圖片的引用於鏈接的語法相似,但是它們需壓在鏈接的開頭添加一個!符。插入一張照片的語法如下:

![隨機](C:\Users\admin\Desktop\pic.png)
![隨機](C:\Users\admin\Desktop\pic.png title")

顯示效果如下:

[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-2SsqaGEo-1580115223928)(C:\Users\admin\Desktop\pic.png)]
[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-LGEZuyg7-1580115223933)(C:\Users\admin\Desktop\pic.png “title”)]

你可以利用drag&drop從本地的圖像文件加或者你的瀏覽器插入一張圖片。你可以通過點擊圖片來修改markdown源碼。如果被添加的圖片和你正在編輯的文件是在相同的目錄或者子目錄下可以使用相對路徑。

如果你使用markdown來搭建網站,你可以在你的本地計算機上以YAML Front Mater的形式設置typora-root-url屬性,來爲圖片的預覽指定一個URL前綴。例如,以YAML Front Matter形式輸入typora-root-url:/User/Abner/website/typora.io/,之後![alt](/blog/img/test.png)將等同於![alt](file:///User/Abner/website/typora.io/blog/img/test.png)

你可以在這裏查詢更多的信息。

強調

Markdown將星號(*)和下劃線(_)作爲強調的符號。由一個*或者_包裹的文字將會使用HTML<em>標籤進行包裝。例如,

*一顆星*
_一條下劃線_

渲染效果如下:

一顆星
一條下劃線

GMF會在單詞中忽略下劃線,它常用代碼和名稱,如下:

wow_great_stuff

do_this_and_do_that_and_another_thiing.

如果想要在某個位置單純輸入星號或者下劃線,在這裏你除了可以利用強調界定符,還可以使用反斜槓進行轉義:

\*這是一句被單純的星號包圍的句子。\*

效果如下:

*這是一句被單純的星號包圍的句子。*

Typora推薦使用*標誌。

加粗

被兩顆星*或者兩個下劃線_包裹的文字內容會被HTML的<strong>標籤包裝,例如:

**兩顆星**
__兩條下劃線__

渲染效果如下:

兩顆星
兩條下劃線

代碼

我們可以使用反引號(`)來標明行內的代碼條。和之前的預格式化的代碼塊不同,被標明的代碼條實在普通的段落中的。例如,

使用`print()`函數

渲染效果如下:

使用print()函數

刪除線

GFM添加了刪除線的語法,這在標準的Markdown中是不存在的。

~~錯誤文字~~會變成 錯誤文字

下劃線

對於下劃線的支持是來自於原生的HTML。

<u>下劃線</u>會變成下劃線

Emoji😄

輸入emoji的語法是::smile:。

用戶可以通過按esc鍵來觸發對於emoji的自動補全建議。通過(macOS)菜單欄Edit->Emoji & Symbol直接輸入UTF-8emoji符號也是支持的。

行內數學式

想要使用該功能,首先應在偏好設置->markdown中確認它存在。然後利用$來包裹Tex命令。例如:$\lim_{x\to\infty}\exp(-x)=0$將會被渲染成LaTex命令。

在先預覽行內數學式的方法是:輸入“$”,然後按下ESC鍵,再輸入Tex命令。

讀者可以在這裏瞭解更多詳細信息。

下標

想要使用該功能,首先應在偏好設置->markdown中確認它存在。然後使用~來包裝下標內容。例如:H~2~o,X~long\ text~/

上標

想要使用該功能,首先應在偏好設置->markdown中確認它存在。然後使用^來包裝上標內容。例如,X^2^

高亮

想要使用該功能,首先應在偏好設置->markdown中確認它存在。然後使用==來包裝上標內容。例如,==高亮==

嵌入內容

一些網站提供基於iframe的嵌入式代碼,用戶可以將其粘貼到Typora中。例如:

<iframe height='265' scrolling='no' title='Fancy Animated SVG Menu' src='http://codepen.io/jeangontijo/embed/OxVywj/?height=265&theme-id=0&default-tab=css,result&embed-version=2' frameborder='no' allowtransparency='true' allowfullscreen='true' style='width: 100%;'></iframe>

視頻

用戶可以利用HTML中的<video>標籤來插入視頻文件。例如:

<video src="xxx.mp4" />

其他的HTML支持

讀者可以在這裏瞭解更多詳細信息。


  1. 本文內容是Typora官方參考文檔的翻譯。因本人水平有限,文中可能存在不足之處,望指正。 ↩︎

  2. Here is the text of the footnote. ↩︎

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章