❮
❯
TOC
CHAT
分类 标记语言与样式　2942字　10分钟📤 🖨 📝

Markdown使用教程

作者

Markdown是一种轻量级标记语言，允许用户使用易读易写的纯文本格式编写文档。当前许多网站都广泛使用Markdown撰写文档或论坛交流，例如GitHub、CSDN，以及本站（Hyperplasma）。

Typora（官网：typora.io）是一款轻量级Markdown编辑器，采用所见即所得的编辑方式，实现了即时预览的功能，推荐使用。

本站二次开发的WP GitHuber MD博文撰写插件提供了远胜常规Markdown编辑器的语法功能，支持所有的HTML标签和CSS样式，并且允许插入简单、安全的JavaScript脚本。

1 标题

分别对应<h1>~<h6>标签

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

Typora中使用[TOC]在任意位置根据标题标签生成目录（CSDN中为@[TOC]），实为在各标签处设置锚点。本站暂不支持该语法，当标题标签数≥2时会在第一个标题之前、右侧边栏以及右下角便携目录处自动生成目录。

2 文本

2.1 段落

Markdown段落没有特殊的格式，直接编写文字。

注意事项：

  • 使用Tab实现缩进（不建议使用）。
  • 1次回车只能实现当前段落内换行（实际仍处于同一<p>标签），使用≥2次回车实现另起一<p>。

2.2 斜体、粗体

*斜体文本*  或   _斜体文本_
**粗体文本**    或   __粗体文本__
***粗斜体文本*** 或   ___粗斜体文本___

斜体文本

斜体文本

粗体文本

粗体文本

粗斜体文本

粗斜体文本

2.3 删除线

若段落中的文字要添加删除线，只需在文字的两端添加两个波浪线~~即可，实例如下：

~~hyperplasma.top~~

hyperplasma.top

2.4 下划线

可通过HTML的<u>标签来实现下划线：

<u>带下划线的文本</u>

带下划线的文本

2.5 分隔线

在一行中用三个以上的星号、减号、下划线来建立分隔线（可以在星号或减号中间插入空格）：

***

*****

- - -

----------

3 列表

3.1 无序列表

使用星号*、加号+或减号-作为列表标记：

* 第一项
* 第二项

+ 第一项
+ 第二项

- 第一项
- 第二项
  • 第一项
  • 第二项

3.2 有序列表

使用“数字+空格+.”来表示

1. 第一项
2. 第二项
  1. 第一项
  2. 第二项

列表嵌套：在嵌套的元素前使用缩进，嵌套第n层即进行n次缩进，如下所示——

1. 第一项：
    - 第一项嵌套的第一个元素
    - 第一项嵌套的第二个元素
2. 第二项：
    - 第二项嵌套的第一个元素
       - 第三层嵌套
  1. 第一项
    • 嵌套1
    • 嵌套2
  2. 第二项
    • 嵌套1
    • 嵌套2

3.4 折叠列表

使用<details>标签实现折叠列表。注意该标签内无法使用Markdown列表、表格语法，需使用<ul>、<ol>、<li>、<table>等实现对应效果。

<details>
<summary>点击打开/关闭折叠</summary>
 折叠内容
 <ul>
     <li>1</li>
     <li>2</li>
     <li>3</li>
 </ul>
</details>
点我打开关闭折叠

折叠内容

  • 1
  • 2
  • 3

3.5 复选框列表

部分在线编辑器不支持该语法

在列表标记之后添加[ ]，示例如下（某些编辑器或浏览器可能会自动将内容换行）：

* [x] 第一项
* [ ] 第二项
* [ ] 第三项

  • [x] 第一项

  • [ ] 第二项

  • [ ] 第三项

4 区块引用

在段落开头使用“>+空格”实现区块引用（<blockquote>标签）：

> 区块引用
>
> 回车键自动延伸区块

区块引用

回车键自动延伸区块

