Markdown超级教程 Obsidian版
部分格式, 在渲染会有点问题, 本文主要是转载后我作为一个速查表, 具体效果展示可以参考原文或者小伙伴自己尝试一下.
什么是 Markdown?
- Markdown 是一款轻量级标记语言,不同于HTML (Hypertext Markup Language),Markdown 的语法非常简单,且容易上手
- Markdown 以 纯文本格式 编写文档,依赖键盘而非鼠标,专注于写作本身,感受书写的魅力
- Markdown 的通过添加一些简单的 标识符,让文本具有恰到好处的格式
- Markdown 核心特征就是 删繁剪芜, 简扼 + 精炼
- Markdown 是 笔记 与 网页文章 的最佳载体
- Down 的核心:坐 下 来,就能把思维写 下 来
- 牛津高阶英汉双解词典第九版 中,关于 down 的释义:
- 牛津高阶英汉双解词典第九版 中,关于 down 的释义:
为什么要使用 Markdown?
有朋友问我 ,Markdown 的效果 用Word 完全可以复现,甚至功能更多,那为何要用 Markdown 呢?
答:
- 功能多,不一定是好事
- 功能一多,选择就会变多,然后你会开始纠结……
- 这个字号是不是该大一点呢?
- 这个颜色好像有点不太搭呢?
- 这个粗体,是不是该再加点颜色呢?
- 这个图片的位置看起来有点不大对劲呢?
- 结果,写了半天,就憋出一点点东西
- 写出来的内容…好像…也不咋滴
- 功能一多,选择就会变多,然后你会开始纠结……
MD的优势:
- Markdown 让我们免于 被繁杂臃肿的功能晃花了眼 的困扰
- Markdown 让我们回归内容本身,拥抱笔记的内核,而非浮于表象的样式,写出高效精练的笔记!
用 Markdown 写东西,记住一个原则
能用10个字搞定的,绝不用11个字
经常使用 Markdown 书写的朋友,也许会有一种奇妙的感触
- 书写,会倒逼思维的跃进。像是有东西拽着你的思绪往前冲
- 倒逼:逆向逼迫,反向推动
关于标识符的滥用
这个其实是写在最后的,之所以放在这里,是因为它很重要!
如果你有一定的MD语法基础,可以直接[[#19. 避免标识符的滥用|点击跳转]]
Markdown 相关软件推荐
- Markdown 书写软件 推荐:Typora 优秀的 MD网页文章 书写软件
- 点击跳转下载地址
- [#提示] 以前是免费的,现在收费了,不过是买断制
- 点击跳转下载地址
- Markdown 笔记软件 推荐:Obsidian 银河系最强 MD+双向链 笔记软件
Markdown 语法
- 提示1: 本教程推荐使用 Obsidian 打开阅读
- 提示2: 下文提到的所有标识符都是 英文状态 的 !
1. 标题&目录
1.1 标题
- Markdown标题共有 六级,和 HTML 一样
- 区分 一级标题 → 六级标题
- 标题 的格式:
- # × 标题级数 + 空格 + 文本内容
- 标题 的格式:
1 | 这是一段普通的文本 |
1.2 目录
- 目录的 格式:
- 在文档的顶部 输入
[toc]
,会根据 标题 自动生成目录 ( Table of Content )
- 在文档的顶部 输入
- 不是所有 MD编辑器 都支持目录生成
- Obsidian 就不支持,不过 OB 是自带大纲的,就是目录的效果
1 | 输入下方内容会生成一个目录: |
2. 斜体&粗体
2.1 斜体
- 斜体 的格式:
*
+ 文本内容 +*
_
+ 文本内容 +_
( 下划线 )
- 说明:
- 斜体文本,首尾只有 单个 标识符
1 | 这是一段普通文本 |
示范
这是一段普通文本
这里是一段斜体文本
这也是一段斜体文本
2.2 粗体
- 粗体 的格式:
**
+ 文本内容 +**
__
+ 文本内容 +__
(这里是两个 _ )
- 说明:
- 粗体文本,首尾各有 两个 标识符
1 | 这是一段普通文本 |
示范
这是一段普通文本
这里是一段加粗文本
这也是一段加粗文本
2.3 粗斜体 (斜粗体)
- 粗斜体 的格式:
***
+ 文本内容 +***
___
+ 文本内容 +___
( 这里是3个 _ )**_
+ 文本内容 +_**
__*
+ 文本内容 +*__
*__
+ 文本内容 +__*
_**
+ 文本内容 +**_
- 说明:
- 粗斜体文本,首尾各有 三个 标识符
1 | 这是一段普通文本 |
示范
这是一段普通文本
粗斜体文本1
粗斜体文本2
粗斜体文本3
粗斜体文本4
粗斜体文本5
粗斜体文本6
2.4 斜体包含粗体
- 斜体中包含粗体 的格式:
*
+ 斜体文本 +**
+ 粗体文本 +**
+ 斜体文本 +*
_
+ 斜体文本 +__
+ 粗体文本 +__
+ 斜体文本 +_
( 这里是两个 _ )*
+ 斜体文本 +__
+ 粗体文本 +__
+ 斜体文本 +*
_
+ 斜体文本 +**
+ 粗体文本 +**
+ 斜体文本 +_
- 说明:
- 斜体 中包含 粗体,其实就是嵌套的关系,外层 是 斜体,内层 是 粗体
- 外层是斜体,标识符是单个;内层是粗体,标识符是两个
- 因为 粗体 是被包裹在 斜体 中的,所以显示效果为 斜粗体
1 | 这是一段普通文本 |
示范
这是一段普通文本
这里是一段斜体中包含粗体的文字
这也是一段斜体中包含粗体的文字
这又是一段斜体中包含粗体的文字
这还是一段斜体中包含粗体的文字
2.5 粗体包含斜体
- 粗体中包含斜体 的格式:
**
+ 粗体文本 +*
+ 斜体文本 +*
+ 粗体文本 +**
__
+ 粗体文本 +_
+ 斜体文本 +_
+ 粗体文本 +__
( 这里是两个 _ )**
+ 粗体文本 +_
+ 斜体文本 +_
+ 粗体文本 +**
__
+ 粗体文本 +*
+ 斜体文本 +*
+ 粗体文本 +__
- 说明:
- 粗体 中包含 斜体,也就是嵌套的关系,外层 是 粗体,内层 是 斜体
- 外层是粗体,标识符是两个;内层是斜体,标识符是单个
- 因为 斜体 是被包裹在 粗体 中的,所以显示效果为 粗斜体
1 | 这是一段普通文本 |
示范
这是一段普通文本
这里是一段粗体中_包含斜体_的文字
这也是一段粗体中_包含斜体_的文字
这又是一段粗体中_包含斜体_的文字
这还是一段粗体中_包含斜体_的文字
3. 线
3.1 水平分割线
- 水平分割线由至少 3 个
*
或-
组成
1 | 下面是一条水平分割线: |
示范
3.2 文本删除线
- 删除线 的格式:
~~
+ 文本内容 +~~
首尾各加两个 ~ 波浪号
1 | ~~这是一段加了删除线的文本~~ |
示范
这是一段加了删除线的文本
3.3 文本下划线
- 下划线的格式,和 HTML 是一样的
<u>
+ 文本内容 +</u>
1 | <u>这是一段加了下划线的文本</u> |
示范
这是一段加了下划线的文本
4. 列表&引用
4.1 有序列表
有序列表 的格式:
1.
+ 空格 + 文本内容
说明:
- 输入文本内容后,敲击 Enter 自动补全格式,并进入 下个 有序列表
- 若需要在同个列表内,增加 换行显示 的内容 (但不进入下个列表)
敲击 Shift + Enter ,即可另起一行输入文本 - 在有序列表的中间,插入一个新的列表,后面列表的 数字序号 会自动 递进 一层
- 即便在源代码模式中修改了数字序号,渲染界面依然是 依照顺序 显示的
1 | 1. 这是第一个有序列表 <!-- (Enter) --> |
示范
这是第一个有序列表
这是第二个有序列表
这是第三个有序列表
这是第一个有序列表
这是同个列表下,另起一行的文本内容这是第二个有序列表
这是同个列表下,另起一行的文本内容
补充
- 由于有序列表存在强制排序性,它的数字序号必然是逐一递进的
若你希望内容前的数字,不依照递进顺序排序,或者以 整百,整十数 排序 - 可以配合无序列表,在无序列表中输入:
数字
+.
+ 内容
[#注意] 点号 与 内容 之间,没有空格 (其实有空格也行,就是会感觉有点奇怪)
1 | - 10.这是无序列表下,整十数排列的内容 |
效果:
10.这是无序列表下,整十数排列的内容
20.这是无序列表下,整十数排列的内容
30.这是无序列表下,整十数排列的内容
100.这是无序列表下,整百数排列的内容
200.这是无序列表下,整百数排列的内容
300.这是无序列表下,整百数排列的内容
4.2 无序列表
- 无序列表 的格式:
- - + 空格 + 文本内容
- 说明:
- 输入文本内容后,敲击 Enter 自动补全格式,并进入 下个 无序列表
- 若需要在同个列表内,增加换行显示的内容 (但不进入下个列表)
敲击 Shift + Enter ,即可另起一行输入文本
1 | - 这是第1个无序列表 <!-- (Enter) --> |
示范
这是第1个无序列表
这是第2个无序列表
这是第3个无序列表
这是第一个无序列表
这是同个列表下,另起一行的文本内容这是第二个无序列表
这是同个列表下,另起一行的文本内容
列表可在OB中,设置快捷键,在 批量处理与取消上 会更方便
4.3 引用
- 引用 的格式:
- > +
空格
+ 文本内容 (空格可加可不加,我推荐是加上)
- > +
- 说明:
- 同个引用段落内的换行直接敲击 Enter 即可
- 若需添加 第二个独立引用段落 ,连续敲击 两下 Enter 即可
1 | > 这是第一段引用文本的第1行 <!-- (Enter) --> |
注: 后面的 >
敲回车
会自动补上
示范
这是第一段引用文本的第1行
这是第一段引用文本的第2行
这是第二段引用文本的第1行
这是第二段引用文本的第2行
.4 缩进&退格
在列表和引用的书写过程中,我们需要利用 缩进 与 退格 ,让文章肌理分明,更具层级
- 缩进:
- Tab
- Ctrl + [ (左中括号)
- 退格:
- Shift + Tab
- Ctrl + ] (右中括号)
4.4.1 有序列表的缩&退
1 | 1. 第一级有序列表1 <!-- (Enter) --> |
- 补充说明:
- 有序列表的数字序号,即便你在源代码模式里 强行改掉 数字,它仍然会 依照顺序 显示
示范
- 第一级有序列表1
- 第二级有序列表1
- 第二级有序列表2
- 第一级有序列表2
4.4.2 无序列表的缩&退
1 | - 第一级无序列表1 <!-- (Enter) --> |
示范
- 第一级无序列表1
- 第二级无序列表1
- 第二级无序列表2
- 第一级无序列表2
4.4.3 引用的缩&退
- 引用的 缩进 和列表 不同
- 引用需另起一行,并额外多打一个 > 来完成 缩进
- 如果要退回上一级,敲2下回车键即可
源码
1 | > 这是第一级引用 |
示范
这是第一级引用
这是第二级引用
这里又是第一级引用了
4.4.4 有序&无序&引用 连续套娃
- 有序列表、无序列表、引用 三者之间,可以相互嵌套
- 核心键 : Shift + Enter & Enter & Shift + Tab ( 或 Ctrl + [ )
- Shift + Enter 在切换格式的嵌套中,是 自带一层 缩进 效果的
1 | 1. 第一级 有序列表1 <!-- (Shift + Enter) --> |
示范
第一级 有序列表1
第二级 无序列表1
第三级 引用1
- 第四级 无序列表2
- 第五级 有序列表2
- 第四级 无序列表3
第三级 引用2
- 第四级 无序列表2
第二级 无序列表4
第一级 有序列表3
4.4.5 Obsidian 的一些缩退问题
- Obsidian 在列表首行使用缩进的时候,后续的列表会出现一些问题
Tab
和Shift + tab
会无法 缩进 退格- 可以使用
Ctrl + ]
与Ctrl + [
来解决问题
- 可以使用
1 | - - 这是第一段就被缩进的列表 |
- 这是第一段就被缩进的列表
- 这是第二段被再次缩进的列表
- 这是第三段列表
- 这是第一段就被缩进的列表
5. 网页链接与图像
5.1 网页链接
- 网页链接的 格式:
- [ + 显示文本内容 + ] + ( + 链接地址 + 空格 + “ + 提示信息文本 + “ + )
- 说明:
- 显示文本内容,是在渲染界面实际 可见 的文本,用以 说明 链接
- 提示信息文本,需鼠标悬停于 显示文本内容 方可触发,用于增加额外提示信息
- [#注意]
"提示信息文本"
是可选项,一般不会填 - 一般来讲,需按住 Ctrl +
鼠标左键点击
才可跳转链接,不过也有 直接鼠标点击 就能跳转的
- [#注意]
1 | [显示文本内容](链接地址 "提示信息文本") |
示范:
5.1.1链接的加粗
- 格式有两种:
5.2 图像
- 图像格式:
- 图像格式,就是在网页链接前面加个 ! (英文格式的),**
!
** 代表 可见 - 图片的提示信息,和网页链接一样,写在
" "
内 [ ]
方括号里的文字信息在 Markdown 没啥实质的作用,只是方便在源代码模式下,知道这个图片是什么,在渲染界面是不会显示的。有点类似于HTML img标签 里的 alt属性。
- 图像格式,就是在网页链接前面加个 ! (英文格式的),**
1 | ![文字信息](图片链接 "提示文本信息") |
补充:
- 图像链接可以是本地的,也可以是在线的
- 本地图像直接
Ctrl + C
黏贴,**Ctrl + V
** 复制 就可以 - 在线图像推荐使用 图床
- 本地图像直接
- 调整图像的大小需要使用 HTML 和 CSS,在 Typora编辑器 中右键可以直接缩放图片
本质是转成了HTML的格式,最后会有一个style="zoom: %;"
,这里数值可以自己修改 - 如果有使用 Obsidian 的朋友,在线图片链接是通用的。不过,因为 Obsidian 是双向链笔记
它的本地图片格式不太一样![[图片名]]
- Obsidian 中的图片是以双链的格式引用在目标笔记中,用 ! 使它可见
- Obsidian的图片设置大小是用
|
分隔,后面写宽度数值,单位默认是 px
设定好宽度,高度会自动等比例调整![[图片名|宽度数值]]
- 若想自主调整图片宽高,则用:
![[图片名|宽度数值x高度数值]]
- [#提示] 这里的
x
是 英文字母x
- [#提示] 这里的
- 若想自主调整图片宽高,则用:
- 如果是在线图床,需要调整图片大小:
![图床|宽度数值](链接地址)
- 图像链接可以是本地的,也可以是在线的
示范
6. 表格
- Markdown的表格,比HTML简单很多
- | 是构成表格的主要 框架
- - 区分 表头 和 表格主体
- : 控制 表格内 文本内容 的 对齐方式
- Typora编辑器中 输入
Ctrl + T
即可快速插入表格,自由定义样式
1 | |这里是表头1|这里是表头2|这里是表头3| |
示范
这里是表头1 | 这里是表头2 | 这里是表头3 |
---|---|---|
单元格数据1 | 单元格数据2 | 单元格数据3 |
单元格数据4 | 单元格数据5 | 单元格数据6 |
6.1 表格中文本内容的换行
- Mardown中表格,它的宽高是由 单元格数据内的文本内容 撑开 的
- 当我们输入一段很长很长的文本,它所在的单元格会变得过宽
如下图所示:
表头1 | 表头2 |
---|---|
这是一段很长很长很长很长很长很长很长很长很长很长很长很长很长很长的文本 | 普通文本 |
- 若想对一段长文本进行换行,可以在 中间 插入一个
<br>
( 换行标签 )
1 | | 表头1 | 表头2 | |
示范
表头1 | 表头2 |
---|---|
这是第一行文本 这是另起一行的文本 |
普通文本 |
7. 代码域
7.1 行内代码
- 行内代码 的格式:
- 输入两个 ` 反引号 ,在中间写代码内容
- 补充:
- 行内代码不一定非得写代码,也可以作为**
着重标记
**,突出显示内容 - 行内代码中,源代码界面和渲染界面是完全一致的,标识符会失效
- 所谓行内代码: 只要你的屏幕足够宽,它就不会换行
- 行内代码不一定非得写代码,也可以作为**
1 | `这是一段行内代码` |
示范
<table border="1" cellspacing="0" width="500" height="500">
print("Hello, World!")
这是一行突出显示的文本内容
7.2 代码块
代码块 的格式:
- 在首行和末行各加 三个 ` 反引号
```
** + 语言种类
代码内容
**```
- 在首行和末行各加 三个 ~ 波浪号
~~~
+ 语言种类
代码内容~~~
补充:
- 在代码块也不一定要写代码,可以写一段突出的文本内容,语言类型可以填写 txt 或者 干脆不写
- 代码块中,源代码界面和渲染界面是完全一致的,标识符会失效
- 在 Typora编辑器 ,用键盘按键脱离代码块区域,需输入: Ctrl + Enter
1 | ```语言种类 |
示范
1 | <table border="1"> |
1 | .box { |
1 | // 定义一个30个整数的数组,按顺序分别赋予从2开始的偶数;然后按顺序每五个数求出一个平均值,放在另一个数组中并输出。试编程 |
1 | #!/usr/bin/python |
1 | 这是一段 |
7.2.1 代码块的嵌套
格式:
- 使用4个
`
包裹 **3**个`
示范
1 | ````txt |
如果要再套一层,就在最外层 加 5个 `
,以此类推……
7.3 如何在行内代码里显示反引号
首尾各用 两个反引号`
+ 空格
包裹
格式:
1 | ``+空格+带`的内容+空格+`` <!-- 不要忘记前后的两个空格 --> |
效果:
这是一段能显示`反引号`的行内代码
8. 任务列表(待办)
任务列表 的格式:
- - + 空格 +
[ ]
+空格 + 任务列表内容 ( 中括号[ ]
里面必须有个空格) - 给待办任务列表打
√
,变成 已办- 在渲染界面,直接鼠标左键点击框框
- 在源代码界面,在中括号内输入 英文字母x
- 部分编辑器,在 中括号内 输入任意字符都可以打
√
( 例如 Obsidian )
- 部分编辑器,在 中括号内 输入任意字符都可以打
- - + 空格 +
补充:
- 大部分 MD编辑器 支持输入第一个任务列表后,按下 Enter 进入下一行会 自动补全待办格式
- 在Obsidian中,输入
Ctrl + Enter
,即可生成一个待办列表- 再输入一次
Ctrl + Enter
,会在待办列表 打√
- 再输入一次
格式:
1 | - [ ] 待办任务列表1 |
示范
待办任务列表1
待办任务列表2
已办任务列表1
已办任务列表2
任务列表也是可以缩进+退格的,操作跟 无序、有序列表一样
示范
- 第一级待办列表1
- 第二级待办列表1
另起一行的第二级待办列表1- 第三级已办列表1
- 第三级已办列表2
- 第二级待办列表2
另起一行的第二级待办列表2
- 第二级待办列表1
- 第一级待办列表2
9. 注释
Markdown 的 注释 和 HMTL 一样,注释的内容在 渲染界面 不可见 (部分编辑器可见)
- 注释 的格式:
<!-- 这里是注释的内容 -->
- 注释可以是单行,也可以是多行
- 如果有在使用 Obsidian 的,它的注释格式是不一样的
%%这是Obsidian的注释内容%%
1 | <!-- 这里是一行注释 --> |
示范 (只有切换至 编辑模式 才能看到喔)
%%这是一行Obsidian里的注释%%
%%
这里是
一段
假装有
很多行的
Obsidian里的
注释
%%
10. 变量
10.1 网页链接变量
- 网页链接变量 的格式:
- 首先输入
[显示文本内容]
+[变量名]
- 变量名可以自己取,没啥限制,任意字符都可以
- 在文档任意一个区域,输入:
[变量名]
+ : + 空格 + 链接地址 (这个空格 不打也没事)
- 首先输入
1 | [百度一下,你就知道][度娘] |
示范
10.2 脚注
- 脚注 的格式:
- 在需要脚注的地方,输入:
[^脚注代号]
( 脚注代号会直接显示在渲染界面 )- 脚注代号可以随便命名,不过推荐使用 数字序号
- 在其他区域,输入:
[^脚注代号]
+ : + 空格 + 脚注内容 (这个 空格 不打也没事)
- 在需要脚注的地方,输入:
1 | 鲁迅原名是什么[^1] ,浙江哪里人[^2] |
示范
11. 拓展文本格式标记
- Markdown 想实现更多的文本显示效果,只能依赖HTML标记实现
- 个人不是很推荐在 MD 中使用 HTML,不过一些简单的标记还是可以 轻度使用 的
11.1 键盘文本
- 键盘文本的 格式:
<kbd>键盘文本</kbd>
<kbd>Ctrl</kbd> + <kbd>X</kbd>
- 效果:
- 键盘文本
- Ctrl + X ( 剪切 )
- 说明:
- 键盘文本也不一定非得是键盘按键,也可以作为着重文本突出显示
- 效果: 这也算一种着重文本的方式
- 键盘文本也不一定非得是键盘按键,也可以作为着重文本突出显示
11.1.1 加粗键盘文本
- 加粗键盘文本的格式有两种:
<kbd>**键盘文本**</kbd>
**<kbd>ctrl + x</kbd>**
- 效果:
- 键盘文本
- ctrl + x
11.2 放大文本
- 放大文本 的格式:
这是一段普通文本
<big>这是一段放大文本</big>
- 效果:
- 这是一段普通文本
这是一段放大文本
- 这是一段普通文本
11.2.1 放大粗体文本
- 放大加粗文本的格式有两种:
**<big>这是一段放大粗体文本</big>**
<big>**这是一段放大粗体文本**</big>
- 效果:
- 这是一段放大粗体文本
- 这是一段放大粗体文本
11.3 缩小文本
- 缩小文本 的格式:
这是一段普通文本
<small>这是一段缩小文本</small>
- 效果:
- 这是一段普通文本
这是一段缩小文本
- 这是一段普通文本
11.3.1 缩小斜体文本
- 斜体缩小文本 的格式有两种:
<small>*这是一段缩小斜体文本*</small>
*<small>这是一段缩小斜体文本</small>*
- 效果:
- 这是一段缩小斜体文本
- 这是一段缩小斜体文本
11.4 多彩文本
11.4.1 多彩粗体文本
- 只需要在上面示例的基础上,加上 加粗标识符,有两种格式:
- 格式1:
**<font color=teal>这是一段加粗的水鸭色文本</font>**
- 效果: 这是一段加粗的水鸭色文本
- 格式2:
<font color=teal>**这是一段加粗的水鸭色文本**</font>
- 效果: 这是一段加粗的水鸭色文本
- 格式1:
- 若上述混搭方法的样式失效 ,可以使用 纯HTML标记
- 格式:
<strong style="color:teal;">这是一段加粗的水鸭色文本</strong>
(标记略复杂,不是很推荐) - 效果:这是一段加粗的水鸭色文本
- 格式:
11.4.2 多彩斜体文本
- 跟多彩加粗文本完全一样,只需把首尾的
**
换成*
即可
- 格式1:
*<font color=teal>This is an italic teal text</font>*
- 效果: This is an italic teal text
- 格式2:
<font color=teal>*This is an italic teal text*</font>
- 效果: This is an italic teal text
11.4.2 多彩粗斜体文本
- 首尾换成
***
- 格式1:
***<font color=teal>This is a bold italic teal text</font>***
- 效果: This is a bold italic teal text
- 格式2:
<font color=teal>***This is a bold italic teal text***</font>
- 效果: This is a bold italic teal text
[#注意] 多彩文本尽量慎用,Markdown 的核心就是 简洁精炼,注重 实质内容,而非花哨的 颜色样式
12. 拓展文本显示效果
- 拓展显示效果既不是原生 Markdown语法 支持的,也非 HTML标记,而是部分编辑器 提供的 额外标识符,属于拓展语法,旨在为 Markdown使用者 提供更多样式选择
- 不同编辑器,支持不一样,这里以 Typora编辑器 为例
12.1 文本高亮
- 文本高亮 的格式:
==这里是一段高亮文本==
- 效果:
- ==这里是一段高亮文本==
12.2 上标
- 用一对 ^ 包裹 (Shift+ 6)
- 格式:
x^2^
- 效果: x^2^
- 格式:
- Obsidian 没效果的,可以用后面会讲的 Latex
- 或者,也可以使用 HTML标记
<sup>这里是上标内容</sup>
X<sup>2</sup>
- 效果:
- X2
12.3 下标
- 用一对 ~ 包裹 (Shift + `)
- 格式:
H~2~O
- 效果: H
2O
- 格式:
- Obsidian 没效果的,可以用后面会讲的 Latex
- 或者,也可以使用 HTML标记
<sub>这里是下标内容</sub>
H<sub>2</sub>O
- 效果:
- H2O
12.4 Emoji 符号
用一对 : 包裹,里面是 Emoji 符号的 语义化文本 ( Typora编辑器 中,输入 :
就会带提示器 )
示例:
:smile:
:sweat:
:cat:
:woman_cartwheeling:
效果:
- :smile:
:sweat:
:cat:
:woman_cartwheeling:
- :smile:
补充:
- 不支持上述方式的 MD编辑器或笔记软件,直接用 输入法 输入也是可以的
- Windows系统 用户 win + . 就可以输入 Emoji 了
- Obsidian 用户可以安装第三方插件来支持 Emoji 的输入,推荐两个
- ==Emoji Shortcodes==
- ==Emoji Toolbar==
13. 转义字符
- 在 Markdown 中,我们 通过 标识符 改变 文本显示效果
- 现在我们希望它不作为标识符,而是 作为字符本身呈现出来 (不具备改变文本显示效果的功能,只是一个普通字符)
- 首先我们可以用前面介绍的 代码域 ,因为代码模式的显示效果就是源代码完全一致的
- 还有一种方法,可以利用转义字符,在这些标识符 前面 加上 反斜线 * ( 反斜线要紧贴在标识符前面,不能* 有 空格 )
- 原理:
\
的作用是让标识符 转义 变为一个普通字符,完成这个效果后,反斜线会自动隐藏- 隐藏后的反斜线仅在源代码界面可见,在渲染界面不可见
- 反斜线只争对标识符起作用,其他字符添加
\
,\
不会自动隐藏
- 补充:
- 如果想给已经被加在标识符前面,会自动隐藏的
\
显示出来,可以在反斜线前面再加一个 * ,用它自己来转义自己*- 示例:
这里紧跟在标识符前面的反斜线\\*会被转义成普通字符显示出来,不会自动隐藏,且这段文件会是斜体*
- 效果: 这里紧跟在标识符前面的反斜线\会被转义成普通字符显示出来,不会自动隐藏,且这段文件会是斜体
- 示例:
- 如果想给已经被加在标识符前面,会自动隐藏的
- 原理:
例1 以普通字符显示星号
- 如何让被一对或多对
*
号 包裹的文本内容,能够正常显示*
,且文本不改变格式\*这段文本被一对星号包裹,但不会倾斜\*
- 效果: *这段文本被一对星号包裹,但不会倾斜*
\*\*这段文本被2对星号包裹,但不会加粗\*\*
- 效果: **这段文本被2对星号包裹,但不会加粗**
\*\*\*这段文本被3对星号包裹,但它既不倾斜也不加粗\*\*\*
- 效果: ***这段文本被3对星号包裹,但它既不倾斜也不加粗***
例2 表格内 单元格中的竖杠
- 在表格中,使用 | 作为单元格的内容,但不会被识别为表格的结构,不会增加额外的单元格
1 | |表头1|表头2| |
- 效果:
表头1 | 表头2 |
---|---|
这里的文本被|分隔 | 这里的文本也被|分隔 |
[#补充] 该技巧可用于 Obsidian 表格内 双链的文本修饰
文本修饰:
在 双链[[ ]]
内 以 |
引导的内容
- 格式:
[[链接的内容|文本修饰]]
- 说明: 文本修饰是渲染界面实际显示的文本,便于更好地融入语境
表格内的格式:
在 |
前面加上 \
[[表格内的链接内容\|文本修饰]]
示例:
1 | | 表头1 | 表头2 | |
表头1 | 表头2 |
---|---|
[[#例2 表格内 单元格中的竖杠|单元格中的竖杠]] | [[#例3 不会变成代码的反引号|不会变成代码的反引号]] |
例3 不会变成代码的反引号
使用 转义符号\
让 反引号`
变成普通字符,不再具有[[#7.1 行内代码|行内代码]]的标识符功能
格式:
\`这段被反引号包裹的内容不会变成行内代码\`
效果:
`这段被反引号包裹的内容不会变成行内代码`
例4 链接中的中括号
在 网页链接 的 显示文本内容 中,使用 中括号 [ ]
- 在显示文本内容中,在其中一个中括号前面,加上转义符号 反斜杠 **
- 格式:
[链接里的 \[中括号\] 能被正常显示](https://www.runoob.com)
- 效果: 链接里的 [中括号] 能被正常显示
- 格式:
例5 不是列表的连接符(横杠)
- 引用一段话,一般会在换行之后,加上
- 出处
- 因为 - 是标识符,会变成一个无序列表
如下所示:
The Web, the Tree, and the String.
写作之难,在于把网状的思考,用树状结构,体现在线性展开的语句里。
- 史蒂芬·平克
解决方法:
- 在 - 前面加上 转义符号 **
1
2
3> The Web, the Tree, and the String.
> 写作之难,在于把网状的思考,用树状结构,体现在线性展开的语句里。
> \- 史蒂芬·平克 <!-- 加上转义符号 \ , 不会变成无序列表 -->效果:
The Web, the Tree, and the String.
写作之难,在于把网状的思考,用树状结构,体现在线性展开的语句里。
- 史蒂芬·平克
例6 不是标题的
让 #
不被识别为标题标识符
格式:
\# 这里的内容不会被识别为标题
效果:
# 这里的内容不会被识别为标题
例7 不会注释的 %
在 Obsidian 中 注释是前后各两个 %
号
使用 转义符号\
,让 %%
作为普通字符显示出来,不具备注释的功能
- 格式:
\%\%这里的内容可以被显示喔\%\%
- 效果: %%这里的内容可以被显示喔%%
例8 木有链接的双链
Obsidian 的双向链格式是2个方括号 [[ ]]
(双方),使用 转义符号\
,让 [
]
不再具有 双链功能
格式:
\[\[这段文本被双方包裹,但不是一个双向链\]\]
效果:
[[这段文本被双方包裹,但不是一个双向链]]
例9 页链接里 显示文本内的 中括号
使用转义符号\
,让中括号
可以作为显示文本
在[[#5.1 网页链接|网页链接]]中显示出来
格式:
1 | [\[这是一个带中括号的网页链接显示文本,点击会跳转至百度\]](https://www.baidu.com/) |
效果:
特殊情况 文本修饰的中括号
文本修饰的 中括号[ ]
不需要使用 转义符号\
示范:
[[#例8 木有链接的双链|[这是一个带中括号的文本修饰]]]
效果:
[[#例8 木有链接的双链|[这是一个带中括号的文本修饰]]]
14. 空格&换行&强制删除
14.1 空格
- 在一些编辑器或者支持MD的笔记软件里,无论你打多少个空格,它只会显示单个 空格 的距离
- 可以使用 HTML中 空格 的 字符实体 ——
- 若要添加 多个 空格,就输入多个 ——
- 可以使用 HTML中 空格 的 字符实体 ——
- 格式:
这里有 6个空格分隔
- 效果:
- 这里有 6个空格分隔
14.2 换行
场景1:
- 在一些编辑器或者支持MD的笔记软件里,无论你打多少个 回车,它只会显示单个 回车 的空行间距
- 可以使用之前表格里提到的
<br>
标签,在 单独一行 中使用,增加额外的空行间距 - 如果要增加 多个,就输入 多个 ——
<br><br><br><br><br>
- [#注意] 当单独一行使用
<br>
标签的时候,如果前后有标题标识符或者列表标识符,确保 br元素 前后两行都是空白行
- 可以使用之前表格里提到的
格式:
1 | 这里是第一段文本 |
效果:
这里是第一段文本
这里是第二段文本
场景2:
- 在列表中也可以插入换行符
1 | - 这是一段无序列表 |
效果:
这是一段无序列表
这是同一段无序列表中,空一行距离显示的内容这是第二段无序列表
补充:
- 有一些MD编辑器或笔记软件,严格遵循MD的换行规则,你敲一个回车是没法换行的,必须在 行末 敲 2个空格,再按回车键
- 格式:
- 这里是一段想换行的文本空格 空格 Enter
这是换行后的文本
- 这里是一段想换行的文本空格 空格 Enter
- 格式:
- 有一些MD编辑器或笔记软件,严格遵循MD的换行规则,你敲一个回车是没法换行的,必须在 行末 敲 2个空格,再按回车键
14.3 强制删除
- 很多编辑器都有英文标点自动补全功能,自动生成一对,光标落在中间
只想删除前面1个,却会把 一整对 都删掉 - 在多个列表的嵌套中,也许会遇到一些 无法被删除 的 列表标识符
- 解决方法:
使用Shift
+Backspace
即可强制删除- Bcakspace ( 退格键 )
15. 嵌入
- 嵌入都是依赖 HTML标签 实现的,嵌入的都是在线链接格式
- 如果是本地的,Obsidian 中音频是有自带的可录制的录音机插件的,其他的 音频、视频 直接复制黏贴就可以了,也可以直接拖拽到OB的笔记界面
- 其他的媒体文件在 Obsidian 也和图片一样,以双链的格式引用在目标笔记中,使用 ! 使它可见
- 如果是本地的,Obsidian 中音频是有自带的可录制的录音机插件的,其他的 音频、视频 直接复制黏贴就可以了,也可以直接拖拽到OB的笔记界面
15.1 嵌入音频
格式:
<audio controls="controls" preload="none" src="音频链接地址"></audio>
示例:
1 | <audio controls="controls" preload="none" src="https://www.ldoceonline.com/media/english/exaProns/p008-001803372.mp3?version=1.2.37"></audio> |
- 效果:
15.2 嵌入视频
- 格式:
1 | <video width="600" height="420" controls> |
- 说明:
- width ( 宽度 ) height ( 高度 ) ,可以自己设置,直接输入数字即可,单位默认是 px(像素)
也可以使用 百分比width=100%
代表水平撑满整个窗口height=50%
代表垂直撑满半个窗口 - Video标签 支持的视频格式 :MP4 ogg webm
- width ( 宽度 ) height ( 高度 ) ,可以自己设置,直接输入数字即可,单位默认是 px(像素)
15.3 嵌入页面
- 格式:
<iframe width=600 height=400 src="页面链接地址" scrolling="auto" border="0" frameborder="no" framespacing="0" allowfullscreen="true"> </iframe>
1 | <iframe width=600 height=400 src="https://www.runoob.com/html/html-tutorial.html" scrolling="auto" border="0" frameborder="no" framespacing="0" allowfullscreen="true"> </iframe> |
效果:
iframe标签 除了嵌入页面,也可以嵌入在线视频,主流的视频网站都会提供嵌入代码
- 具体可以看这个 iframe视频嵌入教程
- B站 的视频,得在
//
前面补充http:
- 不是所有的 编辑器和笔记软件 都支持这个
示例:
1 | <iframe width=600 height=400 src="http://player.bilibili.com/player.html?aid=20190823&bvid=BV1yW411s7og&cid=32964980&page=1" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true"> </iframe> |
宽高设置和前面的 video 一样
效果:
16. Latex 数学公式
- 主要用于 数学公式 与 化学公式 的书写
6.1 行内公式
格式:
- $ + 行内公式 + $
示例:
$x^2 + 2x + 5 + \sqrt x = 0$
$\ce{CO2 + C -> 2 CO}$
$\ce{CO2 + C -> 2 CO}$
$\ce{2Mg + O2 ->[燃烧] 2 MgO}$
效果:
- $x^2 + 2x + 5 + \sqrt x = 0$
- $\ce{CO2 + C -> 2 CO}$
- $\ce{CO2 + C -> 2 CO}$
- $\ce{2Mg + O2 ->[燃烧] 2 MgO}$
16.2 公式块
格式:
$$
公式块$$
示例:
1 | % 化学公式 |
1 | % 麦克斯韦方程组 |
1 | % 薛定谔方程 |
- 效果:
% 化学公式
$$
\ce{Zn^2+ <=>[+ 2OH-][+ 2H+] $\underset{\text{amphoteres Hydroxid}}{\ce{Zn(OH)2 v}}$ <=>[+ 2OH-][+ 2H+] $\underset{\text{Hydroxozikat}}{\ce{[Zn(OH)4]^2-}}$}
$$
$$
\begin{array}{lll}
\nabla\times E &=& -;\frac{\partial{B}}{\partial{t}}
\ \nabla\times H &=& \frac{\partial{D}}{\partial{t}}+J
\ \nabla\cdot D &=& \rho
\ \nabla\cdot B &=& 0
\ \end{array}
$$
$$
i\hbar\frac{\partial \psi}{\partial t} = \frac{-\hbar^2}{2m} \left(\frac{\partial^2}{\partial x^2} + \frac{\partial^2}{\partial y^2}+\frac{\partial^2}{\partial z^2} \right) \psi + V \psi
$$
- 补充:
- 需要详细教程的,可戳下方链接
- Latex详细教程
17. Mermaid
这里只提供一些演示的图表,具体教程可戳下方
17.1 流程图
源码1:
1 | ```mermaid |
渲染1:
1 | graph TB |
源码2:
1 | ```mermaid |
渲染2:
1 | graph LR |
17.2 饼图
源码:
1 | ```mermaid |
渲染:
1 | pie |
17.3 序列图 (时序图)
源码:
1 | ```mermaid |
渲染:
1 | sequenceDiagram |
17.4 甘特图
源码:
1 | ```mermaid |
渲染:
1 | gantt |
17.5 类图
源码:
1 | ```mermaid |
渲染:
1 | classDiagram |
18. 标签 (Tag)
- 标签是 Obsidian 特有的一个功能,标签可以通过点击唤起快速搜索 (搜索包含该标签的所有笔记)
格式:
- # + 标签名
#标签名
关于空格
在一段正文文本的后面添加 Tag, # 的前面 需要有个空格
- 空格 + # + 标签名
# 与 标签名 之间,不能有空格,否则就变成 一级标题 了
标签名的内部,不允许使用空格,若想区分标签中的词语,可使用以下三种方法:
- 驼峰式大小写:
#BlueTopaz
- 下划线:
#blue_topaz
- 连字符:
#blue-topaz
- 驼峰式大小写:
关于数字
- 标签内允许使用数字,但不能完全由数字组成
#1984
❌#1984Date
⭕#da_1984_te
⭕#date-1984
⭕
标签的嵌套
在标签名内,使用 /
斜杠 可以实现标签的嵌套
格式:
#主标签/子标签1
#主标签/子标签2
#主标签/子标签3
嵌套标签可以像普通标签一样通过点击来唤起搜索,嵌套标签允许你选择搜索的层次。例如:
- 搜索
#主标签
,即可找到包含任意一个子标签的所有笔记- 返回的结果会是上述的三个例子
- 当你在一个主分类下设置了多个子分类,想找到这个主分类包含的所有内容时,该功能会很实用
能被使用的符号
综上所述,标签内能被使用的符号共有三种
_
下划线-
连字符/
斜杠
如何让 # 不被识别
可以使用前面提到的转义符号 \
反斜杠,与上述的 转义标题 类似
格式:
\#这里的内容不会被识别为标签
效果:
#这里的内容不会被识别为标签
19. 避免标识符的滥用
即使在 Markdown 中,也要尽量避免标识符的滥用
比如我的这篇教程,就存在一定程度的滥用
- 其实是因为我这篇是教学性质的,不太一样,有些不能避免
- (好吧,我就是在甩锅)
标识符的本质是突出显示,代表重点
- 一篇笔记里的某段文本,使用各式各样的的标识符,会造成重点不清晰
有三种标识,慎用!
- 词中对单个汉字的标识
- 卧==虎==藏==龙==
- 短语中对单个英语单词的标识
- get a ==bang== out of
- 标识符的多层嵌套
- 我感觉快要==原地
起飞
==了
- 我感觉快要==原地
原因:
- 词义的割裂
- 视觉的混乱
- 不利于搜索
卧==虎==藏==龙==
- 搜
卧虎
– 搜不到 - 搜
藏龙
– 搜不到
- 搜
20. Callouts
20.1 Callouts 语法
Callouts 以前是第三方插件 Admonitions 的功能,现在被内置到OB自身,在 Publish 中也可使用
- 最方便的使用方式,是安装第三方插件—— Admonitions
ctrl+p
命令 ,输入admontion
- 也可以直接 输入
callout
格式
1 | > [!类型] 标题 |
注:
- 不要忘记
>
]
与 标题 间有空格
示范
[!note] 这是一个callout标题
这里是callout里的内容
[[#20 Callout blocks|callout]]内部支持双链
- 同样支持==MD语法==
源码
1 | > [!note] 这是一个callout标题 |
20.2 折叠与展开
[!note]
默认是展开的,且不能折叠
如果想让 Callouts 有折叠的功能,可在 ]
后面加上 +
加号
- 注意,是没空格的
示范
1 | > [!note]+ 这是一个可折叠的标题 |
效果
[!note]+ 这是一个可折叠的标题
这里的内容可通过点击 Callouts标题 折叠起来
在后面加上 -
减号,默认处于折叠状态 [!note]-
示范
1 | > [!note]- 这是一个已被折叠的标题 (点击可展开) |
效果
[!note]- 这是一个已被折叠的标题 (点击可展开)
里面的内容默认看不到
20.3 Callouts 类别
默认共支持12种类别 (可自己在 Admonitions插件 里添加)
- note
- abstract, summary, tldr
- info, todo
- tip, hint, important
- success, check, done
- question, help, faq
- warning, caution, attention
- failure, fail, missing
- danger, error
- bug
- example
- quote, cite
举例
1 | > [!bug] 这是一个bug类别 |
[!bug] 这是一个bug类别
这里是内容
20.4 多层嵌套
Callouts 支持多层嵌套
示范
1 | > [!failure] 这是第一层 |
效果
[!failure] 这是第一层
这里是第一层的内容[!bug]+ 这是嵌套的第二层
这里是第二层的内容[!warning]- 这是嵌套的第三层,且默认为折叠状态
这里是第三层被折叠的内容
支持用CSS来自定义类型和图标,不过我个人没怎么用