语法-Markdown

#工具/语法 #Markdown

摘要

本文用以记录 Markdown 笔记常用语法，包括一些仅在 Obsidian 中应用的语法
建议采用源码模式观看
为方便网页读者, 将用 行内引用 给出对应语法
由于插件限制，网页端目前无法解析块引用

标题

由于标题会影响大纲，这里不做实际展示

# 一级标题

## 二级标题

### 三级标题

#### 四级标题

##### 五级标题

###### 六级标题

文本强调

常用强调

粗斜体符号 * 与 _ 均可, 为规范文本, 笔者一般采用 *

加粗就用 **文本**

斜体就用 *文本*

粗斜体可以 ***文本***

注意对粗斜体, 只要前后符号相同, 支持任意混搭, 例如 *_*文本*_*

但是加粗不支持

粗体嵌套 * 斜体 * 要隔开

斜体嵌套粗体要隔开

删除采用 ~~文本~~

高亮采用 ==文本==

HTML 补充

补充一些 HTML 语法的文本强调方式，部署很优雅但是可以按需取用

下划线采用 文本

放大采用 <big>文本</big>

放大大采用 <big><big>文本</big></big>

缩小采用 文本

缩小小采用 文本

指定颜色采用 文本

指定色号采用 文本

分割线

分割线可采取 *** 与 ---, 笔者一般采用 ---

列表

有序列表

直接采用 1. 即可创建有序列表，记得点后面有空格

单级列表

第 1 条
第 1 条
第 1 条

层级列表

增加层级用 Tab 键

第 1 条
1. 第 1.1 条
  1. 第 1.1.1 条
第 2 条

无序列表

无序列表可采取 *, +, -, 笔者一般采用 +，同样符号后跟空格，即 + 文本

单级列表

1 条
2 条
3 条

层级列表

同样用 Tab 键即可

1 条
- 1.1 条
2 条

引用

一般引用

一般引用采用 >，符号后跟空格, 即 > 文本

这是一条引用

这是
多行的引用

这是

二级引用

代码引用

代码引用采用单引号进行标记, 我们可以用两个反引号加空格来用行内代码显示单引号 `,即 `文本`

行内代码

多行代码采用三个单引号 ``` 包裹

```代码语言
第1行
第2行
```

可将代码语言处修改为对应语言, 即可享受对应语法高亮

想在多行代码内写文本则可以选择 txt

多行代码

import torch as tf
print("人生苦短,我用Python")

代码嵌套则以此增加单引号数量即可，例如，可以用四个单引号 ```` 来嵌套标准代码块

````txt
```代码语言
第1行
第2行
```
````

公式引用

Obsidian 支持 Latex 语法的公式渲染

行内公式 $公式$ $e^{i x} = \cos x + i \sin x$

多行公式用 ``

$
多行公式
$

e^{i π} + 1 = 0

更多公式语法参考语法-Latex

Obsidian 特色引用

Callout

可以采用 > [!note] 生成 Callout 块

后面正常跟 > 引用行即可

这是

Obsidian 中的
Callout 块

> [!note]+ 来设置可折叠标注块，> [!note]- 可设置默认折叠标注块

例如

这是

可折叠的
Callout 块

还有以下类型可选

Note
Abstract
Info
Todo
Tip
Success
Question
Warning
Failure
Danger
Bug
Example
Quote

双链

别名 是 Obsidian 中的双链, | 后为期望显示的文本

这是Obsidian的双链

