Markdown 与 LaTeX

Markdown 的优点很简单：它让你专心写内容，而不是在编辑器里点来点去。

这个模板还接了数学公式渲染，所以不只是普通段落，公式也能写。拿来写技术说明、计费公式、模型路由权重、一些奇怪但有用的推导，都挺舒服。

标题

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

一篇文档里通常只放一个一级标题。不是不能放多个，是没必要。标题层级乱了，目录也会跟着乱。

列表

- Memos 负责随手记
- README 负责项目入口
- Docs 负责长说明
- Blog 负责正式文章

有顺序的步骤用数字：

1. 安装依赖
2. 本地构建
3. 推送仓库
4. 等自动部署

别用无序列表写操作步骤，读者会不知道能不能跳着做。

代码块

代码块要写语言名：

```bash
pnpm build
```

这样高亮和复制体验都更好。

常用语言名：

bash
ts
tsx
json
yaml
mdx
text

链接

[快速开始](/docs/getting-started/quick-start)

内部链接尽量用站内路径。外部链接才写完整 URL：

[Fumadocs](https://fumadocs.dev)

表格

| 内容类型 | 放哪里 |
| --- | --- |
| 碎片记录 | Memos |
| 项目入口 | README |
| 长说明 | Docs |
| 正式文章 | Blog |

表格适合对比，但不适合塞大段文字。塞多了移动端会很难看。

行内公式

行内公式用单个 $：

爱因斯坦快乐小公式：$E = mc^2$

效果： $E = mc^2$

块级公式

块级公式用两个 $$：

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

效果：

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

小建议

块级公式上下留空行。这样 Markdown parser 比较不容易抽风，别给它找事。

矩阵

$$
A = \begin{pmatrix}
1 & 2 \\
3 & 4
\end{pmatrix}
$$

效果：

A = \begin{pmatrix} 1 & 2 \\ 3 & 4 \end{pmatrix}

计费公式示例

拿模型调用成本举个例子：

$$
\text{Cost} = \sum_i \left( \frac{T_i}{10^6} \times P_i \right)
$$

效果：

\text{Cost} = \sum_i \left( \frac{T_i}{10^6} \times P_i \right)

这个就很适合写在 API、模型路由、账单说明里。比截图高级，也比 Word 公式好迁移。

MDX 里容易炸的地方

JSX 标签没闭合

<Callout title="提示" type="info">
  内容
</Callout>

闭合标签别漏。

花括号乱用

MDX 里 {} 有特殊含义。如果你只是想展示配置片段，放进代码块最稳。

{
  "title": "文档",
  "pages": ["index"]
}

HTML 和组件混写

能用 Markdown 就先用 Markdown。真的需要组件时再上 MDX。别为了显得高级，把普通段落全塞进组件里。