校园

Markdown 格式手册

Markdown 格式手册

Markdown 的目标是实现「易读易写」,本手册旨在帮助同学们能够在本站获得更好的体验,实现更丰富的表达方式。


段落和换行

一个 Markdown 段落是由一个或多个连续的文本行组成,它的前后要有一个以上的空行。普通的 Markdown 段落不可以用空格或制表符来缩进。

空行:一行之内只包含回车换行、空格、制表符。

例如:

这是第一段话

这是第二段话

显示的效果如下:

这是第一段话

这是第二段话

如果两段之间不空一行,则无法正确分段。反面例子:

这是第一段话
这是第二段话

显示的效果如下:

这是第一段话 这是第二段话


段落内部换行

在行末输入两个空格或一个反斜线(\),可以达到比分段更加紧凑的换行效果。

例如:

这是第一行  
这是第二行

这是第三行\
这是第四行

(请注意“这是第一行”后的两个空格,可以用鼠标拖动选中它们。)

显示的效果如下:

这是第一行
这是第二行

这是第三行
这是第四行


标题

Markdown 的标题是在行首插入 1 到 6 个 #,# 和标题文字之间使用一个或多个空格,对应到标题 1 到 6 级。

例如:

# 这是 H1

## 这是 H2

### 这是 H3

这是正文

显示的效果如下:

这是 H1

这是 H2

这是 H3

这是正文


强调

Markdown 使用星号(*)和底线(_)标记需要强调的文字:一对标记表示_斜体_,两个连续的标记表示粗体;两个波浪号(~~)可表示删除线。标记需要紧贴被修饰的内容,不能在标记与内容之间插入空白。

基本写法:

*单星号斜体*

_单下划线斜体_

**双星号加粗**

__双下划线加粗__

~~删除线~~

这是一段包含**加粗内容**的普通文本。

显示的效果如下:

单星号斜体

单下划线斜体

双星号加粗

双下划线加粗

删除线

这是一段包含加粗内容的普通文本。


代码块

大段代码

Markdown 建立代码块的方法:在代码的首行和末行分别使用三个或更多的反引号(```)或波浪号(~~~),并独立成行。首行标记后可加语言名称,例如 cpp、c++、java、c、python 等;

例如:

```python
a = int(input())
b = int(input())
print(a+b)
```

显示的效果如下:

a = int(input())
b = int(input())
print(a+b)

小段代码

需要引用代码时,如果引用的语句只有一段,不分行,可以用 ` 将语句包起来。

例如:

前面的内容 `print("Welcome to Taizhou High School Jiangsu!")` 后面的内容。

显示的效果如下:

前面的内容 print("Welcome to Taizhou High School Jiangsu!") 后面的内容。


区块引用

Markdown 标记区块引用的方法是在行的最前面加 >,也可以只在整个段落的第一行最前面加上 >,区块引用内部可以嵌套,只要根据层次加上不同数量的 > 即可,引用的区块内也可以使用其他的 Markdown 语法,包括标题、列表、代码区块等。

例如:

> Markdown 标记区块引用的方法是在行的最前面加 `>`。
> 
> 也可以只在整个段落的第一行最前面加上 `>`。
> 
> > 区块引用内部可以嵌套,只要根据层次加上不同数量的 `>` 即可。
> > 
> > _我是内部嵌套区块,我可以使用其他 Markdown 语法哦。_
> > 
> > ### 我是引用区块内使用 3 级标题语法
> > 
> > ```python
> >     print("引用区块也可加入代码块")
> > ```

显示的效果如下:

Markdown 标记区块引用的方法是在行的最前面加 >。

也可以只在整个段落的第一行最前面加上 >。

区块引用内部可以嵌套,只要根据层次加上不同数量的 > 即可。

我是内部嵌套区块,我可以使用其他 Markdown 语法哦。

我是引用区块内使用 3 级标题语法

    print("引用区块也可加入代码块")

列表

Markdown 支持有序列表和无序列表以及任务列表。无序列表使用星号、加号或是减号作为列表标记,有序列表则使用数字接着一个英文句点。两种列表方式格式都是:列表标记 + 空格 + 列表项,即列表项目标记通常是放在最左边,也可以缩进最多 3 个空格,项目标记后面则一定要接着至少一个空格或制表符。

1 无序列表

星号、加号或是减号三种列表方式效果等同。

例如:

- Red
- Green
- Blue

它们的显示效果均为:

  • Red
  • Green
  • Blue

2 有序列表

有序列表则使用数字接着一个英文句点。

例如:

1.  Red
2.  Green
3.  Blue

显示效果为:

  1. Red
  2. Green
  3. Blue

3 任务列表

任务列表是一种特殊的列表,它可以在列表项前添加复选框,用于表示任务是否完成。任务列表的格式为:- [ ] 任务项 或 - [x] 任务项,其中 [ ] 表示未完成任务,[x] 表示已完成任务。

例如:

- [ ] 学习 Markdown 语法
- [x] 完成 Markdown 语法学习
- [ ] 编写 Markdown 文档

显示效果为:

  • 学习 Markdown 语法
  • 完成 Markdown 语法学习
  • 编写 Markdown 文档

链接

在方块括号后面紧接着圆括号并插入网址链接即可,如果还想要加上链接的 title 文字,只要在网址后面,用双引号把 title 文字包起来即可,例如:

[行内式链接标题](https://news.skyblockgod.xyz/ "可选标题")

显示效果为:

这是行内式链接标题。可将光标移至链接上查看 title 效果。


图片

Markdown 使用一种和链接很相似的语法来标记图片。

行内式的图片语法如下:

![替代文字](图片相对路径或绝对路径)

![替代文字](图片相对路径或绝对路径 "可选标题")

详细叙述如下:一个惊叹号 !,接着一个方括号,里面放上图片的替代文字(这些文字将在图片加载失败的时候显示),接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上选择性的 title 文字。

例如:

![泰州中学 logo](https://news.skyblockgod.xyz/media/emblem.png "泰州中学 logo")

将会显示图片:

泰州中学 logo


自动链接

Markdown 支持以比较简短的自动链接形式来处理网址和电子邮件信箱,只要是用尖括号包起来,Markdown 就会自动把它转成链接。一般网址的链接文字就和链接地址一样,例如:

<https://news.skyblockgod.xyz/>

显示效果为:

https://news.skyblockgod.xyz/


分隔线

分隔线是一种简单的分隔不同内容的方法,可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他内容。也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线:

***
---

显示的效果如下:



特殊符号识别与反斜杠

星号和底线并非总会按最近的一对自动配对。由 *、_ 形成的斜体和粗体标记,都必须位于可识别的边界;例如结束标记前是标点、后面又紧接文字时,可能无法被识别为强调结束标记。

*某项状态(并非最终状态)*的说明

**某项状态(并非最终状态)**的说明

*某项状态(并非最终状态)*的说明

**某项状态(并非最终状态)**的说明

上例中的星号会按普通文本显示。可将结束标记移至合适的位置:

*某项状态(并非最终状态)的*说明

**某项状态(并非最终状态)的**说明

某项状态(并非最终状态)的说明

某项状态(并非最终状态)的说明

如果 * 或 _ 的两边都有空白,它们会被当作普通符号。若需要在文字前后直接显示星号或底线,可以用反斜线(\)转义。

转义示例:

\*使用反斜线开头的\*被当做是普通的字符\*

显示的效果如下:

*使用反斜线开头的*被当做是普通的字符*


最后

本文章借鉴了网络上部分格式手册并进行了部分删改,希望大家能在这里共同交流、共同进步,共建更美好的泰中社区。

← 返回头版