本文主要介绍典型的Markdown用法,力求简明易查。本博客支持本文提及的全部用法
。
一、基本语法
1. 规则
- 演示中加粗部分为常用用法
- 标题:行首使用
#开头表示标题,#数量代表标题级别,最高六级标题,如:### 三级标题 - 段落:多行文本通过空白行创建段落
- 换行:行末通过多个空格换行,不要使用空格或制表符缩进段落
- 无序列表:行首允许使用
-、+、*,符号可以混用 - 有序列表:数字不必按数学顺序排列,但应当以数字
1.起始 - 嵌套列表:一般通过缩进或4个空格创建
- 图片引用:路径建议使用
Liquid语法表示,如1:{{ '/_assets/test/chan.png' | relative_url }}
2. 演示
| 说明 | Markdown语法 | 预览效果 |
|---|---|---|
| 一级标题 | # 一级标题 |
一级标题 |
| 二级标题 | ## 二级标题 |
二级标题 |
| … | … | … |
| 六级标题 | ###### 六级标题 |
六级标题 |
| 段落(空行分隔) |
段落一 段落二
|
段落一 段落二 |
| 换行(行末多个空格分隔) |
第一行 我换行了
|
第一行 我换行了 |
| 斜体 | *斜体* |
斜体 |
| 粗体 | **粗体** |
粗体 |
| 斜粗体 | ***斜粗体*** |
斜粗体 |
| 删除线 | ~~删除线~~ |
|
| 行内代码块 | `CODE IN LINE` |
CODE IN LINE |
| 水平线 |
--- 或 ***
|
|
| 无序列表 |
- 无序项目+ 无序项目* 无序项目
|
|
| 有序列表 |
1. 有序项目2. 有序项目
|
|
| 嵌套列表 |
1. 有序项目- 无序项目- 无序项目3. 有序项目
|
|
| 任务列表 |
- [ ] 待办任务- [x] 已办任务
|
|
| 引用 |
> 引用信息A> 引用信息B
|
引用信息A |
| 嵌套引用 |
> 引用信息A>> 引用信息B>> 引用信息C
|
引用信息A引用信息B引用信息C |
| 本文链接 | [跳转至基本语法](#基本语法) |
跳转至基本语法 |
| 网页链接 | <https://cn.bing.com> |
https://cn.bing.com |
| 邮箱链接 | <gnzhoutian@qq.com> |
gnzhoutian@qq.com |
| 超链接(含名称) | [必应](https://cn.bing.com) |
必应 |
| 超链接(含标题) | [必应](https://cn.bing.com "必应搜索") |
必应 |
| 引用链接 |
[必应][2][2]: https://cn.bing.com "必应搜索"
|
必应 |
| 引用图片 |  |
![]() |
| 脚注 |
脚注[^1x][^1x]: 脚注1
|
脚注2 |
| 名词解释 |
HTML 文档*[HTML]: Hyper Text Markup Language
|
HTML 文档 |
| Emoji - 简码表 |
:smile: :+1:
|
|
| MathJax |
$ z = x + y $$$ a^2 + b^2 = c^2 $$
|
$ z = x + y $ \(a^2 + b^2 = c^2\) |
二、表格
- 使用三个或以上连字符
---创建每列标题,并使用管道|分隔每列 - 使用
:---、:---:、---:表示单元格对齐方式 -
Markdown语法
| 默认对齐 | 左对齐 | 居中对齐 | 右对齐 | | -------- | :----- | :------: | ----: | | 数据1111 | 数据22 | 数据3333 | 数据4 | -
预览效果
默认对齐 左对齐 居中对齐 右对齐 数据1111 数据22 数据3333 数据4
三、代码块
1. 普通代码块
-
Markdown语法
``` { "Name": "John", "age": 25 } ``` -
预览效果
{ "Name": "John", "age": 25 }
2. 语法高亮代码块
-
Markdown语法
```json { "Name": "John", "age": 25 } ``` -
预览效果
{ "Name": "John", "age": 25 }
四、HTML相关语法
| 说明 | HTML语法 | 预览效果 |
|---|---|---|
| 换行 | 文本行一<br>文本行二 |
文本行一 文本行二 |
| 空格符 | 空格符 空格符 |
空格符 空格符 |
| 制表符 | 制表符 制表符 |
制表符 制表符 |
| 下划线 | <u>下划线</u> |
下划线 |
| 上标 | 文字<sup>上标</sup> |
文字上标 |
| 下标 | 文字<sub>下标</sub> |
文字下标 |
| 文本折叠 | <details><summary>点击展开</summary>折叠内容</details> |
点击展开折叠内容 |
| 图片缩放 | <img src="/_assets/test/chan.png" width="30%" /> |
![]() |
五、kramdown扩展语法
| 说明 | kramdown语法 | 预览效果 |
|---|---|---|
| 注释-页面不显示 | {::comment}这是注释,你看不见{:/comment} |
|
| 原生-停用kramdown渲染 | {::nomarkdown}这是HTML原生水平线<hr>{:/nomarkdown} |
这是HTML原生水平线 |
六、Markdown编辑器
1. VSCode编辑器
- 建议使用
VSCode+Markdown Preview Enhanced插件编辑和实时预览
2. Typora编辑器
-
Typora仍然是目前(2024-09-10)比较好用Markdown编辑器, 正式版需要付费,有条件请支持。 -
Beta版本仍然免费,最新版本为v0.11.18,官方链接,点击下载 -
Beta版本提示到期问题解决办法如下:1. 打开注册表regedit -> 计算机\HKEY_CURRENT_USER\Software\Typora 2. 右键Typora -> 选择权限 -> 各个权限组权限改为拒绝 3. 关闭注册表 -> 重新打开typora即可 -
Typora常用快捷键如下:ctrl + / #源码模式 ctrl + 0 #段落 ctrl + 1,2,3,4,5,6 #标题级别 ctrl + -,= #升降标题级别 ctrl + [,] #增减缩进 ctrl + shift + [,] #有序无序列表 ctrl + b,i,u #加粗斜体下划线
参考链接
- 官网 - Markdown官方教程
- 官网 - GitHub Flavored Markdown帮助文档
- 官网 - GitHub Docs Markdown帮助文档
- 菜鸟 - Markdown在线编辑器
- 官网 - Markdown编辑器移动端预览
- 官网 - Flowchart图表
- 官网 - Mermaid图表
- 博客 - Flowchart用法
- 博客 - Mermaid用法
- 博客 - MathJax与Markdown的究极融合
- GitHub - Emoji表情符号备忘单
- GitHub - Emoji表情符号简码表
