编写指南（支持的格式与插件）

本页汇总最常用的写法与扩展，示例均可直接复制使用。

基本 Markdown

• 段落、标题、列表、链接、图片按标准 Markdown 书写。
• 中文语境下，注意空格与标点规范。

表格（Table）

本站已统一表格视觉：

• 首行/表头背景色为 #F1F1F1，文字加粗。
• 表格正文（tbody）背景透明，移除卡片底色。

示例：

代码块与语法高亮

export const hello = (name: string) => `Hello ${name}`

数学公式（KaTeX）

• 行内：$E=mc^2$
• 块级：

Mermaid 流程图

通过自定义 MDX 组件使用：

组件会根据站点明/暗主题自动渲染，且对相同图进行结果缓存。

Tabs 选项卡

Twoslash（TypeScript 注释）

在代码块语言后加上 twoslash：

const msg = 'hi'
msg // hover 查看推断类型

扩展/插件开发简要

• 新增 MDX 组件：在 src/components/mdx 下创建文件（如 my-component.tsx），然后到 src/mdx-components.tsx 将其加入 getMDXComponents 返回对象中，之后即可在 .mdx 中直接使用该组件。
• Mermaid：组件位于 src/components/mdx/mermaid.tsx，传入 chart 字符串即可。
• 数学：已启用 remark-math 与 rehype-katex，直接使用 $...$ 或 $$...$$。
• Twoslash：已集成 fumadocs-twoslash，代码块写法参考上文示例。

最佳实践：

• 一页一个主题，使用二/三级标题组织内容；
• 表格仅承载结构化信息，避免大段文本；
• 静态资源放在 public/ 下，优先使用可编辑的 SVG。