写文档教程

本站用 Markdown 写文档。不会 Markdown 也没关系，看这一篇就会了。

两种方式，任选

方式一：网页上直接写（推荐）

/admin/index.php 登录后写，写完点保存，访客立刻能看到。编辑器带工具栏，不用记语法。

方式二：本地写 .md 再上传

用 VS Code、记事本、Typora 随便什么编辑器写，保存成 .md，然后：

• 用主机的文件管理上传到 docs/ 对应目录，或
• 用 FTP 工具（FileZilla）传上去

和在线写的完全互通，效果一样。

常用语法速查

# 一级标题（这个会成为侧边栏名字和页面标题）
## 二级标题（会出现在右侧「此页内容」）
### 三级标题

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

- 列表项
1. 有序列表
- [ ] 待办
- [x] 已完成

> 引用块（会渲染成紫色提示框，很适合放重点）

[链接文字](https://jhp.studio)

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

---

```cpp
// 代码块要指定语言才会高亮
cout << "hello";

## 代码块

用三个反引号包起来，后面写语言名：

````markdown
```cpp
int main() { return 0; }

支持 `cpp`、`python`、`js`、`bash`、`json` 等常见语言标识。

## 提示框写法

用 `>` 开头就会变成彩色的提示条：

```markdown
> 学习建议：先打牢语法，再刷算法题。

渲染出来是一个带紫色左边框的圆角提示框，很适合放「注意」「小贴士」。

内部链接

链接到本站其它文档用相对路径：

[电脑钢琴说明](../diannao-gangqin/index.md)

链接到钢琴页面本身（不是 md，是实际页面）：

[去玩钢琴](/piano/)

图片

![图片说明](图片地址)

图片地址可以是：

• 网络图片：直接填网址
• 站点内的图片：上传到站点任意目录后填相对路径，比如 /assets/pic.png

命名建议

做法	原因
文件名用英文/拼音	避免 URL 编码问题
加数字前缀 01- 02-	控制侧边栏排序
第一行一定写 # 标题	决定侧边栏显示的名字
一个目录放一个 index.md	点分类名时有内容可看

中文文件名可以吗

可以，但 URL 会变成一长串百分号编码，分享链接时不好看。建议文件名英文、标题中文。