markdown 使用手册

主要整理的是 github 上面的 markdown (GFM) 的写法，但标准都很相近。

• markdown 使用手册
  • 换行问题
  • 首行缩进
  • 超链接
  • 图片
  • vscode Markdown 快捷键

!   注意
在 github 的编辑器上编辑 md 文件，preview 预览视图很多功能无法实现，不太推荐，比如 跳转 #锚点等

换行问题

markdown 中的换行，除了部分标记符号，比如：#,>,*等按回车键都能自动换行的，但是普通文本，必须要借助在行尾：添加双空格或反斜杠

• 或者双回车键
• 但都不太推荐 懒懒散散的一行又一行 普通文本看起非常不规范，如果一小段普通文本想换行，推荐使用序号符 * 1. -
• html 标签附近 和代码块附近，一定要双回车，就是隔一行，不然紧接着的 markdown 标识符会无效

首行缩进

• 方法一
  • 或 //半角的空格
  • 或; //全角的空格 推荐
  • 或  //不断行的空格
• 方法二
  • 使用 html 的 p 标签包裹 markdown, 但 p 标签中无法再使用 markdown 了。

<p style="text-indent=2em">markdown</p>

• 整行缩进
  • 使用 tab 键 或者 ctrl + ]

但很多技术文档都没有缩进； 文字间输入空格键只会产生一个空格

超链接

• 锚点跳转

本质都是跳转到锚点位置，也就是#上，或者是 html 标签的 id 上。

1. [锚点名](#锚点)
2. 使用 a 标签

<a href="#锚点名">传送至锚点位置</a>

• url 跳转
  可以使用 线上地址，也可以使用文件的相对路径。
• (名字)[url]

图片

跟超链接跳转类似，只用最前面加个!即可

语法
![](url "alt")

一般为了 markdown 的迁移性，图片最后都使用在线地址，就是使用图床的地址。

小技巧
有一个小技巧就是把图片上传到 github 同项目上的某文件夹上，url 就可以写 github 的地址了，资源是会稳定保存，但是网速很慢。

---

vscode Markdown 快捷键

需安装 Markdown All in One

key	Command
Ctrl +B	toggle bold 切换粗体
Ctrl +I	toggle italic 切换斜体
Alt +S	切换删除线
Ctrl + Shift + [	Toggle heading    标题（上升）
Ctrl + Shift + ]	Toggle heading   标题（下降）
Alt + C	Check/Uncheck task list item   选表单切换
Ctrl + ]  /  TAB	缩进 光标停靠位置处，操作两次，生成单行代码
Ctrl +Shift +F	表格格式化

• Other
  • 剪贴板中带有 url 路径，选中某文字，Ctrl +V ，可以自动生成该文字命名的超链接。
  • 还可以自动生成目录 > F1 > markdown all in one : 创建目录 。
  • 可直接在 文档开头 输入 [TOC] 生成目录 (可惜 github 上无法显示,移植性很差，不推荐)