Markdown 语法手册
Cmd Markdown在线编辑器
Arya - 在线 Markdown 编辑器
微信公众号markdown排版工具
什么是 Markdown?
- Markdown 是一款轻量级标记语言,不同于 HTML,Markdown 的语法非常简单,且容易上手
- Markdown 以 纯文本格式 编写文档,依赖键盘而非鼠标,专注于写作本身,感受书写的魅力
- Markdown 的通过添加一些简单的 标识符,让文本具有恰到好处的格式
- Markdown 核心特征就是 删繁剪芜, 简扼 + 精炼
- Markdown 是 笔记 与 网页文章 的最佳载体
- Down 的核心:坐 下 来,就能把思维写 下 来
Markdown 的效果用 Word 也完全可以复现,甚至功能更多,为何要用 Markdown 呢?
功能多,不一定是好事,功能一多,选择就会变多,然后你会开始纠结……
这个字号是不是该大一点呢?
这个颜色好像有点不太搭呢?
这个粗体,是不是该再加点颜色呢?
这个图片的位置看起来有点不大对劲呢?
结果,写了半天,就憋出一点点东西,写出来的内容…好像…也不咋滴
MD 的优势:
- 免于 被繁杂臃肿的功能晃花了眼 的困扰
- 回归内容本身,拥抱笔记的内核,而非浮于表象的样式,写出高效精练的笔记!
用 Markdown 写东西,记住一个原则:
能 10 个字搞定,绝不 11 个字
标题&字体
不同数量的 # 可以完成不同的标题,和 HTML 一样共有六级,如下:
# 这是一级标题
## 这是二级标题
### 这是三级标题
#### 这是四级标题
##### 这是五级标题
###### 这是六级标题
粗体、斜体、粗体和斜体,删除线,需要在文字前后加不同的标记符号。如下:
这个是粗体:左右各两个星号 **
这个是斜体:左右各一个星号 *
这个是粗体加斜体:左右各三个星号 *
删除线:左右各两个波浪号 ~
下划线:与 HTML 一样,使用 <u></u> 标签
注:如果想给字体换颜色或居中显示,需要使用内嵌 HTML 来实现。
分割线:英文状态下三个 ---
列表&引用
无序列表的使用,在符号 - 后加空格使用。如下:
- 无序列表 1
- 无序列表 2
- 无序列表 3
如果要控制列表的层级,则需要在符号 - 前使用空格。如下:
- 无序列表 1
- 无序列表 2
- 无序列表 2.1
- 无序列表 2.2
有序列表的使用,在数字及符号 . 后加空格后输入内容,如下:
- 有序列表 1
- 有序列表 2
- 有序列表 3
引用
引用的格式在符号 > 后面书写文字。如下:
读一本好书,就是在和高尚的人谈话。 ——歌德
脚注:在需要脚注的地方,输入 [^脚注代号],推荐使用数字序号1。在其他区域,输入:
[^脚注代号]:脚注内容
网页
外链的格式:[显示文本内容](链接地址 "提示信息文本")。微信公众号仅支持公众号文章链接,即域名为 https://mp.weixin.qq.com/ 的合法链接。
图片
图片格式:
支持 jpg、png、gif、svg 等图片格式,svg 文件示例如下:
绘制函数图像
首先用 Mathematica 绘图并导出 SVG
Plot[Sin[x], {x, -4, 4}, PlotPoints -> 2]
Export["sin.svg", %]
接下来使用 svgo 做一下压缩:
svgo --pretty sin.svg
得到的代码直接复制进来就好啦~
绘制表格
Obsidian 中可直接使用鼠标右键插入
| 左栏 | 中间栏 | 右栏 |
| -------- | -------- | ----- |
| 单元格 1 | 居中 | $1600 |
| 单元格 2 | 单元格 3 | $12 |
| 左栏 | 中间栏 | 右栏 |
|---|---|---|
| 单元格 1 | 居中 | $1600 |
| 单元格 2 | 单元格 3 | $12 |
可以使用冒号来定义表格的对齐方式,如下:
| 姓名 | 年龄 | 工作 |
|---|---|---|
| 小可爱 | 18 | 吃可爱多 |
| 小小勇敢 | 20 | 爬棵勇敢树 |
| 小小小机智 | 22 | 看一本机智书 |
可以 Shift + Enter 对一段长文本进行换行
代码块
如果在一个行内需要引用代码,只要用反引号引起来就好,如下:
Use the printf() function.
在需要高亮的代码块的前一行及后一行使用三个反引号,同时第一行反引号后面表示代码块所使用的语言,如下:
// FileName: HelloWorld.java
public class HelloWorld {
// Java 入口程序,程序从此入口
public static void main(String[] args) {
System.out.println("Hello,World!"); // 向控制台打印一条语句
}
}
diff 不能同时和其他语言的高亮同时显示,且需要调整代码主题为微信代码主题以外的代码主题才能看到 diff 效果,使用效果如下:
+ 新增项
- 删除项
拓展文本格式
- Markdown 想实现更多文本显示效果,只能依赖 HTML 标记和部分编辑器提供的额外标识符,属于拓展语法,旨在为 Markdown 使用者 提供更多样式选择。
- 个人不是很推荐在 MD 中使用 HTML,不过一些简单的标记还是可以 轻度使用 的。
键盘文本的格式:<kbd>Ctrl</kbd> + <kbd>X</kbd>,Ctrl + X,键盘文本和行内代码一样可以作为突出显示着重文本的方式
放大文本的格式:<big>这是一段放大文本</big>,这是一段放大文本
缩小文本的格式:<small>这是一段缩小文本</small>,这是一段缩小文本
高亮文本的格式:这里是一段高亮文本
多彩文本的格式:<font color=orange>这是一段橘色文本</font>,这是一段橘色文本;<mark style="background: transparent; color: yellow">黄色字体</mark>,黄色字体
color 里的颜色支持英文单词,16 进制,rgb,rgba
上标的格式:<sup>这里是上标内容</sup>,X2
下标的格式:<sub>这里是下标内容</sub>,H2O
任务标注
- 早上七点起床
- 午睡
- 喝水
- 背单词
- 写作业
进度条
汉字注音
<ruby>这<rp>(</rp><rt>zhe</rt><rp>)</rp>是<rp>(</rp><rt>shi</rt><rp>)</rp>一<rp>(</rp><rt>yi</rt><rp>)</rp>段<rp>(</rp><rt>duan</rt><rp>)</rp> 拼<rp>(</rp><rt>pin</rt><rp>)</rp> 音<rp>(</rp><rt>yin</rt><rp>)</rp> 注<rp>(</rp><rt>zhu</rt><rp>)</rp> 解<rp>(</rp><rt>jie</rt><rp>)</rp> 小<rp>(</rp><rt>xiao</rt><rp>)</rp> 程<rp>(</rp><rt>cheng</rt><rp>)</rp> 序<rp>(</rp><rt>xu</rt><rp>)</rp> </ruby>
这是一段 拼 音 注 解 小 程 序
简单批注
这是<u title="奇妙冒险">JoJo</u>喜欢的Obsidian
这是JoJo喜欢的 Obsidian
图片链接按钮
[<img style="float:left" src="https://user-images.githubusercontent.com/14358394/115450238-f39e8100-a21b-11eb-89d0-fa4b82cdbce8.png" width="200">](https://buymeacoffee.com/)
Latex 数学公式
公式块的格式:$公式$
行内公式使用方法,比如这个化学公式:$\ce{Hg^2+ ->[I-] HgI 2 ->[I-] [Hg^{II}I 4]^2-}$
块公式使用方法如下:
矩阵:
$$\begin{pmatrix}
1 & a_1 & a_1^2 & \cdots & a_1^n \\
1 & a_2 & a_2^2 & \cdots & a_2^n \\
\vdots & \vdots & \vdots & \ddots & \vdots \\
1 & a_m & a_m^2 & \cdots & a_m^n \\
\end{pmatrix}$$
Mermaid 绘图
Callout 标注
>[!info] 自定义标题
包裹的内容
可以是多行的内容
在标题部分可以使用 - 和 + 符号,让 callout 面板折叠或者展开
>[!info]+ 自定义标题
包裹的内容
可以是多行的内容
包裹的内容
可以是折叠的多行的内容
参考自:
Markdown语法参考 | Obsidian
Markdown语法
MarkDown语法超详细教程
中文技术文档写作风格指南
-
脚注内容 ↩
