Skip to content

Markdown 写作指南

本站所有词条都用 Markdown 编写。Markdown 是一种轻量级标记语言,几分钟就能学会。本页列出了写作词条时最常用的语法。

基础语法

标题

# 的个数表示标题级别,# 是一级标题(相当于页面标题),正文里通常用 #####

markdown
## 二级标题
### 三级标题

文本样式

markdown
**加粗**  *斜体*  ~~删除线~~  `行内代码`

列表

markdown
- 无序列表项
- 另一个无序列表项

1. 有序列表项
2. 另一个有序列表项

链接与图片

markdown
[链接文字](https://example.com)

![图片说明](/icons/org.svg)

链接到站内其他词条时,直接写相对路径即可,例如 [组织概览](/org/)

表格

markdown
| 名称 | 用途 | 负责人 |
| --- | --- | --- |
| 场地申请表 | 申请活动场地 | 内联部 |
| 经费预算表 | 活动预算申报 | 财务部 |

代码块

markdown
```python
print("hello world")
```

引用与分隔线

markdown
> 这是一段引用

---

本站特色语法

提示框(callout)

::: tip 开头、::: 结尾可以生成带颜色的提示框。

markdown
::: tip 提示
这里是提示内容,常用于给出补充说明。
:::

::: warning 注意
这里是警告内容,常用于提醒容易踩的坑。
:::

::: danger 危险
这里是危险内容,常用于必须注意的禁忌。
:::

数学公式

$ 包裹行内公式,用 $$ 包裹独立公式,支持 LaTeX 语法。

markdown
质能方程:$E = mc^2$

$$
\int_{-\infty}^{+\infty} e^{-x^2} dx = \sqrt{\pi}
$$

代码行号与高亮

代码块默认显示行号。可以在代码块后标注语言实现高亮:

markdown
```js {1,3-4}
const a = 1
const b = 2
const c = a + b
console.log(c)
```

词条的通用结构

一个词条页面建议遵循如下结构:

markdown
---
title: 词条标题
---

## 简介
(一段话介绍这是什么)

## 主要内容
(按需分小节展开)

## 常见问题 / 注意事项
(可选)

## 相关词条
- [相关词条 A](/org/)
- [相关词条 B](/activities/)

还不知道怎么写?

可以直接打开 示例词条(模板),复制一份照着改。

基于 VitePress · Markdown 驱动