Markdown 基础教程(适用于本论坛)

Markdown 基础教程(适用于本论坛)

本论坛支持 Markdown 排版语法
Markdown 的目标是:让你在“纯文本”的情况下,也能写出结构清晰、可读性很强的帖子,而不需要复杂的编辑器。

你只需要记住:

你看到的符号(如 # * > 等)并不会显示出来,它们只是“排版指令”。

下面是常用写法:backhand_index_pointing_down:


一、标题

介绍:
使用 # 可以创建标题,# 数量越多,标题越小(最多 6 级)。

示例:

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

显示效果:

会打乱目录,不展示,请自行尝试


二、加粗、斜体、删除线

介绍:
用于强调重点内容。

示例:

**这是加粗**
*这是斜体*
~~这是删除线~~

显示效果:
这是加粗
这是斜体
这是删除线


三、列表

介绍:
用于列举内容,分为无序列表和有序列表。

示例:

无序列表:
- 苹果
- 香蕉
- 西瓜

有序列表:
1. 第一步
2. 第二步
3. 第三步

显示效果:

无序列表:

  • 苹果
  • 香蕉
  • 西瓜

有序列表:

  1. 第一步
  2. 第二步
  3. 第三步

四、引用

介绍:
用于回复别人、标注说明、或者强调一段话。

示例:

> 这是一段引用内容
>> 这是嵌套引用

显示效果:

这是一段引用内容

这是嵌套引用


五、链接

介绍:
用于插入网址,并自定义显示文字。(可以快捷键或者选中文字直接粘贴来自其他地方的链接)

需要注意:如果你打算在本站帖子中粘贴另一篇帖子链接,还请去除域名,只使用后缀,例如:[帖子](https://mathcollapse.20000816.xyz/c/instruction/function/6),可以直接使用[帖子](/c/instruction/function/6),这是为了防止后面修改网站域名造成链接失效。

示例:

[访问B站](https://www.bilibili.com)

显示效果:
访问B站


六、图片

介绍:
图片语法和链接类似,只是前面多一个 !

示例:

![图片说明](upload://4HYdbqZ9xdWQV6eUd2uF8lsNL0k.jpeg)

显示效果:

(也可以直接粘贴图片或拖拽上传,论坛会自动处理)


七、行内代码

介绍:
用于显示命令、文件名、变量名等技术内容。

示例:

使用 `docker ps` 查看容器

显示效果:
使用 docker ps 查看容器


八、代码块(最重要)

介绍:
发布报错信息、配置文件、程序代码时必须使用代码块,否则会严重错位。
(注意:```被使用了,你想要包裹```代码块,那就要````包裹)

示例:

```
docker run -d -p 80:80 nginx
```

显示效果:

docker run -d -p 80:80 nginx

指定语言(推荐)

可以高亮代码:

示例(bash):

```bash
cd /var/www
ls -al
```

显示效果:

cd /var/www
ls -al

九、分割线

介绍:
用于分隔不同内容块。

示例:

---

显示效果:


十、表格

介绍:
用于整理信息。注意:表格里不能使用列表或代码块,否则会错位。
(注意:表格内可能不支持其他markdown语法,部分支持某些语法,可以自行尝试)

示例:

| 名称 | 说明 | 命令 |
|---|---|---|
| 查看容器 | 列出所有容器 | `docker ps` |
| 查看镜像 | 列出镜像 | `docker images` |

显示效果:

名称 说明 命令
查看容器 列出所有容器 docker ps
查看镜像 列出镜像 docker images

如果需要换行,可以使用 <br>

示例:

| 系统 | 特点 |
|---|---|
| Linux | 稳定<br>适合服务器<br>开源 |

显示效果:

系统 特点
Linux 稳定
适合服务器
开源

汇总

以下内容来源于Markdown 教程/ MARKDOWN 中文-比本帖教程丰富的多

Markdown 速查表提供了所有 Markdown 语法元素的基本解释。如果你想了解某些语法元素的更多信息,请参阅更详细的 基本语法扩展语法.

基本语法

这些是 John Gruber 的原始设计文档中列出的元素。所有 Markdown 应用程序都支持这些元素。

元素 Markdown 语法
标题(Heading) # H1
## H2
### H3
粗体(Bold) **bold text**
斜体(Italic) *italicized text*
引用块(Blockquote) > blockquote
有序列表(Ordered List) 1. First item
2. Second item
3. Third item
无序列表(Unordered List) - First item
- Second item
- Third item
代码(Code) code
分隔线(Horizontal Rule) ---
链接(Link) [title](https://www.example.com)
图片(Image) ![alt text](image.jpg)

扩展语法

这些元素通过添加额外的功能扩展了基本语法。但是,并非所有 Markdown 应用程序都支持这些元素。


小技巧

  • 粘贴截图可以直接 Ctrl+V
  • 拖拽图片到编辑框可直接上传
  • 编辑器中「预览」可实时查看效果
  • 不确定时:把内容放进代码块最安全
  • 尝试使用电脑快捷键输入

学会 Markdown 后,你的帖子会更清晰,也更容易得到他人的帮助 :blush: