Obsidian プラグインガイド (ベータ版)
VS Code 拡張機能と同様に、Obsidian プラグインはコンテキスト認識 OCR を提供し、WriteTex アプリと Obsidian のシームレスな統合により、より正確なパフォーマンスを可能にします。
警告: このプラグインは現在開発中であり、無保証です。自己責任で使用してください。LICENSE を参照してください。現在、プラグインを使用するには、サードパーティプロバイダー (OpenAI など) からの有効な API 設定が必要です。
特徴
- WriteTex アプリのコンパニオン: WriteTex モバイルアプリをデスクトップの Obsidian エディターにシームレスに接続します。
- コンテキスト認識: カーソル周辺のテキストを自動的に AI に送信し、現在のドキュメントのスタイルや変数を理解することで精度を向上させます。
- 直接挿入: 生成されたコードはカーソル位置に即座に挿入されます。
インストール
- GitHub リポジトリから最新リリースをダウンロードします。
main.jsとmanifest.jsonを保管庫のプラグインディレクトリに配置します:<VAULT>/.obsidian/plugins/writetex-obsidian/。- Obsidian の設定 -> コミュニティプラグイン を開き、WriteTex を有効にします。
Obsidian プラグインを使用するために WriteTex のデスクトップ版をインストールする必要はありません。iPad/タブレット上のモバイルアプリのみが必要です。
設定
この部分は他のプラットフォームのセットアップと同様です。簡単な例を以下に示します。
| 設定項目 | 設定値 |
|---|---|
| API エンドポイント | https://api.openai.com/v1 |
| モデル | gpt-5 |
| API キー | sk-... |
カスタム指示 (Custom Instructions)
AI モデルをガイドするための追加のプロンプトです。例えば、「虚数単位には \mathbb{i} を使用してください」などを追加できます。
使用方法
サーバーの起動:
- サーバーは Obsidian のロード時に自動的に起動します。
- 右下のアドオンステータスバーを確認してください: "WriteTex: On" と表示されているはずです。
- "Off" と表示されている場合は、コマンドパレット (
Cmd/Ctrl + P) を開き、"WriteTex: Start Server" を実行します。
クライアントの接続 (例: iOS アプリ):
- 携帯電話で WriteTex アプリを開きます。
- 携帯電話とコンピューターが同じ Wi-Fi ネットワークにあることを確認してください。
- アプリは自動的に "WriteTex Obsidian @ [YourHostname]" を検出するはずです。
- 自動検出に失敗した場合は、コンピューターの IP アドレスを手動で入力してください。
他のプラットフォーム (Windows, Android, MacOS) については、VS Code のガイドに従ってください。
- 手書き数式の挿入:
- コードを表示させたい Obsidian のノートにカーソルを置きます。
- モバイルアプリを使用して数式を書きます。
- プラグインは画像を受信し、現在のノートのコンテキストで分析し、LaTeX/Markdown の結果をエディターに直接挿入します。
トラブルシューティング
- サーバーが起動しない: ポート
50905が他のアプリケーションで使用されていないか確認してください。VS Code 拡張機能で WriteTex サーバーを有効にしている場合は、Obsidian を起動する前に無効にしてください。 - モバイルアプリが接続できない:
- 両方のデバイスが同じ Wi-Fi に接続されていることを確認してください。
- コンピューターのファイアウォール設定を確認し、ポート
50905での着信接続を許可してください。 - 一部の学校や企業のネットワークでは、デバイス間の接続がブロックされる場合があります。その場合は、VPN やホットスポットの使用を試してください。
- "Unauthorized" エラー: クライアントアプリが API キー
writetexを送信していることを確認してください。