Obsidian 插件指南 (Beta)

与 VS Code 扩展类似，我们的 Obsidian 插件支持上下文感知 OCR。通过 WriteTex 应用与 Obsidian 的无缝集成，它可以提供更准确的识别性能。

警告：该插件目前处于重度开发阶段，不提供任何担保。请自行承担使用风险。请参阅 LICENSE。目前，您必须配置好第三方提供商（如 OpenAI）的 API 才能使用该插件。

功能特性

• WriteTex 应用伴侣：将 WriteTex 移动端应用与您的桌面版 Obsidian 编辑器无缝连接。
• 上下文感知：自动将光标周围的文本发送给 AI，通过理解当前文档'风格和变量定义来提高识别准确度。
• 直接插入：生成的代码会立即插入到光标所在位置。

安装步骤

1. 从我们的 GitHub 仓库下载最新版本。
2. 将 main.js 和 manifest.json 放入库（Vault）的插件目录中：<VAULT>/.obsidian/plugins/writetex-obsidian/。
3. 打开 Obsidian 设置 -> 第三方插件 (Community Plugins) 并启用 WriteTex。

你不需要安装 WriteTex 桌面应用来使用 Obsidian 插件。只需要在您的 iPad/平板电脑上安装 WriteTex 移动应用程序即可。

配置说明

此部分与其他平台的设置类似。以下是一个简单的配置示例：

设置项目	设定值
API Endpoint	https://api.openai.com/v1
模型 (Model)	gpt-5
API 密钥 (API Key)	sk-...

自定义指令 (Custom Instructions)
可以添加额外的提示词来引导 AI 模型。例如，您可以添加：“使用 \mathbb{i} 作为虚数单位。”

使用方法

1. 启动服务器：

   • 服务器在 Obsidian 加载时会自动启动。
   • 检查右下角的状态栏：应当显示 "WriteTex: On"。
   • 如果显示 "Off"，请打开命令面板 (Cmd/Ctrl + P) 并运行 "WriteTex: Start Server"。

2. 连接客户端 (如 iOS 应用)：

   • 在手机上打开 WriteTex 应用。
   • 确保您的手机和电脑处于同一个 Wi-Fi 网络下。
   • 应用应当会自动发现 "WriteTex Obsidian @ [您的主机名]"。
   • 如果自动发现失败，请手动输入您电脑的 IP 地址。

对于其他平台 (Windows, Android, MacOS)，请参考 VS Code 指南。

3. 插入手写公式：
   • 将光标置于您希望插入代码的 Obsidian 笔记中。
   • 使用移动端应用手写数学公式。
   • 插件将接收图像，结合当前笔记的上下文进行分析，并将 LaTeX/Markdown 结果直接放置到您编辑器的光标位置。

故障排除

• 服务器无法启动：请检查端口 50905 是否被其他应用程序占用。如果你同时启用了 VS Code 扩展中的 WriteTex 服务，请先关闭它再重新启动 Obsidian。
• 移动应用无法连接：
  • 确保两台设备处于同一个 Wi-Fi 网络。
  • 检查电脑的防火墙设置，允许端口 50905 的传入连接。
  • 一些学校或企业网络可能会阻塞设备之间的直接连接。在这种情况下，您可以尝试使用虚拟局域网或热点。
• "Unauthorized" 错误：确保客户端应用发送了正确的API key writetex。