Markdown For Typora

Overview

Markdown is created by Daring Fireball; the original guideline is here. Its syntax, however, varies between different parsers or editors. Typora is using GitHub Flavored Markdown.

Block Elements

Paragraph and line breaks

A paragraph is simply one or more consecutive lines of text. In markdown source code, paragraphs are separated by two or more blank lines. In Typora, you only need one blank line (press Return once) to create a new paragraph.

Press Shift + Return to create a single line break. Most other markdown parsers will ignore single line breaks, so in order to make other markdown parsers recognize your line break, you can leave two spaces at the end of the line, or insert <br/>.

Headers

Headers use 1-6 hash (#) characters at the start of the line, corresponding to header levels 1-6. For example:

# This is an H1## This is an H2###### This is an H6

In Typora, input ‘#’s followed by title content, and press Return key will create a header.

Blockquotes

Markdown uses email-style > characters for block quoting. They are presented as:

> 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.

In Typora, inputting ‘>’ followed by your quote contents will generate a quote block. Typora will insert a proper ‘>’ or line break for you. Nested block quotes (a block quote inside another block quote) by adding additional levels of ‘>’.

Lists

Input * list item 1 will create an unordered list - the * symbol can be replace with + or -.

Input 1. list item 1 will create an ordered list - their markdown source code is as follows:

## un-ordered list
*   Red
*   Green
*   Blue## ordered list
1.  Red
2.  Green
3.  Blue

Task List

Task lists are lists with items marked as either [ ] or [x] (incomplete or complete). For example:

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

You can change the complete/incomplete state by clicking on the checkbox before the item.

(Fenced) Code Blocks

Typora only supports fences in GitHub Flavored Markdown. Original code blocks in markdown are not supported.

Using fences is easy: Input ``` and press return. Add an optional language identifier after ``` and we’ll run it through syntax highlighting:

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
​```

Math Blocks

You can render LaTeX mathematical expressions using MathJax.

To add a mathematical expression, input $$ and press the ‘Return’ key. This will trigger an input field which accepts Tex/LaTex source. For example:

V1×V2=∣ijk∂X∂u∂Y∂u0∂X∂v∂Y∂v0∣\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} V1​×V2​=∣∣∣∣∣∣​i∂u∂X​∂v∂X​​j∂u∂Y​∂v∂Y​​k00​∣∣∣∣∣∣​

In the markdown source file, the math block is a LaTeX expression wrapped by a pair of ‘$$’ marks:

$$
\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}
$$

You can find more details here.

Tables

Input | First Header | Second Header | and press the return key. This will create a table with two columns.

After a table is created, putting focus on that table will open up a toolbar for the table where you can resize, align, or delete the table. You can also use the context menu to copy and add/delete individual columns/rows.

The full syntax for tables is described below, but it is not necessary to know the full syntax in detail as the markdown source code for tables is generated automatically by Typora.

In markdown source code, they look like:

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

You can also include inline Markdown such as links, bold, italics, or strikethrough in the table.

Finally, by including colons (:) within the header row, you can define text in that column to be left-aligned, right-aligned, or center-aligned:

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

A colon on the left-most side indicates a left-aligned column; a colon on the right-most side indicates a right-aligned column; a colon on both sides indicates a center-aligned column.

Footnotes

You can create footnotes like this[^footnote].[^footnote]: Here is the *text* of the **footnote**.

will produce:

You can create footnotes like this¹.

Hover over the ‘footnote’ superscript to see content of the footnote.

Horizontal Rules

Inputting *** or --- on a blank line and pressing return will draw a horizontal line.

---

YAML Front Matter

Typora now supports YAML Front Matter. Input --- at the top of the article and then press Return to introduce a metadata block. Alternatively, you can insert a metadata block from the top menu of Typora.

Table of Contents (TOC)

Input [toc] and press the Return key. This will create a “Table of Contents” section. The TOC extracts all headers from the document, and its contents are updated automatically as you add to the document.

Span Elements

Span elements will be parsed and rendered right after typing. Moving the cursor in middle of those span elements will expand those elements into markdown source. Below is an explanation of the syntax for each span element.

Links

Markdown supports two styles of links: inline and reference.

In both styles, the link text is delimited by [square brackets].

To create an inline link, use a set of regular parentheses immediately after the link text’s closing square bracket. Inside the parentheses, put the URL where you want the link to point, along with an optional title for the link, surrounded in quotes. For example:

This is [an example](http://example.com/ "Title") inline link.[This link](http://example.net/) has no title attribute.

will produce:

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)

Internal Links

You can set the href to headers, which will create a bookmark that allow you to jump to that section after clicking. For example:

Command(on Windows: Ctrl) + Click This link will jump to header Block Elements. To see how to write that, please move cursor or click that link with ⌘ key pressed to expand the element into markdown source.

Reference Links

Reference-style links use a second set of square brackets, inside which you place a label of your choosing to identify the link:

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"

In Typora, they will be rendered like so:

This is an example reference-style link.

The implicit link name shortcut allows you to omit the name of the link, in which case the link text itself is used as the name. Just use an empty set of square brackets — for example, to link the word “Google” to the google.com web site, you could simply write:

[Google][]
And then define the link:[Google]: http://google.com/

In Typora, clicking the link will expand it for editing, and command+click will open the hyperlink in your web browser.

URLs

Typora allows you to insert URLs as links, wrapped by <brackets>.

<i@typora.io> becomes i@typora.io.

Typora will also automatically link standard URLs. e.g: www.google.com.

Images

Images have similar syntax as links, but they require an additional ! char before the start of the link. The syntax for inserting an image looks like this:

![Alt text](/path/to/img.jpg)![Alt text](/path/to/img.jpg "Optional title")

You are able to use drag & drop to insert an image from an image file or your web browser. You can modify the markdown source code by clicking on the image. A relative path will be used if the image that is added using drag & drop is in same directory or sub-directory as the document you’re currently editing.

If you’re using markdown for building websites, you may specify a URL prefix for the image preview on your local computer with property typora-root-url in YAML Front Matters. For example, input typora-root-url:/User/Abner/Website/typora.io/ in YAML Front Matters, and then ![alt](/blog/img/test.png) will be treated as ![alt](file:///User/Abner/Website/typora.io/blog/img/test.png) in Typora.

You can find more details here.

Emphasis

Markdown treats asterisks (*) and underscores (_) as indicators of emphasis. Text wrapped with one * or _ will be wrapped with an HTML <em> tag. E.g:

*single asterisks*_single underscores_

output:

single asterisks

single underscores

GFM will ignore underscores in words, which is commonly used in code and names, like this:

wow_great_stuff

do_this_and_do_that_and_another_thing.

To produce a literal asterisk or underscore at a position where it would otherwise be used as an emphasis delimiter, you can backslash escape it:

\*this text is surrounded by literal asterisks\*

Typora recommends using the * symbol.

Strong

A double * or _ will cause its enclosed contents to be wrapped with an HTML <strong> tag, e.g:

**double asterisks**__double underscores__

output:

double asterisks

double underscores

Typora recommends using the ** symbol.

Code

To indicate an inline span of code, wrap it with backtick quotes (`). Unlike a pre-formatted code block, a code span indicates code within a normal paragraph. For example:

