Markdown使用流指南¶

0. PRE 前置¶

文档简介 本文主要是介绍Markdown的语法书写，所讲的内容包括但不限于：使用markdown的原因、markdown基础语法、、markdown编写工具、导出/发布……

参考文献 - 本文的参考文档1 - 本文的参考文档2 - 本文的参考文档3

面向对象与注意事项

需要进行合作编程开发的同学（主要）
没有使用过markdown风格写过文字的同学
教程以使用macOS为主
建议在阅读教程之前先行配置obsidian 和 Markdown_All_In_One

文档引入 众所周知：用txt文件就可以在计算机中方便的呈现文字；我们也说了格式是可以增强文本的表现力的，比如用Word给这些文字添加格式。

Markdown其实是一种写作风格/方式，我们用这种风格/方式写出来的纯文本文件（和.txt是一样的）叫做markdown文件，一般以.md作为文件后缀（而不是.txt）。

.md文件虽然是纯文本，但其中用一些特殊的字符（如* # [] () …）给纯文本带来格式（这与html文件是相似的，也可以将markdown看作是简单的html）。这些格式通过某种方式进行渲染（注：渲染：指将计算机中的某些数据呈现在屏幕上）你就可以看到它们代表的格式了！

1. HEADERS 标题¶

1～6个 '#' 号加一个空格再加上标题的名称

Markdown
## 一级标题
### 二级标题
……
###### 六级标题

2. EMPHASIS 加粗和斜体¶

Markdown
*This text will be italic*
_This will also be italic_

**This text will be bold**
__This will also be bold__

_You **can** combine them_

语句两边各加一个 * 形成斜体： This text will be italic

语句两边各加一个 _ 形成斜体： This will also be italic

语句两边各加一个 ** 形成斜体： This text will be bold

语句两边各加一个 __ 形成斜体： This will also be bold

语句符号中 _ 与 * 的混搭： You can combine them

3. LISTS 列表¶

3.1 Unordered 无序列表¶

Markdown
* Item 1       --- 一级列表
* Item 2       --- 一级列表
    * Item 2a  --- 二级列表
    * Item 2b  --- 二级列表

这里可以缩进的！

enter后自动平移到同级下一列表；tab后自动跳转同下一级新启列表！

Item 1
Item 2
- Item 2_a
- Item 2_b

3.2 Ordered 有序列表¶

Markdown
Item 1
Item 2
Item 3
Item 3a
Item 3b

这里可以缩进的！

缩进会重新编号，或者变成小标题（如1.1 2.1.3这样）

task 1
task 2
task 3
1. task 3_1
2. task3_2

3.3 Task Lists 任务列表¶

Markdown
- [x] this is a complete item
- [ ] this is an incomplete item

鼠标点击后就会“自动打勾” <=> 在 [ ] 内加上 'x'

[x] this is a complete item
[ ] this is an incomplete item

4. LINKS 链接¶

[Text](url)：中括号，后面小括号。小括号里面放链接，中括号里面放说明（必须）；不需要说明的话，可以直接写链接

直接写链接会直接被转换为可以点击的链接；也可以在两侧加上<和>

