Skip to content

Obsidian 插件指南 (Beta)

與 VS Code 擴展類似,我們的 Obsidian 插件支持上下文感知 OCR。通過 WriteTex 應用與 Obsidian 的無縫集成,它可以提供更準確的識別性能。

警告:該插件目前處於重度開發階段,不提供任何擔保。請自行承擔使用風險。請參閱 LICENSE。目前,您必須配置好第三方提供商(如 OpenAI)的 API 才能使用該插件。

功能特性

  • WriteTex 應用伴侶:將 WriteTex 移動端應用與您的桌面版 Obsidian 編輯器無縫連接。
  • 上下文感知:自動將光標周圍的文本發送給 AI,通過理解當前文檔的風格和變量定義來提高識別準確度。
  • 直接插入:生成的代碼會立即插入到光標所在位置。

安裝步驟

  1. 從我們的 GitHub 倉庫下載最新版本。
  2. main.jsmanifest.json 放入庫(Vault)的插件目錄中:<VAULT>/.obsidian/plugins/writetex-obsidian/
  3. 打開 Obsidian 設置 -> 第三方插件 (Community Plugins) 並啟用 WriteTex

你不需要安裝 WriteTex 桌面應用來使用 Obsidian 插件。只需要在您的 iPad/平板電腦上安裝 WriteTex 移動應用程序即可。

配置說明

此部分與其他平台的設置類似。以下是一個簡單的配置示例:

設置項目設定值
API Endpointhttps://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 指南。

  1. 插入手寫公式
    • 將光標置於您希望插入代碼的 Obsidian 筆記中。
    • 使用移動端應用手寫數學公式。
    • 插件將接收圖像,結合當前筆記的上下文進行分析,並將 LaTeX/Markdown 結果直接放置到您編輯器的光標位置。

故障排除

  • 服務器無法啟動:請檢查端口 50905 是否被其他應用程序佔用。如果你同時啟用了 VS Code 擴展中的 WriteTex 服務,請先關閉它再重新啟動 Obsidian。
  • 移動應用無法連接
    • 確保兩台設備處於同一個 Wi-Fi 網絡。
    • 檢查電腦的防火牆設置,允許端口 50905 的傳入連接。
    • 一些學校或企業網絡可能會阻塞設備之間的直接連接。在這種情況下,您可以嘗試使用虛擬局域網或熱點。
  • "Unauthorized" 錯誤:確保客戶端應用發送了正確的 API key writetex