区块嵌套的方式类似列表嵌套，详见列表部分。示例如下：

> 第一层
> > 第二层
> > > 第三层

第一层

第二层

第三层

区块中使用列表：

> 区块中使用列表
> 1. 第一项
> 2. 第二项
> * 111
> * 222

区块中使用列表

  1. 第一项
  2. 第二项
    • 111
    • 222

列表中使用区块：

* 第一项
    > 区块
    >
    > 区块
* 第二项
  • 第一项

    区块

    区块

  • 第二项

5 代码

5.1 内联代码

使用一对反引号（`）来添加内联代码（Inline Code），即行内代码块：

`html` `css` `javascript`

html css javascript

5.2 代码区块

用三个反引号（\\`）包裹一段代码，并指定一种渲染语言（不指定则不渲染）：

function test() {
    alert('test')
}

6 脚注

部分在线编辑器不支持该语法

脚注是对文本的补充说明，示例如下：

[^变量]
在文档结尾或其他位置給变量赋值：
[^变量]: 注明框内显示的内容

7 链接

7.1 URL

格式为[链接名称](链接地址)或[链接名称](链接地址, 可选alt)，亦可使用<链接地址>直接显示链接（本站编辑器无需使用尖括号，自动渲染链接文本为<a>标签）。

示例如下：

[Hyplus](https://www.hyperplasma.top, 'Hyplus')

Hyplus

直接显示链接地址：

<http://www.baidu.com>

http://www.baidu.com

7.2 链接本地文件

建议使用相对路径（前提是该路径下的文件存在）：

[test](./md-img/test.md)

7.3 变量链接

链接可以用类似脚注的变量来代替，文档末尾或其他位置附带变量地址：

该链接用`1`作为网址变量：[Google][1]
该链接用`hyplus`作为网址变量：[Hyplus][hyplus]

[1]: http://www.google.com/
[hyplus]: https://www.hyperplasma.top/

该链接用1作为网址变量：Google
该链接用hyplus作为网址变量：Hyplus

7.4 锚点链接

Markdown中每一个标题都是一个锚点，和HTML的锚点（#）类似，详见标题部分。示例如下：

[Markdown](#Markdown)

Markdown

8 图片

8.1 图片链接

在链接的基础上，在最前面添加感叹号!，语法如下：

![图片名](图片链接)

亦可对图片地址使用相对路径、路径变量等，详见链接部分。

8.2 图片宽高

Markdown语法不支持设置图片样式，如有需要请使用 <img> 标签。

<img src="https://raw.githubusercontent.com/xugaoyi/image_store/master/blog/md_logo.png" width="50px" height="30px">

9 表格

使用|分隔不同的单元格，使用-分隔表头和其他行。

|  表头   | 表头  |
|  ----  | ----  |
| 单元格  | 单元格 |
| 单元格  | 单元格 |
表头 表头
单元格 单元格
单元格 单元格

对齐方式（本站暂不支持自定义对齐方式，仅供使用Typora时参考）：

  • -:：设置内容和标题栏居右对齐
  • :-：设置内容和标题栏居左对齐
  • :-:：设置内容和标题栏居中对齐

不支持rowspan等合并单元格功能，如有需要请使用<table>相关标签。

10 转义

在以下特殊字符前添加反斜杠（\）来实现转义：

\   反斜线
`   反引号
*   星号
_   下划线
{}  花括号
[]  方括号
()  小括号
#   井字号
+   加号
-   减号
.   英文句点
!   感叹号

11 数学公式、Mermaid图

Markdown默认支持插入Latex数学公式和Mermaid图，不同编辑器的语法规范不同。

本站使用Katex渲染器，语法如下：

  • 内联公式：两个美元符（$$） + 最外层一对反引号（`）
  • 公式区块：同代码区块，渲染语言选择katex

Mermaid相关内容详见本站教程——Mermaid绘图库基本教程。

发表评论