Use the `printf()` function.

will produce:

Use the printf() function.

Strikethrough

GFM adds syntax to create strikethrough text, which is missing from standard Markdown.

~~Mistaken text.~~ becomes Mistaken text.

Underlines

Underline is powered by raw HTML.

<u>Underline</u> becomes Underline.

Emoji

【Tools】MarkDown教程(六)-Markdown Reference相关推荐

1. 【Tools】MarkDown教程(三)-MarkDown表格和公式

   00. 目录 文章目录 00. 目录 01. 表格 02. 表格对齐方式 03. 行内公式 04. 陈列公式 05. MathJax语法 06. 常用数学运算符表 07. 附录 01. 表格 Mark ...

2. 【Tools】MarkDown教程(一)-MarkDown简介

   00. 目录 文章目录 00. 目录 01. 什么是MarkDown 02. MarkDown优点 03. MarkDown缺点 04. MarkDown资源 05. 附录 01. 什么是MarkDo ...

3. Markdown语法文档，Markdown教程，Markdown语法大全，

   写在前面 最近一段时间学习的同时也在做一些笔记,想着将笔记发布出来加深印象并能够方便查找,看了一些大佬的文章后,不得不感慨大佬们编写文章的整洁度和可读性,因此经过仔细斟酌后,只有Markdown才是用 ...

