Markdown 编辑格式
在 Obsidian 中使用 Markdown 语法来写笔记,它是一种用符号来控制排版的写法。例如,你在文字前面加 #,它就变成了标题;用 ** 包住文字,它就变成了加粗。和 Word 不同的是,你不需要用鼠标去点工具栏,直接打字就能排版。
使用 Markdown 格式的好处,一是写便捷,不用使用鼠标,二是笔记软件对Markdown基础语法处理一致(对于公式、流程图展示有差异)更换笔记软件(Notion、Logseq、Typora 等)后不用重新排版,三是对AI非常友好,没有多余干扰字符,更便于 AI 理解输出渲染,这是大家可能在 DeepSeek 等AI 问答工具中复制出来的内容多为 Markdown 的原因。
温馨提示:作者已经将 Obsidian 入门教程的相关工具、插件、模板上传到网盘里,大家可文章末尾获取下载链接,希望大家多多点赞、在看、转发支持。
当然了,考虑到大家不是IT从业人员,可能不用习惯 Markdown 语法怎么办?没事,一切能用插件解决的问题都不叫问题,可以安装 Editing Toolbar 插件或者使用 Obsidian 自带右键选项。安装之后,笔记上方会出现一排格式按钮(加粗、斜体、标题、列表等),和 Word 的工具栏类似,不过作者还是建议熟悉适应一下 Markdown 语法,一旦用习惯了,写文章、笔记的速度也会快很多。
在 Markdown快速入门学习到实践指南 和 Markdown数学公式LaTex语法介绍速查指南 两篇文章中作者已经对 Markdown 基础语法以及 MathJax 和 LaTeX 符号公式语法进行介绍了,此次不在针对此部分内容详细进行介绍,各位看友可访问作者星球或者参考基础格式语法详细学习。
换行:默认情况下按一次 `Enter` 会在笔记中创建新行,但在渲染输出中,这被视为同一段落的_延续_注释:使用 %% 注释文字或段落# 这是一级标题## 这是二级标题### 这是三级标题#### 这是四级标题##### 这是五级标题###### 这是六级标题**加粗文本***斜体文本***加粗文本和_嵌套斜体_文本*****加粗和斜体文本***~~删除线文本~~==高亮文本==[Obsidian 帮助](https://help.obsidian.md)%% 使用 %20 或者 用尖括号 转义 URL 中的空格。[我的笔记](obsidian://open?vault=MainVault&file=My%20Note.md)[我的笔记](<obsidian://open?vault=MainVault&file=My Note.md>)%% 图片显示尺寸,以及按原始宽高比缩放> 用一个学者的姿态追前人.%% 在文本前添加 `-`、`*` 或 `+` 来创建无序列表,使用 Shift+Enter 在有序列表中插入换行而不改变编号。- 第一个列表项- 第二个列表项- 第三个列表项%% 创建有序列表,每行以数字开头,后跟 `.` 或 `)` 符号。1. 第一个列表项2. 第二个列表项3. 第三个列表项%% 可以将任何类型的列表——有序、无序或任务列表——嵌套在任何其他类型的列表下1. 第一个列表项2. 有序嵌套列表项3. 第二个列表项- 无序嵌套列表项%% 任务列表- [x] 这是一个已完成的任务。- [ ] 这是一个未完成的任务。%% 同样,你可以通过缩进一个或多个列表项来创建嵌套任务列表:- [ ] 任务项 1- [ ] 子任务 1- [ ] 任务项 2- [ ] 子任务 1%% 分隔线:使用三个或更多的星号 `***`、连字符 `---` 或下划线 `___` 单独占一行来添加水平分隔线。%% 代码行内代码: 行中 `反引号` 内的文本将被格式化为代码。代码块:将代码格式化为代码块,请用三个或更多反引号或三个或更多波浪号包围它,农民回去了在第一组反引号后添加语言代码来为代码块添加语法高亮。嵌套代码块: 外层块使用四个或更多反引号(或波浪号),而内层块使用三个:```jsfunction fancyAlert(arg) {if(arg) {$.facebox({div:'#foo'})}}```%% 脚注这是一个简单的脚注[^1]。[^1]: 这是引用的文本。[^2]: 在每个新行的开头添加 2 个空格。这样你就可以编写跨多行的脚注。[^note]: 命名脚注仍然显示为数字,但可以更容易地识别和链接引用。%% 转义- 星号:`*`- 下划线:`_`- 井号:`#`- 反引号:`` ` ``- 管道符(用于表格):`|`- 波浪号:`~`
这里主要针对 Obsidian 风格的 Markdown 语法以及可扩展语法做简单介绍:
Table (表格)
特别要注意 表格 的语法,可以使用竖线(`|`)和短横线(`-`)来创建表格。竖线用于分隔列,短横线用于定义列标题,在表格中也支持嵌入链接及图片。
| 平台 | 名称 || --- | --- || 公众号 | 全栈工程师修炼指南 || 知识星球 | 全栈工程师修炼指南 ||[[笔记标题|笔记文件链接显示名称]] | ![[og-image.png|200]]|
此外,单元格不需要与列完全对齐,每个标题行至少要有两个短横线。还可通过在标题行中添加冒号(:),你可以将文本左对齐、居中或右对齐。
md
# 示例1
平台 | 名称
---- | ----
公众号 | 全栈工程师修炼指南
知识星球 | 全栈工程师修炼指南
# 示例2
左对齐文本 | 居中文本 | 右对齐文本
:-- | :--: | --:
内容 | 内容 | 内容
温馨提示
如果觉得手写表格太麻烦,可以安装 Advanced Table 插件,体验会更像 Excel。
Linkling(内部链接)
Obsidian 支持两种笔记间内部链接的格式。
Wiki 链接:[[牛顿运动三定律]]
Markdown:[牛顿运动三定律](牛顿运动三定律.md)
另外,Obsidian 支持在当前笔记中插入文件,只需要在内部链接前加上感叹号(!)即可,例如
在当前笔记中插入另一篇笔记或者你也可以插入特定笔记中的标题和块:
md
![[需要插入的笔记标题]]
![[内部链接#^b15695]]
在笔记中插入图片:
md
![[logo.jpg]]
![[logo.jpg|100]]
在笔记中插入音频文件:
md
![[Excerpt from Mother of All Demos (1968).ogg]]
在笔记中插入 PDF 文件,也可指定插入特定页数,以及还可以为插入的 PDF 阅读器指定高度(以像素为单位),通过在链接中添加#height=[数字]
md
![[Document.pdf]]
![[Document.pdf#page=3]]
![[Document.pdf#height=400]]
Embed (嵌入)
在笔记中插入列表 :要在当前笔记中插入其他笔记中的列表,首先需要为这个列表添加一个块标识符:
md
- 列表项 1
- 列表项 2
^my-list-id
%% 然后使用块标识符链接到列表,并加上感叹号即可:
![[My note#^my-list-id]]
在笔记中嵌入搜索结果,例如:要在笔记中嵌入搜索结果,添加一个 query 代码块:
md
```queryembed OR search```
特别注意
Obsidian Publish 不支持嵌入的搜索结果。要查看实时渲染示例,请在你的仓库中使用上面的代码块。
Callout(提示框)
其中 Obsidian 支持 Callout(提示框),支持用引用语法做出不同样式的提示框,及上表中的 > [!note], 常用的类型有:note、tip、warning、info、question、
> [!note] 备注> 这是一个备注内容> [!tip] 提示> 这是一个提示内容> [!info] 信息> 这是一个信息内容>> [!warning] 注意> 这是一个警告内容> [!question] 问题> 这是一个问题内容> [!example] 问题> 这是一个问题内容
Mermaid(图表)
另外,你可以使用 Mermaid 语法在笔记中添加图表和流程图。Mermaid 支持多种图表,如流程图、时序图和时间线等,想了解更多有关创建图表的信息,请参阅Mermaid 官方文档。
```mermaidsequenceDiagramAlice->>+John: 你好 John,你好吗?Alice->>+John: John,你能听到我吗?John-->>-Alice: 嗨 Alice,我能听到你!John-->>-Alice: 我感觉很好!``````mermaidgraph TD生物学 --> 化学```%% 如果你的图表中有很多节点,你可以使用以下代码片段。```mermaidgraph TDA[生物学]B[化学]A --> Bclass A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z internal-link;``````mermaidpacket-betatitle UDP Packet0-15: "Source Port"16-31: "Destination Port"32-47: "Length"48-63: "Checksum"64-95: "Data (variable length)"```
温馨提示: 如果记不得这多 Mermaid 样式,可以安装 Mermaid Toolbar 插件,体验会更好,或者使用Mermaid Live Editor 网页在线工具。
MathJax(数学公式)
最后,Obsidian 支持使用MathJax和 LaTeX 符号在笔记中添加数学公式,要在笔记中添加 MathJax 公式,请用双美元符号($$)将其括起来。
$$begin{vmatrix}a & b\c & dend{vmatrix}=ad-bc$$
你也可以用 $ 符号包裹数学公式来实现行内数学公式。
这是一个行内数学表达式 $e^{2ipi} = 1$。
想了解更多有关语法的信息,请参阅MathJax 基础教程,若要查看支持的 MathJax 包列表,请参阅TeX/LaTeX 扩展列表。
关注《全栈工程师修炼指南》公众号回复《obsidian入门教程》获取学习文章及相关工具。
温馨提示:若文章代码块中存在乱码或不能复制,请联系作者,也可通过文末的阅读原文链接。
学习:作者知识星球
『 全栈工程师修炼指南』星球,主要涉及全栈工程师(Full Stack Development)实践文章,持续更新包括但不限于企业SecDevOps和网络安全等保合规、安全渗透测试、编程开发、云原生(Cloud Native)、物联网工业控制(IOT)、人工智能Ai,从业书籍笔记,人生职场认识等方面资料或文章。
238