Markdown 五分钟速成

 

为了加强后续 Wiki 开发效率,请编写人员使用规定工具按照规范进行文档的编写。

标题

在标题内容前添加 # + 空格 就可以实现标题样式的添加:

  • 一级标题就添加一个 # + 空格,例如:# 我是一级标题
  • 二级标题就添加两个 # + 空格,例如:## 我是二级标题。
  • 三级标题就添加三个 # + 空格,例如:### 我是三级标题。

依次类推...

特殊文字处理

换行

书写示例:

我是第一行(后面有两个空格)  
我是第二行

效果:

我是第一行(后面有两个空格)
我是第二行

加粗

书写示例:

**我是粗体**

效果:
我是粗体

标亮

书写示例:

`请把我标亮`

效果:

请把我标亮

列表

一级列表(不带序号)

书写示例:

- 列表 1(减号 + 空格)
- 列表 2

效果:

  • 列表 1(减号 + 空格)
  • 列表 2

一级列表(带序号)

书写示例:

1. 列表 1(自然数 + 点 + 空格)
2. 列表 2

效果:

  1. 列表 1(自然数 + 点 + 空格)
  2. 列表 2

二级列表(不带序号)

书写示例:

- 列表 1(一级列表:减号 + 空格)
 - 列表 1.1(二级列表:空格 + 减号 + 空格)
 - 列表 1.2
- 列表 2

效果:

  • 列表 1(一级列表:减号 + 空格)
    • 列表 1.1(二级列表:空格 + 减号 + 空格)
    • 列表 1.2
  • 列表 2

添加图片

书写示例:

![图片描述性文字](图片相对地址)

效果:

我是示例图片的描述

添加超链接

书写示例:

[链接描述文字(可见)](链接地址)

效果:

点击跳转到极客学院

引用

书写示例:

>注意:  
我是引用的内容(空一行就结束引用)。

效果:

注意:
我是引用的内容(空一行就结束引用)。

添加代码

书写示例:

```
// 代码区域的上下分别用三个 ` 括起来
public class Person {
    // 代码缩进请使用 四个空格,不要使用 Tab
}
```

效果:

// 代码区域的上下分别用三个 ` 括起来
public class Person {
    // 代码缩进请使用 四个空格,不要使用 Tab
}

特别注意

  1. 英文字母与中文之间需要两边空格(英文与符号之间不空格)
  2. 高亮英文之间需要两边空格
  3. 代码符号```上面需要空一行,结束```下面需要空一行
  4. 中文之间和短英文之间使用中文标点
  5. 一篇文章中只能出现一个#号标题
  6. 标题#号之后需要空一格
 
原文地址:https://www.cnblogs.com/goodboy-heyang/p/4770759.html