OneRender 帮助文档

简介

OneRender 是一款 OneNote 桌面版 Markdown 渲染插件，支持将 Markdown 文件导入 OneNote、粘贴 Markdown/代码片段、生成目录、AI 辅助等功能。渲染结果直接嵌入 OneNote 页面，保留代码高亮、数学公式、Mermaid 图表等格式。

系统要求

OneNote 2016、2019、2021 桌面版共用同一套 COM 加载项接口，安装方式相同。

安装与卸载

安装

1. 双击 OneRender-Setup-x.x.x.exe 运行安装程序
2. 按提示完成安装
3. 打开 OneNote，在功能区中可以看到 OneRender 选项卡

安装完成后，首次使用导入功能可能会失败，这是有些设备已知问题，再试一次即可恢复正常。

卸载

通过 Windows 设置 → 应用 → 已安装的应用 → 找到 OneRender → 卸载。

功能总览

OneRender 在 OneNote 功能区提供以下按钮：

导入 Markdown

将本地 Markdown 文件渲染后插入到当前 OneNote 页面。

使用方法

1. 在 OneNote 中打开目标页面，将光标放在要插入内容的位置
2. 点击 导入 Markdown
3. 在文件选择对话框中选择 .md 文件
4. 等待渲染完成，内容会自动插入页面

支持的 Markdown 语法

图片支持本地路径，会自动嵌入到 OneNote 页面中。

粘贴 Markdown

将剪贴板中的 Markdown 文本渲染为格式化内容并粘贴到 OneNote。

使用方法

1. 复制 Markdown 文本到剪贴板
2. 点击 粘贴 Markdown
3. 在弹出的对话框中查看和编辑内容
4. 点击确定后，渲染结果复制到剪贴板
5. 在 OneNote 中按 Ctrl+V 粘贴

粘贴代码

将代码片段以语法高亮的形式粘贴到 OneNote。

使用方法

1. 点击 粘贴代码
2. 在弹出的对话框中选择编程语言
3. 输入或粘贴代码
4. 点击确定，渲染结果复制到剪贴板
5. 在 OneNote 中按 Ctrl+V 粘贴

能智能识别非 Markdown 标注的代码语言。

支持的语言

支持主流编程语言的语法高亮，包括但不限于：Python、JavaScript、Java、C/C++、C#、Go、Rust、HTML、CSS、SQL、Bash 等。

公式渲染

OneRender 支持两种公式渲染模式，使用 KaTeX 语法。

行内公式

用 $...$ 包裹，例如 $E = mc^2$。

块级公式

用 $$...$$ 包裹，例如：

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

公式模式

图片模式的公式不可编辑但兼容性最好；原生模式的公式可以双击编辑，但部分复杂公式可能显示异常。

切换公式模式

点击 公式模式 → 选择「图片模式」或「原生模式」。

公式图片宽度

点击 公式图片宽度 → 选择宽度：

仅在图片模式下有效。宽度设置影响块级公式，行内公式始终自动适配。

代码高亮

代码块使用 Pygments 进行语法高亮，以带颜色的行内字体样式插入 OneNote。

代码主题

当前可用主题：

后续版本会支持更多主题。

使用示例

在 Markdown 代码块中指定语言即可启用高亮：

```python
def hello():
    print("Hello, OneNote!")
```

如果不指定语言，OneRender 会尝试自动检测编程语言。

Mermaid 图表

支持 Mermaid 语法渲染图表（流程图、时序图、甘特图等），以图片形式插入 OneNote。

使用示例

```mermaid
graph TD
    A[开始] --> B{条件判断}
    B -->|是| C[执行操作]
    B -->|否| D[结束]
    C --> D
```

Mermaid 图表需要 Playwright 浏览器引擎支持，首次使用时如果渲染失败，请重试一次。

生成目录

自动提取当前页面的标题层级，生成可点击的目录。

使用方法

1. 在页面上选中要生成目录的位置
2. 点击 生成目录
3. 插件会自动扫描页面标题，生成带超链接的目录

工作原理

• 自动识别页面中的标题文本（通过加粗、字号等格式判断）
• 按层级关系生成缩进目录
• 每个目录项是可点击的超链接，点击跳转到对应标题位置

AI 目录

使用 AI 智能分析页面内容，生成更精准的目录结构。（由于调用 API 方式，因此生成时间可能半分钟，取决于 API 服务商的响应速度）

使用方法

1. 先在 AI 配置 中配置好 AI 服务
2. 点击 AI 目录
3. AI 会分析页面内容，自动提取关键标题和结构

与普通目录的区别

AI 配置

配置 AI 服务商，用于 AI 目录等 AI 功能。

支持的 AI 服务商

配置步骤

1. 点击 AI 配置
2. 选择 AI 服务商
3. 填入 API Key
4. 填入模型名称（如 gpt-4o、qwen-plus 等）
5. 保存配置

API Key 仅存储在本地 %LOCALAPPDATA%\OneRender\ 目录下，不会上传到服务器。

导出 HTML

将当前页面内容导出为 HTML 文件。

使用方法

1. 在 OneNote 中选中要导出的内容
2. 按 Ctrl+C 复制到剪贴板
3. 点击 导出 HTML
4. 选择保存位置和文件名

授权管理

OneRender 需要激活后才能使用完整功能。

激活方式

同一台设备，同一邮箱只能领取一次试用。

查看授权状态

点击 授权 按钮，可以查看：

• 当前授权状态（已激活 / 试用中 / 未激活）
• 许可证类型
• 到期时间
• 设备绑定信息

试用

1. 点击 授权
2. 点击「领取试用」
3. 试用期内可使用全部功能

试用到期后，需要购买许可证才能继续使用。

多设备激活

一个永久激活码最多支持 2 台设备 同时使用：

• 同一台设备重复激活不会占用额外名额
• 达到设备上限后，需要先解绑旧设备才能在新设备上激活
• 设备通过 CPU、主板和硬盘序列号生成唯一标识，更换硬件可能导致需要重新激活

状态查看

点击 状态 按钮，可以查看当前插件的运行信息：

日志

日志文件位于 %LOCALAPPDATA%\OneRender\Logs\ 目录。

历史日志自动保留 7 天，超过 7 天的会自动删除。

遇到问题时，可以查看日志文件排查原因，或将日志发送给开发者协助诊断。

常见问题

安装后看不到 OneRender 选项卡？

1. 确认安装的是 64 位 Office
2. 重启 OneNote
3. 检查 文件 → 选项 → 加载项，确认 OneRender 在列表中且已启用

导入后格式不正确？

• 检查 Markdown 文件的编码是否为 UTF-8
• 确认 Markdown 语法是否正确
• 部分复杂的 HTML 嵌套可能无法完美转换

公式显示为乱码？

• 切换到「图片模式」重试
• 检查公式语法是否符合 KaTeX 规范
• LaTeX 不支持的命令可能无法渲染

AI 功能无响应？

• 检查 AI 配置中的 API Key 是否正确
• 确认网络可以访问 AI 服务商的 API 地址
• 检查模型名称是否填写正确

导入时间过长？

• 导入的 Markdown 文件较大
• 公式或代码块较多
• 后续会优化导入性能

已知问题

联系与反馈

如有问题或建议，请通过以下方式联系：

• 邮箱：shiguangxiaopu@foxmail.com
• 在项目仓库提交 Issue