发布内容需要的Markdown语法

Posted 2021-03-13 forcee

目录

• 发布内容需要的Markdown语法
  • 1.概述
    • 1.1设计理念
    • 1.2内联HTML语法
    • 1.3特殊字符自动转义
  • 2.行内语法讲解
    • 2.1注释的表述
    • 2.2分级标题
    • 2.3任务列表
    • 2.4缩进 换行 空行 对齐方式
    • 2.5斜体 粗体 删除线 下划线 背景高亮
    • 2.6超链接 页内链接 自动链接 注脚
    • 2.7列表
    • 2.8插入图像
    • 2.9多级引用

发布内容需要的Markdown语法

---

1.概述

1.1设计理念

• Markdown易于阅读，方便创作web文档，利于各平台无缝分发。
• Markdown语法灵感最大的来源还是纯文本email的格式，完全由标点符号标签组成的纯文本。
• Markdown文件应该以纯文本形式原样发布，不应该包含标记标签和格式化指令。

1.2内联html语法

• HTML是一种发布格式，Markdown是一种创作格式。
• Markdown语法集合比较小，只是HTML标签的一小部分。
• 对于Markdown中未包含的标签，可以直接使用HTML标签，例如用HTML<a>标签替代Markdown的链接语法。

1.3特殊字符自动转义

在HTML中，有两个字符需要特殊对待: <和& ，左尖括号用于起始标签。
如果你想将它们用作字面量，你必须将它们转义为字符实体，例如< 和& 。

---

2.行内语法讲解

2.1注释的表述

• 代码法
  用CSS样式将文本隐藏来表示注释

  <div style='display: none'>
  我是注释
  我是注释
  </div>

  大部分文本解析器会解析HTML语法，在编辑器的非源代码模式中这种注释会被隐藏起来。

• HTML注释
  既然支持HTML语法，那也支持HTML注释。
  
  

  这种注释方法会在Markdown编辑器中显示出来。

• hack方法

  hack方法就是利用Markdown的解析原理来实现注释的。

  一般有的Markdown解析器不支持上面的注释方法，这个时候就可以用hack方法。

  hack方法比上面这两种方法稳定得多。

  [//]: ctrl+单击执行命令     "双斜杠是很多种语言的注释形式，Markdown解析器解析后不会显示出来"
  [^_^]: 这个注释很萌哈哈哈
  [comment]: 注释

2.2分级标题

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

2.3任务列表

- [ ] 任务一  未做任务
- [x] 任务二  已做任务

• [ ] 任务一 未做任务
• [x] 任务二 已做任务

2.4缩进 换行 空行 对齐方式

• 首行缩进

  或   //全角
  或  //半角
  或¨ //半角之半角

• 换行
  由于markdown编辑器的不同，可能在一行字后面，直接换行回车，也能实现换行，但是在Visual Studio Code上，想要换行必须得在一行字后面空两个格子才行。

• 空行
  在编辑的时候有多少个空行(只要这一行只有回车或者space没有其他的字符就算空行)，在渲染后，只隔着一行。

• 对齐方式

  <center>行中心对齐</center>
  <p align="left">
      行左对齐
  </p>
  <p align="right">
      行右对齐
  </p>

2.5斜体 粗体 删除线 下划线 背景高亮

• 代码

  *斜体*  _斜体_
  **粗体**
  ***加粗斜体***
  ~~删除线~~

  斜体 斜体
  粗体
  加粗斜体
  删除线
  下划线

2.6超链接 页内链接 自动链接 注脚

• 行内式
  []里写链接文字，()里写链接地址，()中的""可以作为链接指定的title属性，title属性可加可不加。title属性的效果是鼠标悬停在链接上会出现指定的title文字，链接地址与title前有一个空格

[全球最大的同性交友网站](https://www.github.com/ "pornhub")

全球最大的同性交友网站

• 参考式
  参考式超链接一般用在学术论文上面，或者另一种情况，如果某一个链接在文章中多处被使用，那么使用引用的方式创建链接将非常好，它可以让你对链接进行统一的管理。

  [全球最大的同性交友网站][1]
  [你也是二次元][2]
  
  [1]:https://www.github.com/   "最爱你的是我"
  [2]:https://www.bilibili.com/
  

  全球最大的同性交友网站
  你也是二次元

• 注脚
  在需要添加注脚的文字后加上注脚名字[^注脚名字]，称为加注。然后在文本的任意位置(一般在最后)添加注脚，注脚前必须有对应的注脚名字。
  经测试注脚与注脚之间必须空一行，不然会失效。即使你没有把注脚写在文末，经Markdown转换后，也会自动归类到文章的最后。

  使用 Markdown[^1]可以效率的书写文档, 直接转换成 HTML[^2]。
  
  [^1]:Markdown是一种纯文本标记语言
  
  [^2]:HyperText Markup Language 超文本标记语言

  使用 Markdown¹可以效率的书写文档, 直接转换成 HTML²。

• 锚点(页内超链接)
  网页中，锚点其实就是页内超链接，也就是链接文本文档内部的某些元素，实现当前页面中的跳转。比如我这里写下一个锚点，点击回到目录，就能跳转到目录。 在目录中点击这一节，就能跳过来。还有下一节的注脚。这些根本上都是用锚点来实现的，只支持在标题后插入锚点，其它地方无效。

  这种写法是[描述]+(标题)的形式。标题中＃和标题内容之间的空格要去掉。

  [跳转到概述](##1.概述)

  跳转到概述

• 自动链接
  Markdown支持以比较简短的自动链接形式来处理网址和电子邮件信箱，只要是用<>包起来，Markdown就会自动把它转成链接。一般网址的链接文字就和链接地址一样。
  https://baidu.com
  [e-mail] 这是我的公司邮箱??

2.7列表

• 无序列表
  使用*, +, -表示无序列表，后要加一个空格

  * 无序列表1
  +无序列表2
  - 无序列表3

  • 无序列表1
  • 无序列表2
  • 无序列表3

• 有序列表

  1.有序列表1
  2.有序列表2
  3.有序列表3

  1.有序列表1
  2.有序列表2
  3.有序列表3

2.8插入图像

• 代码

  ![Alt text](/path/to/img.jpg)
  ![Alt text](/path/to/img.jpg "Optional title")

• 写法
  !+[描述](地址)
()内的地址可以是file协议的本地文件路径，假设Markdown文档存储在/tmp/document路径下，那么图片的路径写绝对路径(/tmp/document/1.jpg)和相对路径(1.jpg)都是支持的; 也可以是http协议的链接地址。

  

2.9多级引用

• 说明
  引用需要在被引用的文本前加上>符号和空格，允许多层嵌套，也允许只在整个段落的第一段前面加上>。

• 代码

  > 请问 Markdwon 怎么用？ - 小白
  > > 自己看教程！ - 愤青
  > > > 教程在哪？ - 小白

  请问 Markdwon 怎么用？ - 小白

  自己看教程！ - 愤青

  教程在哪？ - 小白

  > 我是多级引用
  我是多级引用
  我是多级引用

  我是多级引用
  我是多级引用
  我是多级引用

---

1. Markdown是一种纯文本标记语言?

2. HyperText Markup Language 超文本标记语言?