Abstract: Markdown 基础语法 + Obsidian 速查手册。

本文记录了一些Markdown的基础语法,以及在Obsidian中的特殊语法,可作了解或速查手册用。

一、Markdown 基础语法

1. 标题

1
2
3
4
5
6
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
级别 写法 用途
H1 # 标题 全文大标题(一篇一个就够)
H2 ## 章节 主要章节
H3-H6 ### 小节 嵌套子章节

Tip: 如果想让特殊字符原样显示,可用代码块包起来,或者在前面加 \ 转义。

2. 强调

1
2
3
4
5
*斜体* 或 _斜体_
**粗体** 或 __粗体__
***粗斜体***
==高亮==
~~删除线~~
样式 写法 效果
斜体 *文字* 或 _文字_ 文字
粗体 **文字** 或 __文字__ 文字
粗斜体 ***文字*** 文字
高亮 ==文字== ==文字==(Obsidian 语法)
删除线 ~~文字~~ 文字

3. 列表

有序列表

1
2
3
1. 第一项
2. 第二项
3. 第三项

无序列表

1
2
3
4
5
- 项目 1
- 项目 2
- 子项目(缩进 2 个空格或 tab)
- 子项目
- 项目 3

4. 链接

1
2
[链接文字](URL)
![图片描述](图片 URL)
类型 写法 示例
外部链接 [文字](url) [GitHub](https://github.com)
图片 ![描述](url) ![Logo](logo.png)

5. 代码

行内代码

1
用 `print()` 函数输出文字。

代码块

1
2
3
4
```python
def hello():
print("Hello, World!")
```

Tip1: 开头三个反引号后面写对应语言名,即可实现语法高亮。

Tip2: 使用更多的反引号,逻辑上代码块的优先级则更高。

6. 引用

1
2
3
> 这是一段引用。
>
>> 这是嵌套引用。

效果:

这是一段引用。

这是嵌套引用。

7. 分割线

1
2
3
4
5
---

***

___

三种写法效果一样,都是一条横线:
效果:


8. 任务列表

1
2
3
4
5
- [ ] 未完成的任务
- [x] 已完成的任务
- [ ] 带子任务的任务
- [ ] 子任务 1
- [x] 子任务 2

效果:

  • [ ] 未完成的任务
  • [x] 已完成的任务

二、Obsidian 特殊语法

1. 内部链接(Wikilinks)

Obsidian 用 [[wikilinks]] 在笔记之间互相链接:

链接类型 写法 说明
基本链接 [[笔记标题]] 链到另一篇笔记
别名显示 [[笔记标题|显示文字]] 自定义显示的文字
章节链接 [[笔记标题#章节]] 链到某篇笔记的某个标题
块链接 [[笔记标题#^block-id]] 链到某个具体段落
嵌入笔记 ![[笔记标题]] 把整篇笔记嵌进来
嵌入章节 ![[笔记标题#章节]] 只嵌入某个章节

Obsidian的“双链”功能是该软件的一大特色,可以在笔记之间构建“入链”以及“出链”,以实现笔记之间的相互引用。

2. Callout 高亮块

Obsidian 支持带样式的 Callout 块,用来突出重要信息:

1
2
> [!NOTE] 标题
> 这里写内容。

Callout 行为控制

修饰符 写法 行为
可展开(默认展开) > [!NOTE]+ 默认展开状态
可折叠(默认收起) > [!NOTE]- 默认收起状态
默认 > [!NOTE] 不可折叠

可用的 Callout 类型

Callout 类型一览

信息类:

  • note - 一般信息
  • abstract、summary、tldr - 摘要
  • info、todo - 信息和待办

成功 & 提示:

  • tip、hint、important - 有用的建议
  • success、check、done - 成功状态

疑问 & 警告:

  • question、help、faq - 问题
  • warning、caution、attention - 警告

错误 & 问题:

  • failure、fail、missing - 失败
  • danger、error - 严重错误
  • bug - Bug 报告

其他:

  • example - 示例
  • quote、cite - 引用