> 文档中心 > Markdown基础操作指南

Markdown基础操作指南


Markdown基础语法指南

前言:Markdown 语言使用相当广泛且语法简答易学,掌握它成为了程序员写作必备的技能,能让人优雅地沉浸式记录,专注内容而不是纠结排版,达到「心中无尘,码字入神」的境界。

介绍:Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。
Markdown 语言在 2004 由约翰·格鲁伯(英语:John Gruber)创建。
Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。
Markdown 编写的文档后缀为 .md, .markdown。

Markdown 应用

Markdown 能被使用来撰写电子书,如:Gitbook。

当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。例如:GitHub、简书、reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge等。

Markdown语法

  1. 标题语法

    通过 '#‘的多少来区分几级标题,文字与’#'间加空格

    语法:# 一级标题

    效果

    一级标题

    语法:## 二级标题

    效果:

    二级标题

    语法: 三级标题

    效果:

    三级标题


  1. 段落语法

    通过空行将段落分割,段落开头不要有空格/

    语法:

    这是一段文本这是第二段

    效果:

    这是一段文本

    这是第二段


  1. 换行语法

    在一行的末尾添加两个或多个空格,然后按回车键,即可创建一个换行(
    )。

    几乎每个 Markdown 应用程序都支持两个或多个空格进行换行,称为 结尾空格(trailing whitespace) 的方式,但这是有争议的,因为很难在编辑器中直接看到空格,并且很多人在每个句子后面都会有意或无意地添加两个空格。由于这个原因,你可能要使用除结尾空格以外的其它方式来换行。幸运的是,几乎每个 Markdown 应用程序都支持另一种换行方式:HTML 的 br 标签。

    为了兼容性,请在行尾添加“结尾空格”或 HTML 的 br 标签来实现换行

    语法:

        第一行
    第二行

    效果:

    第一行
    第二行


  2. 强调语法

    在强调部分前后加两个’’/’_‘无空格 效果加粗,在强调部分前后加一个’’/’_'无空格 效果斜体。

    语法:

    加粗效果1__加粗效果2__

    效果:

    加粗效果1

    加粗效果2

    语法:

    *斜体效果1*_斜体效果2_

    效果:

    斜体效果1

    斜体效果2


  3. 引用语法

    通过在段落前加 ‘>’ 来实现,同时块引用可以包含其他 Markdown 格式的元素。并非所有元素都可以使用,你需要进行实验以查看哪些元素有效。

    语法:>块引用在此

    效果:

    块引用在此

    嵌套语法示例:

        >* 嵌套引用1    >* 嵌套引用2

    效果:

    • 嵌套引用1
    • 嵌套引用2

  1. 列表语法

    有序列表是’数字+.+空格 文字’

    无序列表是”字符’*’/’+’/’-’+空格 文字“

    语法:

    1. 有序列表12. 有序列表2* 无序列表1+ 无序列表2

    效果:

    1. 有序列表1
    2. 有序列表2
    • 无序列表1
    • 无序列表2

代码块通常采用四个空格或一个制表符缩进。当它们被放在列表中时,请将它们缩进八个空格或两个制表符。


  1. 代码语法

    在英文输入模式下

    • 单行代码:通过一对反引号 ` 包围
    • 多行代码: 通过一对三反引号 ```包围

    语法:

     `单行code` 反引号x3     多行code1     多行code2 反引号x3

    效果:

    单行code

  多行code1  多行code2

  1. 分割线语法

    要创建分隔线,请在单独一行上使用三个或多个星号 (*)、破折号 (—) 或下划线 (___) ,并且不能包含其他内容

    语法:

    *
    ---
    ___

    效果:




    以上三横线为分割线效果


  1. 链接语法

    Markdown: [超链接显示名](超链接地址 超链接悬停显示文本)

    HTML: ‘超链接显示名’

    语法:
    [这是小东仔的个人博客](dongzai666.github.io 个人博客)

    效果:

    这是小东仔的个人博客

    对于网址和email地址用包围起来可以变成可点击的链接

    语法:

    效果:https://dongzai666.github.io

  • 引用类型链接语法: 引用样式链接是一种特殊的链接,它使URL在Markdown中更易于显示和阅读。参考样式链接分为两部分:与文本保持内联的部分以及存储在文件中其他位置的部分,以使文本易于阅读

    语法:

    • 文中显示部分:[超链接显示文本][对应数字序号]
    • 可放在文中任何位置(一般在末尾做注脚)的链接存贮部分: [对应数序号]: 链接

    效果:

    [小东仔的个人博客][1]

    [1]: https://dongzai666.github.io

    个人感觉没啥卵用,哈哈哈哈


  1. 图片链接

    图片链接语法只需在超链接语法前加 感叹号’!’

    语法: ![图片名称](图片加载链接 图片悬停名称)

    效果:

    小东仔的头像

给图片添加链接:将图片的markdown括在括号中,在后面添加圆括号包含的链接

语法:
[![图片名称](图片加载链接 图片悬停名称)](图片超链接)


  1. 转义字符语法

要显示原本用于格式化 Markdown 文档的字符,请在字符前面添加反斜杠字符 \

Markdown扩展语法指南

  1. 删除线语法

    用’~~'包围起来,呈删除线效果

    语法:~~这是一段删除线效果文字~~

    效果:这是一段删除线效果文字

  2. 表格语法

    使用 ‘|’ 分隔每列,使用’—'控制每列的宽度,可以通过在标题行中的连字符的左侧,右侧或两侧添加冒号(:),将列中的文本对齐到左侧,右侧或中心。

    • ‘:—’ 左对齐
    • ‘—:’ 右对齐
    • ‘:—:’ 居中对齐

    语法:

    | id | name | address |
    |:--- | :----: | ---:|
    | 11 | apd | liaoning |

    效果:

    id name address
    11 apd liaoning
    :— :—: —:
  3. 任务列表语法

    任务列表使您可以创建带有复选框的项目列表。在支持任务列表的Markdown应用程序中,复选框将显示在内容旁边。要创建任务列表,请在任务列表项之前添加破折号-和方括号[ ],并在[ ]前面加上空格。要选择一个复选框,请在方括号[x]之间添加 x 。

    语法:-[x] list1

    效果:vscode暂时不支持该功能

友链:个人博客