Markdown
[GitHub Official Site](https://github.com)

https://github.com

<https://github.com>

1. [Your Description]( the Url of Website)

GitHub Official Site

直接写链接会自动转换成可点击的网址

https://github.com
间接写链接：在两侧加上<和>

https://github.com

5. IMAGES 图片¶

![Text](url)：感叹号，中括号，小括号。

小括号里面放图片链接，中括号里面放图片说明（不必须；写了的话会在图片下方或某处显示说明，当因为某种原因图片无法加载的时候，显示时也会用说明替代图片）

GitHub Logo

6. CODEING 代码¶

6.1 INLINE CODE 行内代码¶

直接用`...`表述即可

6.2 CODE BLOCK 代码块¶

用一对三个反撇 ``` 包裹，在最开始三个反撇后可以加代码的语言名称或简写以在渲染时获得高亮支持！

一般支持的代码高亮会有很多，比如：shell、bash、c、cpp、java、objectivec、python、swift、yaml、html、xml等

C++
#include<iostream>
#include<algorithm>
using namespace std;
int main()
{
    int a;
    cin >> a;
    cout << a <<endl;
    return 0;
}

7. QUATE 引用¶

我习惯于用它来在文章开头写一下文档的更新日期等前置事项：

Markdown
As Tim Cook said:

> Fearlessness means taking the frst step, 
> even if you don't know where it will take you.

As Tim Cook said:

Fearlessness means taking the frst step, even if you don't know where it will take you.

8. TABLES 表格¶

Markdown
|hbx|cqy|wlr|
|:---:|:---:|:---:|
|1|2|3|
|4|5|6|

hbx	cqy	wlr
1	2	3
4	5	6
注意：
-	:---:	表示：框内文本内容居中对齐
- 表格代码文本与钱文内容至少需要空一个行

9. Enter 换行¶

有的时候你在markdown明明换行了，可是上传到GitHub上面一看，文字都粘在一起了。这是为什么呢？

英文在分段的时候，不像我们写文章段前空两格，他们会直接在两段之间多空一行。一般的回车只是用来方便阅读，不然一行的内容太长了。

如果你不希望这种方式生效，可以在一行后面加两个空格；但这样很麻烦，还是多加回车吧；最好在每种语法前后都空行，这样也能有效减少语法不被识别的情况（PS：多于2个的连续回车markdown会将它们当作一个回车）

10. 推荐的Markdown支持平台¶

10.1 obsidian¶

参考工作流的骨架围绕 单个知识点多参考源，勤于提问给多个知识点之间建立联系 的底层核心逻辑建立。我们写论文其实就是遵循这个底层逻辑的。论文一般会有脚注去解释一些关键字，并且论文末尾会有多个参考的来源，但是我们平时写笔记会随意得多，因此需要更灵活的方式。

平时写代码习惯在 IDE 里一键跳转，把相关的函数和实现很好地联系在了一起。你也许会想，如果笔记也能像代码那样可以跳转就好了。现在市面上 双链笔记软件 就可以很好地解决这一痛点，例如 Roam Research、Logseq、Notion 和 Obsidian。Roam Research 和 Logseq 都是基于大纲结构的笔记软件，而 大纲结构 是劝退我使用这两款软件的原因。一是 大纲结构 做笔记容易使文章纵向篇幅太长，二是如果嵌套结构过多会占横向的篇幅。Notion 页面打开慢，弃之。最终我选择了 Obsidian，原因如下：

Obsidian 基于本地，打开速度快，且可存放很多电子书。我的笔记本是 32g 内存的华硕天选一代，拿来跑 Obsidian 可以快到飞起
Obsidian 基于 Markdown。这也是一个优势，如果笔记软件写的笔记格式是自家的编码格式，那么不方便其他第三方拓展，也不方便将笔记用其他软件打开，比如 qq 音乐下载歌曲有自己的格式，其他播放器播放不了，这挺恶心人的
Obsidian 有丰富的插件生态，并且这个生态既大又活跃，即插件数量多，且热门插件的 star 多，开发者会反馈用户 issue，版本会持续迭代。借助这些插件，可以使 Osidian 达到 all in one 的效果，即各类知识来源可以统一整合于一处

=> obsidian_官网

10.2 Markdown All in One¶

安装插件Markdown All in One，会支持不少快捷操作。

VS Code作为编辑器之神，写markdown肯定没问题！直接新建markdown文件就可以编辑了！

一般来说，软件开发的项目中，代码都是和markdown文件在一起的，以后如果有一些需要在VS Code打开的项目，使用VS Code编写README.md或者其他的markdown文件也是很方便的一个选择。

Appendix1 文字编辑技巧¶

仅限MacOS：

〇双击选中一个词：这里词指一个中文的词语或者一个英文的单词

〇三击选中一行

〇 ⌥左右：以词为单位移动光标

〇 ⌘上下左右：移动光标到行首/行未/文头/文末

〇按住⇧：文字选中；⇧上下左右 / ⇧⌥左右 / ⌘⇧上下左右

〇按住⌥：矩形区域选中

〇 ⌥⌫、⌘⌫；fn⌫：删除词、删除到行首；向后删除 delete；⌘X也是一种删除的方式

Appendix 2 LaTeX & Markdown¶

注意一下，反斜线还有行内代码可以用来输入可能会被当作markdown语法的符号：比如你想在markdown中输入一个星号*，可能你一不小心就发现星号被markdown渲染成了格式。这时你可以用行内代码包裹，*，或者用反斜线\*，这样markdown就不会把这些符号当成格式了。

如果我们只是写简单的Markdown文稿，上面的这些语法已经完全够用了。

不过既然能用符号表示格式，那么能不能添加更多的语法进来呢？

X 2.1 正文书写方式¶

行内： my name is $hbx$

跨行： $$ hbx $$

X 2.2 基础希腊字母¶

小写字母	小写表示
\alpha	$\alpha$
\beta	$\beta$
\gamma	$\gamma$
\theta	$\theta$
\delta	$\delta$
\eta	$\eta$
\mu	$\mu$
\omega	$\omega$
\lambda	$\lambda$

大写字母	大写表示
\Gamma	$\Gamma$
\Omega	$\Omega$
\Theta	$\Theta$
\Delta	$\Delta$

如果希望使用斜体字母，应当在表示法内加上“var”，比如：

\varGamma => $\varGamma$ \varTheta => $\varTheta$

X 2.3 运算符¶

运算符	显示
\pm	$\pm$
\mp	$\mp$
\times	$\times$
\div	$\div$
\frac{1}{a}	$\frac{1}{a}$
\leq	$\leq$
\geq	$\geq$
\in	$\in$
\propto	$\propto$

X 2.4 求和符号与积分¶

符号	显示
\sum	$\sum$
\int	$\int$
\sum_{i=1}^{N}	$\sum_{i=1}^{N}$
\int_{a}^{b}	$\int_{a}^{b}$
\prod	$\prod$
\iint	$\iint$
\prod_{i=1}^{N}	$\prod_{i=1}^{N}$
\iint_{a}^{b}	$\iint_{a}^{b}$
\bigcup	$\bigcup$
\bigcap	$\bigcap$
\subset	$\subset$
\subsetneq	$\subsetneq$
\subseteq	$\subseteq$

PS：求和符号上下限的位置 1. 默认 行内公式 的上下限标注在右侧 \sum_{k=1}^n{x_k} => $\sum_{k=1}^n{x_k}$ 2. 默认 行间公式 的上下限标注在上下 \sum_{k=1}^n{x_k} => $$ \sum_{k=1}^n{x_k} $$ 可以强制修改： 1. 行内 => \sum\limits_{k=1}^n{x_k}：$\sum\limits_{k=1}^n{x_k}$ 2. 行间 => \sum\nolimits_{k=1}^n{x_k}： $$ \sum\nolimits_{k=1}^n{x_k} $$

X 2.5 常用数学符号¶

命令	显示	注释
\sqrt[3]{2}	$\sqrt[3]{2}$
\sqrt{2}	$\sqrt{2}$
x_{35}	$x_{35}$
x_35 (很显然这是错误写法)	$x_35$
x^{25}	$x^{25}$
x^25 (很显然这是错误写法)	$x^25$
\lim_{x \to 0}	$\lim_{x\to 0}$
\frac{1}{30}	$\frac{1}{30}$
\infty	$\infty$
-\infty	$-\infty$
\partial	$\partial$	偏导数
\hat{a}	$\hat{a}$	a的重音写法 ^
\bar{a}	$\bar{a}$	a的重音写法 -
\vec{a}	$\vec{a}$	a的重音写法 ->
\tilde{a}	$\tilde{a}$	a的重音写法 ~

X 2.6 矩阵表示法¶

单线框矩阵¶

$$ \begin{vmatrix} 1&2&3\ 4&5&6\ 7&8&9 \end{vmatrix} \tag{X 2.6.1} $$

Markdown
$$
\begin{vmatrix}   % vmatrix 说明是 “单线框矩阵”形式
    1&2&3\\
    4&5&6\\
    7&8&9
\end{vmatrix}
 \tag{X 2.6.1}    % tag 是 “公式编号”，{ } 里面是编号信息
$$

复线框矩阵¶

$$ \begin{Vmatrix}
1&2&3\ 4&5&6\ 7&8&9 \end{Vmatrix} \tag{X 2.6.2}
$$

Markdown
$$
\begin{Vmatrix}   % Vmatrix 说明是 “复线框矩阵”形式
    1&2&3\\
    4&5&6\\
    7&8&9
\end{Vmatrix}
 \tag{X 2.6.2}    % tag 是 “公式编号”，{ } 里面是编号信息
$$

单内括框矩阵¶

Markdown
$$
\begin{bmatrix}   % bmatrix 说明是 “单内括框矩阵”形式
    1&2&3\\
    4&5&6\\
    7&8&9
\end{bmatrix}
 \tag{X 2.6.3}    % tag 是 “公式编号”，{ } 里面是编号信息
$$

$$ \begin{bmatrix} % vmatrix 说明是 “单线框矩阵”形式 1&2&3\ 4&5&6\ 7&8&9 \end{bmatrix} \tag{X 2.6.3} % tag 是 “公式编号”，{ } 里面是编号信息 $$

单圆括号框矩阵¶

Markdown
$$
\begin{pmatrix}   % pmatrix 说明是 “单圆括号框矩阵”形式
    1&2&3\\
    4&5&6\\
    7&8&9
\end{pmatrix}
 \tag{X 2.6.4}    % tag 是 “公式编号”，{ } 里面是编号信息
$$

$$ \begin{pmatrix} % pmatrix 说明是 “单圆括号框矩阵”形式 1&2&3\ 4&5&6\ 7&8&9 \end{pmatrix} \tag{X 2.6.4} % tag 是 “公式编号”，{ } 里面是编号信息 $$

X 2.7 通用 LaTeX 数学文法¶

公式编号¶

Markdown
$$ f(x)=a_b\tag{1-1} $$

$\(f(x)=a_b\tag{1-1}$\)

数学公式¶

拉丁字母、阿拉伯数字和 ±*/= 运算符均可以直接输入获得
命令\cdot表示乘法的圆点，命令\neq表示不等号，命令\equiv表示恒等于，命令\bmod表示取模

Markdown
$$ x+2-3*4/6=4/y + x\cdot y $$

$$ x+2-3*4/6=4/y + x\cdot y $$

Markdown
$$ 0 \neq 1 \quad x \equiv x \quad 1 = 9 \bmod 2 $$

$$ 0 \neq 1 \quad x \equiv x \quad 1 = 9 \bmod 2 $$

根号与分式¶

\sqrt表示平方根
\sqrt[n]表示n次方根
\frac表示分式（分子 / 分母)

Markdown
$$\sqrt{x} + \sqrt{x^{2}+\sqrt{y}} = \sqrt[3]{k_{i}} - \frac{x}{m}$$

$\(\sqrt{x} + \sqrt{x^{2}+\sqrt{y}} = \sqrt[3]{k_{i}} - \frac{x}{m}$\)

上下标记¶

上横线

Markdown
$$\overline{x+y}$$

$\(\overline{x+y}$\)

下横线

Markdown
$$\underline{x+y}$$

$\(\underline{x+y}$\)

上括线

Markdown
$$\overbrace{x+y}$$

$\(\overbrace{x+y}$\)

下括线

Markdown
$$\underbrace{x+y}$$

$\(\underbrace{x+y}$\)

向量¶

单小写字母a： $\vec{a}$ => $\vec{a}$
双大写字母(->)： $\overrightarrow{AB}$ => $\overrightarrow{AB}$
双大写字母(<-)： $\overleftarrow{CD}$ => $\overleftarrow{CD}$

Markdown
$$\vec{b} + \overrightarrow{CD} + \overleftarrow{EF}$$

$\(\vec{b} + \overrightarrow{CD} + \overleftarrow{EF}$\)

Appendix 3 高效工作流工具¶

X 3.1 语法高亮¶

Markdown
==需要高亮内容==

eg：hbx

X 3.2 改变图片大小¶

Bash
![](图片地址#size=宽度x高度)

例如：

Bash
![](/media//202003/2020-03-162054380444823ec2089addb07d92e72eec3d6f2ad025df43f678.jpg#size=100x100)

小写字母	小写表示
\alpha	\(\alpha\)
\beta	\(\beta\)
\gamma	\(\gamma\)
\theta	\(\theta\)
\delta	\(\delta\)
\eta	\(\eta\)
\mu	\(\mu\)
\omega	\(\omega\)
\lambda	\(\lambda\)

运算符	显示
\pm	\(\pm\)
\mp	\(\mp\)
\times	\(\times\)
\div	\(\div\)
\frac{1}{a}	\(\frac{1}{a}\)
\leq	\(\leq\)
\geq	\(\geq\)
\in	\(\in\)
\propto	\(\propto\)

符号	显示
\sum	\(\sum\)
\int	\(\int\)
\sum_{i=1}^{N}	\(\sum_{i=1}^{N}\)
\int_{a}^{b}	\(\int_{a}^{b}\)
\prod	\(\prod\)
\iint	\(\iint\)
\prod_{i=1}^{N}	\(\prod_{i=1}^{N}\)
\iint_{a}^{b}	\(\iint_{a}^{b}\)
\bigcup	\(\bigcup\)
\bigcap	\(\bigcap\)
\subset	\(\subset\)
\subsetneq	\(\subsetneq\)
\subseteq	\(\subseteq\)

命令	显示	注释
\sqrt[3]{2}	\(\sqrt[3]{2}\)
\sqrt{2}	\(\sqrt{2}\)
x_{35}	\(x_{35}\)
x_35 (很显然这是错误写法)	\(x_35\)
x^{25}	\(x^{25}\)
x^25 (很显然这是错误写法)	\(x^25\)
\lim_{x \to 0}	\(\lim_{x\to 0}\)
\frac{1}{30}	\(\frac{1}{30}\)
\infty	\(\infty\)
-\infty	\(-\infty\)
\partial	\(\partial\)	偏导数
\hat{a}	\(\hat{a}\)	a的重音写法 ^
\bar{a}	\(\bar{a}\)	a的重音写法 -
\vec{a}	\(\vec{a}\)	a的重音写法 ->
\tilde{a}	\(\tilde{a}\)	a的重音写法 ~