Markdown 由 Daring Fireball 創造;原指導文檔在 這裏。然而,與大多數解釋器 / 編輯器不一樣的是,Typora 採用的是 Github 推薦的 Markdown。css
一個段落是簡單的一行或者多個的連續行。在 markdown 源碼中,段落被兩個或多個空白行分隔。在 Typora 中,你僅須要一個空白行便可(按一次 Return
)建立一個新段落。html
按住 Shift
+ Return
能夠僅建立一次換行。大多數其餘 markdown 解釋器會忽略單獨換行,因此爲了讓其餘 markdown 解釋器識別你的換行,你能夠在一行的結束留兩個空格,或插入 <br/>
。git
標題爲在一行的開始使用 1-6 個 #
號,對應爲 1-6 級標題。例如:github
# This is an H1
## This is an H2
###### This is an H6
複製代碼
在 Typora 中,在標題前輸入 #
,而後按 Return
鍵建立一個標題。編程
Markdown 使用 email 風格的 > 符號進行塊引用。以下所示:瀏覽器
> This is a blockquote with two paragraphs. This is first paragraph.
> > This is second pragraph. Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
> This is another blockquote with one paragraph. There is three empty line to seperate two blockquote.
複製代碼
在 Typora 中輸入 >
而後緊跟你的引用內容將會生成一個引用塊。Typora 能夠爲你繼續插入一個 >
符號或者爲一個換行。嵌套塊引用(一個塊引用嵌套在另外一個塊引用中)經過添加高一級的 >
。ruby
輸入 * list item 1
將會建立一個無序列表 —— *
符號能夠用 +
或 -
替代。markdown
輸入 1. list item 1
將會建立一個有序列表。markdown 源碼以下所示:編輯器
## un-ordered list
* Red
* Green
* Blue
## ordered list
1. Red
2. Green
3. Blue
複製代碼
任務列表是經過符號 [] 或 [x](未完成或完成)進行標記的列表。例如:ide
- [ ] a task list item
- [ ] list syntax required
- [ ] normal **formatting**, @mentions, #1234 refs
- [ ] incomplete
- [x] completed
複製代碼
你能夠經過點擊標籤前的檢查框進行勾選來改變完成 / 未完成狀態。
Typora 僅支持 GitHub Flavored Markdown (GFM) 的代碼塊(fences)。原始 markdown 的代碼塊不支持。
使用 fences 是很是簡單的:輸入 ``` 而後按 return
鍵。添加一個可選的語言標識符在 ``` 以後可打開語法高亮:
Here's an example:
``` function test() { console.log("notice the blank line before this function?"); } ``` syntax highlighting: ```ruby require 'redcarpet' markdown = Redcarpet.new("Hello World!") puts markdown.to_html ``` 複製代碼
你可以使用 MathJax 提供 LaTeX 數學表達式。
添加一個數學表達式,輸入 $$
而後按回車鍵。將建立一塊用以接收 Tex/LaTex 源碼的輸入區域。例如:
在 markdown 源文件中,數學公式塊是被一對 ‘$$’ 標記所包圍的一個 LaTeX 表達式:
$$
\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 Header | Sceond Header |
而後按 return
鍵,將建立一個具備兩列的表格。
在一個表被建立後,點擊該表能夠打開工具欄,用以重設表格大小,列對齊方式或刪除。一樣可使用上下文菜單複製和添加 / 刪除單獨的行 / 列。
建立表的所有語法以下所示,可是沒必要了解全部的語法細節由於 Typora 能夠自動生成 Markdown 表格的源代碼。
在 Markdown 源代碼,語法以下所示:
| 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 |
複製代碼
冒號在最左邊表示左對齊;冒號在最右邊表示右對齊;冒號在兩邊表示居中對齊。
You can create footnotes like this[^footnote].
[^footnote]: Here is the *text* of the **footnote**.
複製代碼
將產生:
你能夠像這樣創見腳標 [1]。
鼠標停留在在 footnote
能夠看到該腳標的內容。
在空白行輸入 ***
或 ---
而後按 return
鍵將建立一條水平分割線。
Typora 如今支持 YAML Front Matter。在文章頂部輸入 ---
而後按 Return
鍵將引入一個元數據塊。另外,你能夠從 Typora 菜單欄插入一個元素據塊。
輸入 [toc]
而後按 Return
鍵,將建立一個目錄。TOC 提取文檔內的全部標題,而後自動在該文檔首部造成一個目錄。
Span 元素在輸入後將被當即解析和顯示。將鼠標移動到這些 span 元素上將會顯示這些元素的源代碼。下面是每一個 span 元素的語法。
Markdown 支持兩種方式的連接:內聯連接和引用連接。
在兩種形式中,連接文本都被包含在 [] 中。
建立內聯連接,是在連接文本的方括號後緊跟一對小括號,用以放入一個你想指向的連接的 URL,和一個可選的用引號包圍的連接標題。以下:
This is [an example](http://example.com/"Title") inline link.
[This link](http://example.net/) has no title attribute.
複製代碼
將會建立:
This is an example inline link. (<p>This is <a href="http://example.com/"title="Title">
)
This link has no title attribute. (<p><a href="http://example.net/">This link</a> has no
)。
你能夠設置 href 連接至標題,將建立一個容許你點擊後跳轉至目的區域的連接。例如:
Command(Windows: Ctrl) + 點擊 [此連接](#Block 元素) 將跳轉至標題 Block 元素
。點擊該連接將顯示 markdown 源碼。
引用連接使用兩對方括號,包括一個你選擇用來標識該連接的標籤:
This is [an example][id] reference-style link.
Then, anywhere in the document, you define your link label on a line by itself like this:
[id]: http://example.com/ "Optional Title Here"
複製代碼
在 Typora 中, 以下顯示:
This is an example reference-style link.
當連接文本和連接標籤相同時,可省略第二個方括號內的連接標籤。例如,只要用一對空方括號,就可將單詞 "Google" 連接至 google.com:
[Google][]
And then define the link:
[Google]: http://google.com/
複製代碼
在 Typora 中,點擊該連接能夠進行修改,而且 command+click 將在你的瀏覽器中打開此超連接。
Typora 容許你插入 URLs 做爲連接, 使用 <>
將該 URLs 包圍便可。
<i@typora.io>
顯示爲 i@typora.io 。
Typora 可爲標準 URLs 自動產生連接。例如:www.google.com。
圖片和連接具備類似的語法,只須要在連接的語法前加入一個額外的 !
。圖片插入的語法以下所示:
![Alt text](/path/to/img.jpg)
![Alt text](/path/to/img.jpg"Optional title")
複製代碼
你能夠從一個圖片文件或者你的網頁瀏覽器中經過拖/放的方式插入一個圖片。經過點擊此圖片即可修改 markdown 源碼。若是此圖片是經過拖/放方式插入的,而且屬於你正在編輯文檔的目錄或者子目錄,Typora 將會採用相對路徑。
Markdown 將星號 *
和下劃線 _
做爲斜體的標識符。被星號和下劃線包圍的文本就和被 HTML 中的 em
標籤包圍的文本效果同樣。例如:
*single asterisks*
_single underscores_
複製代碼
輸出:
single asterisks
single underscores
GFM 將會忽略普遍使用在編程和命名中的單詞的下劃線,例如:
wow_great_stuff
do_this_and_do_that_and_another_thing.
爲了表示一個文本的星號或者下劃線,你可使用 \ 進行轉義:
\*this text is surrounded by literal asterisks\*
複製代碼
Typora 推薦使用 *
符號。
兩對 *
或 _
可使其包圍的內容加粗,就和被 HTML 的 <strong>
標籤包圍的效果同樣。
**double asterisks**
__double underscores__
複製代碼
輸出:
double asterisks
double underscores
Typora 推薦使用 **
符號。
爲了表示行內代碼片,使用右單引號(`)。不像格式化代碼塊,一個代碼片是在一個正常段落中顯示的,例如:
Use the `printf()` function.
複製代碼
將產生:
Use the printf()
function.
GFM 包含了爲文本添加刪除線的語法,此語法在標準 Markdown 語法不存在。
~~Mistaken text.~~
顯示爲 Mistaken text.
下劃線使用原生 HTML 語法。
<u>Underline</u>
顯示爲 Underline.
使用語法 :smile
輸入 emoji 表情。
用戶能夠經過按下 ESC
鍵啓用 emoji 的自動補全建議,或在首選項中啓用。在(macOS)菜單欄中 Edit
-> Emoji & Symbols
,直接輸入 UTF-8 emoji 字符一樣是被支持的。
使用該特性前,請先打開 Preference
Panel -> Markdown
Tab。而後使用 $
包圍一個 TeX 命令。例如: $\lim_{x \to \infty} \exp(-x) = 0$
將被視爲一個 LaTeX 命令。
爲行內數學公式開啓行內預覽:輸入 "$",而後按下 ESC
鍵,而後輸入一個 TeX 命令。
你能夠在這裏找到更多細節 here。
使用該特性前,先打開 Preference
Panel -> Markdown
Tab,而後使用 ~
包圍下標內容,例如: H~2~O
, X~long\ text~
。
使用該特性前,先打開 Preference
Panel -> Markdown
Tab,而後使用 ^
包圍上標內容,例如: X^2^
。
使用該特性前,先打開 Preference
Panel -> Markdown
Tab,而後使用 ==
包圍高亮內容,例如: ==highlight==
。
當純 Markdown 語法不支持時,你可使用 HTML 個性化內容。例如:使用 <span style="color:red">this text is red</span>
將文本設置爲紅色。
一些網站提供基於 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>
複製代碼
你可使用 <video>
HTML 標籤插入視頻。例如:
<video src="xxx.mp4"/>
複製代碼
你能夠在這裏找到更多細節 here.
Here is the text of the footnote. ↩︎