跳至主要內容

Markdown的使用

大约 2 分钟

Markdown的使用

基本使用

预览

  • 在vscode下使用 ctrl+k+v
  • 在预览页右键选择导出与格式

标题

  • 在标题前使用#(要有空格)
  • 在标题下一行使用=

格式

  • 一个空行表示一个段落,或在段落结尾加两个空格
  • 斜体字 将使用斜体的文字用*或_包括 如 斜体
  • 粗体字 使用两个*或_ 如 粗体
  • 粗斜体字 使用三个*或_ 如 粗斜体
  • 分割线 在一行中使用三个以上星号*、减号-、底线_,不能有其他内容
  • 删除线 使用两个~包括文字 如 删除线
  • 下划线 使用html符号实现 如下划线
  • 方框 使用两个 ` 包括文集 如 方框, 当需要输入含 ` 的内容时, 需要两个 `, 并以空格分隔内容
  • 脚注 使用[^脚注名],并在末尾加上解释写法同,但要有冒号空格并加上内容 如^脚注

列表

  • 无序列表使用-或*或+
  • 有序列表使用数字加.
  • 列表嵌套只需在子列表中的选项前面添加四个空格即可
  • 任务列表- [x] 与- [ ],如

区块(引用)

  • 使用>表示列表
  • 区块可以嵌套,多个>之间加空格
  • 在列表中使用时需要在前面添加四个空格

代码

  • 使用`将代码包裹
  • 使用三个`将代码包裹并在第一个前加上语言实现高亮,如
  • 添加 {.line-numbers} 使代码显示行数 (默认存在)
  • 添加 {highlight=n-m} 属性的方式来高亮代码行数(与行数显示冲突)
    for(int i = 1; i<10; i++)
    {
        i--;
    }

引用

转义符号

  • 使用\转义,下面为可用的转义符号
\   反斜线
`   反引号
*   星号
_   下划线
{}  花括号
[]  方括号
()  小括号
#   井字号
+   加号
-   减号
.   英文句点
!   感叹号

其他格式

  • 上标 将上标内容使用^包括 如 20th
  • 下标 将下标内容使用~包括 如 H2O
  • 标记 将标记内容使用两个=包括 如marked

基本表格

  1. 行首 | 第一列 | 第二列 | ... |
  2. 分割(位于行首下, 每有一列就要一个) |--|--| ... |
  3. 横向扩展 空行, 或左侧 >
  4. 纵向扩展 底下一行 ^, 使用 <br> 换行

eg.

第一行第二行第三行
ABC
horizon
next
congratulations
^>abandoned

插入键盘图标

使用 <kbd></kbd> 包裹按键名称 eg. Ctrl + Alt + V

其他说明

https://shd101wyy.github.io/markdown-preview-enhanced/#/zh-cn/open in new window