本文章永久分享链接: https://tflow.top/ob/Markdown

markdown是一款提供文本到HTML转换的工具,让文本的可读性大大提高,各大笔记软件均支持markdown语法,本篇将介绍markdown的格式化语法,以作为笔记知识库的技术基础

段落

markdown标准的段落需要使用空行分隔,即需要两个换行符才能分隔成两个段落,1个换行符只相当于1个空格

小标题

语法为 井号加上标题文本,井号个数代表n级标题,井号与文本之间要有空格。

建议的快捷键alt + 数字键,正文的快捷键为 alt + 反引号

文本格式化

下表罗列修改文本样式的语法以及建议的快捷键

样式语法示例输出快捷键
粗体** ****粗体文本**粗体文本ctrl+ B
斜体* **斜体文本*斜体文本ctrl+I
删除线~~ ~~~~删除线文本~~删除线文本ctrl+D
高亮 高亮文本高亮文本
粗体和嵌套斜体** ****粗体和 _嵌套斜体_ 文本**粗体和 嵌套斜体 文本
粗体和斜体*** ******粗体和斜体文本***粗体和斜体文
行内代码` `` import openai `import openaialt + L
代码块``` ```与行内代码类似ctrl + L

链接

使用链接来将其他笔记或者附件链接到笔记中,从而构建一个知识网络,产生关联。

语法为:[显示文本](文件名 or URL)

建议的快捷键ctrl + K

提示

如果文件名/URL有空格,需要使用尖括号< > 来包裹文件名进行转义。 例子:[我的 笔记](<obsidian://open?vault=主仓库&file=我的 笔记.md>)

提示

如果链接的是文件夹内的md笔记文件,则可以在文件名后添加 #小标题 即可链接到小标题。 例子: [测试](test.md#标题名字)

插入附件

将其他笔记或者附件直接嵌入到笔记中,典型如嵌入图片,嵌入网页视频,PDF。

语法为:![别称](文件路径 or URL)

建议的快捷键为 alt + K

提示

如果要修改嵌入附件尺寸,则可在链接的锚文本添加 |400×200 来更改尺寸。 如果只指定了宽度,则长度等比例放缩。 2个例子如下:

![Engelbart|100x145](https://history-computer.com/ModernComputer/Basis/images/Engelbart.jpg)
![Engelbart|100](https://history-computer.com/ModernComputer/Basis/images/Engelbart.jpg)

引用

引用他人语句时可使用。

语法为:在行开头添加 >

建议的快捷键为 alt + Q

这是一条引用

from 大表鸽鸽

列表

分为无序列表和有序列表。无序列表使用 -,有序列表使用 数字加上. 作为开头。

嵌套列表

使用 tabshift + tab 来降低或者提升列表项等级来实现嵌套列表

例子

这是一个嵌套的无序列表

  • 第1点
    • 第1.1点
  • 第2点
    • 第2.2点
      • 第2.2.1点

任务列表

使用 - []- [×] 作为开头来展示任务列表

  • 做饭
  • 洗菜

水平线

可以在单独的一行上使用三个或更多星号 ***、短横线 --- 或下划线 ___ 来添加水平线。这些分隔符号里允许有空格。

数学公式

你可以使用 MathJax 和 LaTeX 符号在笔记中添加数学公式。

行内数学公式建议的快捷键为 alt + M

数学公式块建议的快捷键为 ctrl + M

要在笔记中添加 MathJax 公式,请用双美元符号($$)将其括起来。

$$
\begin{vmatrix}a & b\\
c & d
\end{vmatrix}=ad-bc
$$

你也可以用 $ 符号包裹数学公式来实现行内数学公式。

这是一个行内数学表达式 $e^{2i\pi} = 1$。

这是一个行内数学表达式 

想了解更多有关语法的信息,请参阅MathJax 基础教程

要查看支持的 MathJax 包列表,请参阅TeX/LaTeX 扩展列表。 #TODO

脚注

你可以使用以下语法向笔记中添加脚注

这是一个简单的脚注[^1]。
 
[^1]: 这是脚注的内容文本。
[^2]: 在每一行的开头添加2个空格,
  可以编写跨越多行的脚注。
[^注释]: 可以使用非数字来命名脚注。但渲染时,脚注仍然会显示为数字。这样可以更容易地识别脚注内容。

你也可以在句子中使用行内脚注。请注意插入符号在方括号外,将脚注内容写在方括号内。

你也可以使用内联脚注。^[这是一个内联脚注。]

笔记

行内脚注仅在阅读视图中有效,不适用于实时预览。

表格

可以使用竖线(|)和短横线(-)来创建表格。竖线用于分隔列,短横线用于定义列标题。

建议的快捷键为 ** alt + B**

 名字 | 姓氏 
 ---- | ---- 
 麦克斯 | 普朗克 
 玛丽 | 居里 
名字姓氏
麦克斯普朗克
玛丽居里

表格两侧的竖线是可选的。

格式化表格内容

你可以使用本文的语法来为表格内的内容添加基本样式,比如链接。

单元格内的竖线

如果在单元格内要使用竖线,使用反斜杠来转义所用竖线

定义单元格文本对齐方式

在短横线行使用 冒号 来定义左中右对齐。

左对齐文本 | 居中文本 | 右对齐文本
:-- | :--: | --:
内容 | 内容 | 内容

图表

可以使用 Mermaid 语法在笔记中使用代码块 TODO 添加图表和流程图。Mermaid 支持多种图表,如流程图时序图时间线等。

想了解更多有关创建图表的信息,请参阅Mermaid 官方文档。 #TODO