New Markdown Memo
文章目录
基础语法
字体
标题
标题支持使用两种标记:底线(-/=)和#。
标题内容
==
标题内容
--
语法说明:
- 底线=表示一级标题
- 底线-表示二级标题
- 底线符号的数量至少2个
- 这种语法只支持这两级标题
使用#的语法:# + 空格 + 标题内容
语法说明:
- 行首插入#标记标题
- #的个书表示了标题等级
- #号后面加一个空格
- 最多只支持6级标题
使用规范:
建议使用#
,同时建议加空格;不要有多余的空格;标题结尾不要有标点符号;标题要尽量简短,这样方便引用。
推荐Markdown文档结构
# 文档标题
作者
摘录
目录
## 标题1
### 标题1.1
## 标题2
### 标题2.1
### 标题2.2
说明如下:
- 第一个标题应该是一级标题,建议与文件名相同。
- 作者,建议
- 摘要:1~3句话减压概括
- 目录:用于快速了解文档结构。
- 正文:标题逐级增加,不可跳级,不可相同。
斜体与粗体
在Markdown中,斜体由2个 *
或者2个 _
包围,斜体由1个 *
或者1个 _
包裹。
粗体语法:
**粗体内容**
__粗体内容__
*斜体内容*
_斜体内容_
使用规范:
*
比较常见,可读性比_
强。- 在标记内部不要有空格。
段落与换行
Markdown中的段落由一行或者多行组成,不同段落之间用空行来标记
使用说明:
- 如果行与行之间没有空行,视为同一段落。
- 如果行与行之间有空行,视为不同段落。
- 空行指行内什么都没有,或者只有空格和制表符。
- 如果想在段内换行,则需要在上一行的结尾插入两个以上的空格并回车键。
使用规范:
- 每行不超过80个字符
- 一句话结束后换行
- URL过于长的时候换行
列表
在Markdown中支持使用有序列表和无序列表。
有序列表的语法:
数学序号+英文句号+空格+列表内容
无序列表的语法:
* /+/— + 空格 + 列表内容
嵌套列表的语法
+ 第一级列表
TAB + 第二级标题
TAB + TAB + 第三级标题
语法说明:
- 列表中可以嵌套列表
- 有序列表和无序列表也可以互相嵌套
使用规范:
- 建议使用
-
来标记无序列表。 - 若列表中所有列表项都没有换行的话,建议使用一个空格。
- 若列表项有换行,建议无序列表使用3个空格,有序列表使用2个空格。
- 若列表中每个列表项都只有一行,建议列表项之间不要有空行。
- 若列表项中有换行,建议在列表项之间空一行。
- 建议在列表前后都空一行。
- 数字、字符、符号列表使用英文半角句号,句号后面加空格。
分隔线
Markdown中,分隔线由3个以上的*
/-
/_
来标记。
语法如下:
***
或
---
或
___
说明如下:
- 至少使用3个以上
- 行内不能有其他字符
- 可以在标记符中间加上空格。
图片
插入图片的语法
! [图片代替文字] (图片地址)
语法说明:
- 图片替代文字在图片无法正确显示时会比较有用,正常情况下可以为空。
- 图片地址可以为本地地址,也可以是网络图片地址
- 本地支持相对路径和绝对路径。
链接
文字链接
文字链接就是链接地址直接写在文本中。
[链接文字](链接地址)
引用链接
引用链接是把链接地址作为“变量”先在Markdown文件的页尾定义好,然后在正文中引用。
在正文中引用连接标记,可以理解为引用定义好的变量:
[链接文字][链接标记]
在底部定义链接标记,可以理解为定义一个地址变量:
[链接标记]: 链接地址
语法说明:
- 链接标记可以有字母、数字、空格和标点符号
- 链接标记不区分大小写
- 定义链接内容可以放在当前文件的任意位置,建议放在页尾
- 链接地址为网络地址的话要以
http/https
开头,否则会被识别为本地地址。
网络链接
将网络地址或邮箱地址使用 <>
包裹起来会被自动转换为超链接
<URL或邮箱地址>
使用规范
- 在Markdown中,链接标题的信息应该更丰富,从标题中应该可以知道链接的内容,要使用有意义的链接标题。
- 建议使用
<>
包裹自动连接,这种方式更通用。 - 自动链接要使用
http/https
开头
行内代码与代码块
行内代码
行内代码引用使用 ` 包裹,语法如下:
`代码`
代码块
在基础Markdown中,代码块以Tab键或者4个空格开头
使用规范
- 如果使用超过一行的代码,建议使用围栏代码块,并显式生命语言,这样便于阅读
- 如果编写简单代码块,可以使用缩进的代码块。
- 很多Shell命令都要粘贴到终端里去执行,因此最好避免在Shell命令中使用任何换行操作;
- 可以在行尾使用一个
\
,这样既能避免命令换行,又能提高源码的可读性。 - 在有输出内容的Shell命令前加$
引用
语法
语法如下:
> 引用内容
语法说明:
- 多行引用也可以在每一行的开头都插入
>
。 - 在引用中可以嵌套引用。
- 在引用中可以使用其他的Markdown语法。
- 段落与换行的格式在引用中也是适用的。
使用规范
- 建议在引用的标点符号
>
之后加一个空格 - 建议每一行引用都是用符号
>
- 不要在引用中添加空行
转义
可以使用\进行转义。
可以被转义的特殊符号如下:
\ 反斜线
` 反引号
* 星号
_ 底线
{} 花括号
[] 方括号
() 括弧
# 井字号
+ 加号
- 减号
. 英文句点
! 感叹号
GFM语法
全名:Github Flavored Markdown
删除线
~~被删除的文字~~
表情符号
使用 :
包裹即可
:表情代码:
常用表情代码 | 表情 |
---|---|
:smile: | 😄 |
:laughing: | 😆 |
:+1: | 👍 |
:-1: | 👎 |
:clap: | 👏 |
:\| | 😐 |
更多表情参考:
http://www.webpagefx.com/tools/emoji-cheat-sheet/
自动链接
在标准语法中,由 <>
包裹的URL地址会被自动识别并解析为超链接,使用GFM则可以不使用。
注意:自动链接只能识别 www
或者 http://
开头的URL地址。
如果不想使用自动链接,可以使用 ` 包裹URL.
表格
语法如下:
| 表头1 | 表头2 | 表头3 |
| ----- | ----- | ----- |
| 内容1 | 内容2 | 内容3 |
| 内容1 | 内容2 | 内容3 |
语法说明:
- 单元格使用
|
来分隔,为了阅读方便,建议每行最前最后都使用 - 单元格和
|
之间的空格会被移除 - 表头与其他行使用
----
分隔 - 表格对齐格式如下:
- 左对齐:
:----
- 右对齐:
----:
- 居中对齐:
:----:
- 左对齐:
- 块级元素(代码区块,引用区块)不能插入其中
创建建议:
- 表格的前后空一行
- 每一行的
|
尽量对齐(Typora有自动对齐表格源码功能) - 不要使用过于复杂庞大的表格。
任务列表
语法如下:
- [ ] 未勾选
- [x] 已勾选
语法说明:
- 任务列表以
-
/+
开头,由[
+空格 /x
]
组成 - 理论上X可以大写也可以小写。但有的编辑器不认大写。
围栏代码块
语法如下:
//```
//代码片段
//```
或者
//~~~
//代码片段
//~~~
或者
//```语言名字
//代码片段
//```
语法说明:
围栏代码块使用连续三个 ` 或者 ~ 包裹。如果在后面加上编程语言名字,则支持语法高亮。
锚点
锚点,也称为书签,用来标记文档的特殊位置,使用锚点可以跳转到当前文档或其他文档中指定的标记位置。
语法如下:
[锚点描述](#锚点名)
语法说明:
- 锚点名建议使用字母和数字。虽然理论上支持中文,但不排除有些网站做不到。
- 锚点名区分大小写
- 锚点名中不能有空格,也不能有特殊字符。
排版技巧
关于空格
建议中文和英文之间加空格,中文/英文和数字之间也要加空格。
- 需要加空格的情况
- 英文标点符号与后面的字符之间需要加空格
- 当在中文、英文中使用 >(半角)表示路径时,两边都要加空格。
- 不加空格的情况
- 中文标点符号和数字、中文、英文之间不需要加空格。
- 数字与百分号之间不需要加空格
- 数字和单位符号之间不需要加空格
- 英文与数字组合成的名字之间不需要加空格
- 当 /(半角)表示“路径”、“或”时,与前后的字符之间均不加空格
- 货币符号后不加空格
- 负号后面不加空格
半角和全角
- 在中文排版中,要使用全角标点符号
- 在英文排版中,要使用半角标点符号
Typora编辑器
特点
- 实时预览
- 扩展语法
- 快捷操作
- 文件转换
- 支持中文
- 平台丰富
- 目前免费
基础
下载地址
Typora:https://typora.io/#download
设置语言
文件 > 偏好设置(快捷键:Ctrl+,) > 通用 > 语言
重启生效。
字数统计
文件 > 偏好设置(快捷键:Ctrl+,) > 字数统计 > 总是显示字数统计
pandoc
标记语言转换工具。
如果不安装 pandoc,Typora 只支持导出 HTML 或 PDF 格式。
如果安装了 pandoc,Typora 支持格式如下:
- 导入格式
- .doc
- .dokuwiki
- .epub
- .latex
- .opml
- .org
- .ltx
- .rst
- .rest
- .testile
- .tex
- .wiki
- 等等等等
- 导出格式
- ePub
- HTML
- LATEX
- MediaWiki
- OpenOffice
- PNG
- Word
- RTF
- 等等等等
高效使用
基础语法和GFM语法
编辑样式:
菜单栏 > 格式 > 加粗/斜体/代码(行内代码)/图像/超链接
可以添加或者移除关于文字样式的标记符号
相关样式的快捷键如下:
操作 | macOS系统 | Windows系统 |
---|---|---|
粗体 | Command + B | Ctrl + B |
斜体 | Command + I | Ctrl + I |
行内代码 | Control + ` | |
图片 | Control + Command + I | Ctrl + Shift + I |
超链接 | Command + K | Ctrl + K |
链接引用 | Control + Shift + ` | |
删除线 | Control + Shift + ~ | Alt + Shift + 5 |
表情符号 | Control + Command + 空格 |
表情符号自动补全功能:
偏好设置 > 编辑器 > 触发自动完成 > 勾选【Emoji表情】
编辑段落
菜单栏 > 段落 > 【段落/引用/表格/代码块/分隔线/有序列表/无序列表/任务列表】
Typora段落与换行
使用Enter键插入新段落
最通用的插入强制换行符的方法有两种:
- 在行尾加入两个空格,然后按回车键
- 使用HTML标签
<br/>
实现换行。在默认情况<br/>
不显示。如果想显示:菜单栏 > 【编辑】> 【空格与换行】> 勾选【显示<br/>
】
还提供了一种快速换行的方法,确认勾选保留单换行符:
菜单栏 > 编辑 > 空格与换行 > 勾选【保留单换行符】
然后使用快捷键:Shift + Enter 换行
上述换行符可能在导出/打印时被忽略,请到【偏好设置】 > 【空格与换行】 > 【导出/打印】
首行缩进
设置方法:
菜单栏 > 【编辑】>【空格与换行】> 勾选【首行缩进】
在表格或图表的前后插入
表格内单击鼠标右键 >【插入】> 选择【段落(上方)/段落(下方)】
Typora标题
操作 | macOS 系统 | Windows 系统 |
---|---|---|
设置一级标题 | Command + 1 | Ctrl + 1 |
设置二级标题 | Command + 2 | Ctrl + 2 |
设置三级标题 | Command + 3 | Ctrl + 3 |
设置四级标题 | Command + 4 | Ctrl + 4 |
设置五级标题 | Command + 5 | Ctrl + 5 |
提升标题级别 | Command + = | Ctrl + = |
降低标题级别 | Command + - | Ctrl + - |
设置为普通文本 | Command + 0 | Ctrl + 0 |
Typora列表
操作 | macOS 系统 | Windows 系统 |
---|---|---|
添加有序列表 | Option + Command + O | Ctrl + Shift +[ |
添加无序列表 | Option + Command + U | Ctrl + Shift +] |
增加缩进 | Command + ] | Ctrl + [ |
减少缩进 | Command + [ | Ctrl + ] |
添加任务列表 | Option + Command +X | |
切换任务状态 | Control + X |
Typora引用和水平分隔线
操作 | macOS 系统 | Windows 系统 |
---|---|---|
添加引用 | Option + Command + Q | Ctrl + Shift + Q |
添加水平分隔线 | Shift + Command + - |
Typora表格
- 创建表格
macOS 系统 | Windows 系统 | |
---|---|---|
Option + Command + T | Ctrl + T |
- 增加行/删除行、复制表格、格式化表格
操作 | macOS 系统 |
---|---|
增加1行(下一行) | Command + Enter |
删除1行(当前行) | Command + Shift + Delete |
- 快速调整表格
把光标放在行的最左边或者列的最上边,待光标变成双向箭头后拖动即可调整顺序。
代码
- 插入围栏代码块
菜单栏 > 段落 > 代码块
相关快捷键:
macOS 系统 | Windows 系统 |
---|---|
Option + Command + C | Ctrl + Shift + K |
- 显示代码行数
文件 > 标号设置 > 代码块 > 勾选【显示行号】
- 自动换行
文件 > 偏好设置 > 代码块 > 不勾选【代码块自动换行】
Typora扩展语法
-
编辑样式
-
下划线
<u>这段文字下面有下划线<u/>
- 相关快捷键:
macOS 系统 | Windows 系统 |
---|---|
Command + U | Ctrl + U |
内联数学公式
如果想使用内联公式:
需要先激活:【偏好设置】>【Markdown扩展语法】> 勾选【内联公式】> 重启Typora
语法如下:
$数学公式$
实机演示:
分数:$f(x,y)=\frac{x^2}{y^3}$
开根号:$f(x,y)=\sqrt[n]{{x^2}{y^3}}$
省略号:$f(x_1,x_2,\ldots,x_n)=x_1 +x_2+\cdots+x_n$
分数:
f
(
x
,
y
)
=
x
2
y
3
f(x,y)=\frac{x^2}{y^3}
f(x,y)=y3x2
开根号:
f
(
x
,
y
)
=
x
2
y
3
n
f(x,y)=\sqrt[n]{{x^2}{y^3}}
f(x,y)=nx2y3
省略号:
f
(
x
1
,
x
2
,
…
,
x
n
)
=
x
1
+
x
2
+
⋯
+
x
n
f(x_1,x_2,\ldots,x_n)=x_1 +x_2+\cdots+x_n
f(x1,x2,…,xn)=x1+x2+⋯+xn
还可以执行:菜单栏 >【格式】>【内联公式】。
- 下标和上标
如果想使用上标和下标,需要激活【偏好设置】>【Markdown扩展语法】> 勾选【下标】、【上标】> 重启Typora。
~下表内容~
^上标内容^
实例演示:
下标:H~2~O
上标:X^2^+Y^2^
渲染如下:
下标:H2O
上标:X2+Y2
还可以执行:菜单栏 > 格式 > 上标/下标
- 高亮
如果想使用高亮功能,需要先激活:【偏好设置】>【Markdown扩展语法】> 勾选【高亮】> 重启Typora。
语法如下:
==高亮内容==
默认显示为黄色
高亮效果快捷键:
macOS系统:Command + Shift + H
- 注释
执行:菜单栏 >【格式】>【注释】
设置注释的语法如下:
<!--我是注释-->
快捷键如下:
macOS系统:Control + -
- 清除样式
执行:菜单栏 >【格式】>【清除样式】
快捷键:
macOS系统 | Windows系统 |
---|---|
Command + \ | Ctrl + \ |
-
编辑段落
-
数学公式块
语法如下:
$$
数学公式
$$
官方示例
$$
\matchbf{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}
$$
效果显示
V 1 × V 2 = ∣ i j k ∂ X ∂ u ∂ Y ∂ u 0 ∂ X ∂ v ∂ Y ∂ v 0 ∣ \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∂Xj∂u∂Y∂v∂Yk00∣∣∣∣∣∣
为某段内容添加或者删除公示块,需要先选中该内容,然后执行:菜单栏 >【段落】>【公示块】,如果不选中任何内容,直接执行:菜单栏 >【段落】>【公示块】。
公示块的快捷键:
macOS 系统 | Windows 系统 |
---|---|
Option + Command + B | Ctrl + Shift + M |
LATEX 官方在线教程:MathJax basic tutorial and quick reference
LATEX 官方教程备份:备份