OpenManual
进阶

MDX 增强

了解 OpenManual 中的 MDX 增强功能,包括 LaTeX 公式支持。

MDX 增强

MDX 是 Markdown 的超集,允许你在文档中使用 JSX/React 组件。OpenManual 在此基础上提供了更多增强功能。

LaTeX 公式

在配置中启用 LaTeX 支持:

{
  "mdx": {
    "latex": true
  }
}

启用后,你可以在文档中使用 LaTeX 语法:

行内公式

使用 $...$ 语法:

质能方程 $E = mc^2$ 是物理学的著名公式。

块级公式

使用 $$...$$ 语法:

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

MDX 配置字段

字段类型默认值说明
mdx.latexbooleanfalse是否启用 LaTeX 公式支持

标准 Markdown 支持

OpenManual 支持所有标准 Markdown 语法:

  • 标题(h1-h6)
  • 列表(有序、无序)
  • 代码块(带语法高亮)
  • 表格
  • 链接和图片
  • 引用
  • 水平线
  • 粗体、斜体、删除线

代码块

支持语法高亮和行标记:

```typescript showLineNumbers
function greet(name: string): string {
  return `Hello, ${name}!`;
}
```

MDX 组件

OpenManual 内置了丰富的 MDX 组件,你可以在文档中直接使用,无需额外 import。

组件说明详细文档
Callout提示框,用于显示重要提示信息Callout 提示框
Card / Cards卡片和卡片网格布局Card 卡片
Steps / Step带编号的分步指南Steps 步骤
Tabs / Tab标签页内容切换Tabs 标签页
Files / File / Folder文件树目录展示Files 文件树
Accordion / Accordions可折叠内容面板Accordion 折叠面板
TypeTableTypeScript 类型定义表格TypeTable 类型表格

点击组件名称可查看详细的使用说明和参数文档。

On this page