Markdown 详解

如果本文章对你有用,可搜索关注本人的微信公众号:爬界,上面会及时推送最近的博客文章,大家一起进步哦 !

如果想要更好的阅读体验,可以进入 爬界博客网站 阅读最新内容,网站地址:https://blog.climbtw.com。

本文主要涉及了 VSCode 的下载,安装,配置,常用插件,配置同步 等内容。


目录

  • 1 参考资料
  • 2 简介
  • 3 基本语法
    • 3.1 标题
    • 3.2 段落
    • 3.3 换行符
    • 3.4 强调
    • 3.5 水平线
    • 3.6 列表
    • 3.7 块引用
    • 3.8 代码块
    • 3.9 链接
    • 3.10 图片
    • 3.11 图片 + 链接
  • 4 扩展语法
    • 4.1 表格
    • 4.2 代码块 的围栏形式
    • 4.3 脚注
    • 4.4 删除线
    • 4.5 复选框列表

1 参考资料

  • John Gruber 创建的原始指南:https://daringfireball.net/projects/markdown/ (英文)
  • Markdown 中文网:http://markdown.p2hp.com/

2 简介

  • 开发者:John Gruber(约翰·格鲁伯,1973)
    John Gruber(2009 拍摄,当时 36 岁)
  • Markdown:一种轻量级的标记语言,可用于将格式设置元素添加到纯文本文档中去。
    它由 John Gruber 于 2004 年创建。
  • 工具:可以使用 Visual Studio Code 的 Markdown Preview Enhanced 插件,拥有飘逸的 Markdown 写作体验。
    详情见《Visual Studio Code 详解》。

3 基本语法

3.1 标题

  • 说明:在文本前添加 1到6个 #,对应一到六级标题。

3.2 段落

  • 说明:使用 空白行 分隔一行或多行文本。

3.3 换行符

  • 说明:以 2个或多个空格 结束一行,然后键入 Enter,则输出换行符。
    • 若直接键入 Enter,则会按其原本的效果进行显示,会被解析为 空格,不会进行换行。
    • 当然,有的解析器 直接键入 Enter,也会换行。

3.4 强调

  • 说明:
    • 在 文本前后 添加 1个 *,表示 斜体
    • 在 文本前后 添加 2个 *,表示 粗体
    • 在 文本前后 添加 3个 *,表示 粗斜体

3.5 水平线

  • 说明:
    • 单独在一行上使用 3个 *,表示水平线。

3.6 列表

  • 说明:
    • 在 项目 前添加 数字,英文句点 和 空格,表示 有序列表
      • 数字不必按 数字顺序 排列,但列表应以 数字 开头。
    • 在 项目 前添加 破折号 - 和 空格,表示 无序列表
    • 缩进项目 2个或多个空格,可创建 嵌套列表
      • 如果嵌套 其他元素,需要缩进 4(2+2) 个或多个空格。
      • 嵌套 代码块的常规形式 时,前后需要空一行,再缩进 6(4+2) 个空格。

3.7 块引用

  • 说明:
    • 在段落前面添加一个 >。
      • 块引用中包含 段落 时,在 空白行 上添加一个 >。
    • 需要 嵌套块引用 时,在段落前面添加一个 >>。
    • 块引用可以包含其他 Markdown格式 的元素。

3.8 代码块

  • 说明:
    • 单行代码 用单刻度线 ` ` 括起来。
      • 单行代码中如果存在 ` 需要表示,则外部可用 双刻度线 `` `` 括起来。
      • 或者使用转义符号 \,进行转义 \`。
    • 代码块常规形式 需要 在每一行缩进 4个空格 来表示。

3.9 链接

  • 说明:
    • 不带文字标题的链接,直接用 尖括号 包含起来:
    • 标题 + 链接 和 停留文字 一体[Markdown 中文网](http://markdown.p2hp.com/ 'Markdown 中文网')
    • 标题 + 链接 和 停留文字 分开
      • [Markdown 中文网][]
      • [Markdown 中文网]: http://markdown.p2hp.com/ 'Markdown 中文网'

3.10 图片

  • 说明:
    • 无图说明 + 链接 和 停留文字 一体
      • [图片上传失败...(image-dba890-1631769031884)]
    • 无图说明 + 链接 和 停留文字 分开
      • ![图片丢失][薛之谦-《耗尽》 歌曲海报]
      • [薛之谦-《耗尽》 歌曲海报]: https://www.baidu.com '薛之谦-《耗尽》 歌曲海报'

3.11 图片 + 链接

  • 说明:
    • 就是把 图片 当作 链接的文字标题,以链接的形式来表达。至于 图片 和 链接 用什么形式,可以自由组合。
    • 如:全用分开的形式:
      • [![图片丢失][图片地址]][链接地址]
      • [图片地址]: https://www.baidu.com '薛之谦-《耗尽》 歌曲海报'
      • [链接地址]: https://www.baidu.com

4 扩展语法

4.1 表格

  • 说明:
    • 使用形式:

      项目|价格|数量
      -|-:|:-:
      iPhone|6000元|5
      iPad|3000元|3
      iMac|10000元|2
      
      项目 价格 数量
      iPhone 6000元 5
      iPad 3000元 3
      iMac 10000元 2

4.2 代码块 的围栏形式

  • 说明:
    • 在代码块的前后 使用 3个刻度线 ```,不必再进行任何缩进。
    • 在第一个 ``` 后紧跟 json 等文字,可以进行对应的 语法高亮。

4.3 脚注

  • 说明:
    • 在方括号 [] 内添加 插入符 ^ 和 标识符。
    • 举例:这是一个简单的 脚注[1]

4.4 删除线

  • 说明:
    • 在 文本前后 添加 2个 ~,表示 删除体

4.5 复选框列表

  • 说明:
    • 在 无序列表 的破折号 - 后面,加上一个 方括号 [],表示 复选框列表。
      • 方括号 [] 里面加上 x,则表示 选中状态。
- [x] Write the press release
- [ ] Update the website
- [ ] Contact the media
  • Write the press release
  • Update the website
  • Contact the media

  1. 脚注:脚注说明。 ↩

你可能感兴趣的:(Markdown 详解)