[[笔记#标题]] 后可以用 # 指定连接到的标题

语法-Markdown#标题

[[笔记#^]] 可以用 #^ 指定引用的块

语法-Markdown#^7a2502 指定到本文的摘要 Callout 块

经测试，网页端目前还不支持块引用的渲染，等有钱了试试官方的发布

![[]] 是嵌入双链, 直接将对应笔记嵌入到这个笔记中,由于会导致循环, 这里不做展示

资源引用

网页引用基本格式如下

[显示文本内容](链接地址 "提示信息文本")

百度一下，你就知道

图片引用同网页引用, 不过采用 ! 嵌入到笔记之中，即

![显示文本内容](图片地址 "提示信息文本")

图片地址可以是本地地址也可以是网页地址

对 Obsidian 而言, 本地图片也被视作文件, 从而可以采用 ![[图片]] 的双链形式链接

原则上可以通过 [图片|宽度数值] 的方式来指定图片大小，不过我们在 Obsidian 中可以采用Image Converter插件来对图片处理, 此处不过多展开

表格

| 是表格的框架

- 分割表头与表格主体

: 控制表格内文本对齐格式, :- 为左对齐, :-: 为居中对齐, -: 是右对齐

给出源码与示例对应如下

| 表头 1 | 表头 2 | 表头 3 |
|:------ |:------:| ------:|
| 数据 1 | 数据 2 | 数据 3 |
| 数据 4 | 数据 5 | 数据 6 |

表头 1	表头 2	表头 3
数据 1	数据 2	数据 3
数据 4	数据 5	数据 6

待办

- [ ] 待办 未完成待办，中括号中应有空格，- 与 [ ]，[ ] 与 文本 均有空格

未完成待办

- [x] 已办 已完成待办，，- 与 [x]，[x] 与 文本 均有空格

已完成待办

Mermaid

至少 Obsidian 是原生支持通过 Mermaid 绘制图片的

不过具体使用方法足够再支撑起一篇文章了，此处仅展现一个案例，具体见语法-Mermaid

由于流程图一般比较大，我们可以用 Callout 块来进行折叠，同时也可以起到背景作用，流程图对应源码如下, 代码语言设置为 mermaid 即可渲染嵌入到笔记中

> [!example]- 费曼学习法流程图
> ```mermaid
> graph TD
>     A[选择一个概念] --> B[用自己的话解释它]
>     B --> C{是否能清晰简单地解释?}
>     C -- 是 --> D[尝试举例或类比]
>     C -- 否 --> E[回到资料，重新学习薄弱部分]
>     D --> F{例子是否贴切、类比是否恰当?}
>     F -- 是 --> G[简化语言，优化表达]
>     F -- 否 --> H[调整例子和类比]
>     G --> I[完成理解与掌握]
>     H --> G
>     E --> B
> ```

费曼学习法流程图

graph TD
    A[选择一个概念] --> B[用自己的话解释它]
    B --> C{是否能清晰简单地解释?}
    C -- 是 --> D[尝试举例或类比]
    C -- 否 --> E[回到资料，重新学习薄弱部分]
    D --> F{例子是否贴切、类比是否恰当?}
    F -- 是 --> G[简化语言，优化表达]
    F -- 否 --> H[调整例子和类比]
    G --> I[完成理解与掌握]
    H --> G
    E --> B

网页似乎无法渲染 Callout 中的 Mermaid 图片，此处单独渲染一次

graph TD
    A[选择一个概念] --> B[用自己的话解释它]
    B --> C{是否能清晰简单地解释?}
    C -- 是 --> D[尝试举例或类比]
    C -- 否 --> E[回到资料，重新学习薄弱部分]
    D --> F{例子是否贴切、类比是否恰当?}
    F -- 是 --> G[简化语言，优化表达]
    F -- 否 --> H[调整例子和类比]
    G --> I[完成理解与掌握]
    H --> G
    E --> B

注释

一般 Markdown 支持 HTML 的注释方法

即 

而 Obsidian 则直接支持 %% 注释 %%

脚注

脚注应用语法为 文本[^1]

对应的在下面 [^1]:脚注文本 即可

你可以跳过去看看 ^[1]

脚注可以直接写在用脚注的下面，渲染会自动移到底部并添加分割线的，不过记得脚注和正文内容间要空行

转义

* 转义* 采用 \ 紧贴 * ，即 \*文本\*，可以将标识符作为普通文本显示

相似的，\ 可以用于其他有意义的标识符，使其能够正常显示而不执行功能

排版

虽然说 Markdown 的宗旨是专心内容而不用管排版，但是有时候总想手动调一下排版，此时可以采用 HTML 的语法来增加空格与换行

空格   是的这里有九个空格

换行  

是的前面有三个换行

小技巧

删除成对符号

按住 Shift 的同时删除即可只删除一个符号而不是直接删除一对

PDF 分页

插入以下内容可以在 Markdown 文件导出 PDF 时分页

<div STYLE="page-break-after: always;"></div>

不过也没啥能看的 ↩︎