4. 【Tools】MarkDown教程(二)-MarkDown基本语法

   00. 目录 文章目录 00. 目录 01. 文本格式化 1.1 粗体和斜体 1.2 删除线 1.3 标题 1.4 引用 1.5 嵌套引用 02. 代码格式化 2.1 行内代码 2.2 区块代码 03 ...

5. 【Tools】MarkDown教程(四)-MarkDown中的UML图

   00. 目录 文章目录 00. 目录 01. 序列图示例 02. 序列图语法 03. 流程图示例 04. 流程图语法 05. Gravizo 06. 甘特图样例 07. 其它参考示例 7.1 UML标 ...

6. 【Tools】MarkDown教程(八)-Typora使用完全手册

   00. 目录 文章目录 00. 目录 01. Markdown简介 02. Typora简介 03. Typora设置简介 04. Typora智能标点 05. Typora图片插入 06. Typo ...

7. mac最好用的markdown_Markdown 语法简明教程 amp; Markdown 编辑器推荐

   什么是 Markdown? Markdown 是一种轻量级的纯文本标记语言,它允许我们 "使用易读易写的纯文本格式编写文档,然后将其转换成具有一定格式的 HTML 文档展示出来". ...

8. Markdown教程--Markdown代码

   Markdown教程–Markdown代码 如果是段落上的一个函数或片段的代码可以用反引号把它包起来(`),例如: `printf()` 函数 显示结果如下: 代码区块 代码区块使用 4 个空格或者一 ...

9. 最全Markdown教程

   最全Markdown教程 Markdown语法 编辑器选择以及图床配置 用VSCode+PicGo+AliyunOss搭建Markdown图床 VSCode+PicGo+Github搭建Markdow ...

最新文章

1. Docker中的“公开”和“发布”有什么区别？
2. vi vim常用命令
3. 简单的C++程序求圆的周长和面积
4. Linux监控命令之 top
5. java非递归_Java非递归文件系统走路
6. 湖北汽车工业学院c语言程序设计 汽车零部件采购管理程序,湖北汽车工业学院c语言课程设计实验报告(采购信息管理系统).docx...
7. canvas 粒子效果 - 手残实践纪录
8. 基于modelsim的十个Verilog入门试验程序（1）（7人表决器+算术逻辑单元）—程序+测试代码+波形+结果分析
9. Mac:Split文件分割命令
10. 网站后端开发遇到的问题PHP,谁能帮我检查一下PHP网站后台开发这个问题是什么原因啊？...
11. Linux-iptables初识
12. 数据库的开窗函数学习
13. 利用蒙特卡洛模拟求积分
14. 计算机怎么盲打键盘,如何练习盲打 键盘盲打指法练习技巧-电脑教程
15. PyTorch 体验感悟
16. 约瑟夫问题（小小算法，真不可笑）
17. 数据基础---《利用Python进行数据分析·第2版》第12章 pandas高级应用
18. switch怎么切换服务器账号,任天堂eshop如何换区 switch账号如何切换其他服地区
19. vuex刷新state数据丢失问题
20. 【数据结构】【实验作业05】求两个集合的并集、交集、差集，集合用链表

热门文章

1. EasyUI datagrid : 启用行号、固定列及多级表头后，头部行号位置单元格错位的问题...
2. ASP.NET MVC经典项目ProDinner项目解析（3）
3. Android Binder机制学习笔记
4. centos7python命令_详解Linux Centos7下安装Python的方法
5. android汉字笔顺数据库,Chinese stroke order app
6. 卷积和池化matlab 实现,UFLDL新版教程与编程练习（七）：Convolution and Pooling（卷积和池化）...
7. 单细胞数据整合方法 | Comprehensive Integration of Single-Cell Data
8. 作业一 郝树伟 1101210664
9. CentOS7 设置主机名及IP映射
10. python 模块 wmi 远程连接 windows 获取配置信息