Obsidian Plugin Guide (Beta)

Alike the VS Code extension, our Obsidian plugin offers context aware OCR, enabling more accurate performance with seamless integration between the WriteTex app and Obsidian.

WARNING: THE PLUGIN IS UNDER HEAVY DEVELOPMENT AND OFFERS ZERO WARRANTY. USE AT YOUR OWN RISK. SEE LICENSE. Currently you must have a working API config from a third party provider (e.g., OpenAI) to use the plugin.

Features

• Companion for WriteTex App: Seamlessly connects the WriteTex mobile app to your desktop Obsidian editor.
• Context Awareness: Automatically sends the text surrounding your cursor to the AI, improving accuracy by understanding your current document's style and variables.
• Direct Insertion: Generated code is inserted immediately at your cursor.

Installation

1. Download the latest release from our GitHub repository.
2. Put main.js and manifest.json into your vault's plugins directory: <VAULT>/.obsidian/plugins/writetex-obsidian/.
3. Open Obsidian Settings -> Community Plugins and enable WriteTex.

You do not need to install the desktop version of WriteTex to use the Obsidian plugin. Only the mobile app on your iPad/tablet is required.

Configuration

This part is similar to other platform's setup. A simple example is shown below:

Setting	Value
API Endpoint	https://api.openai.com/v1
Model	gpt-5
API Key	sk-...

Custom Instructions
Some additional prompt to guide the AI model. For example, you can add "Use \mathbb{i} for the imaginary unit."

Usage

1. Start the Server:

   • The server starts automatically when Obsidian loads.
   • Check the status bar in the bottom right: it should say "WriteTex: On".
   • If it says "Off", open the Command Palette (Cmd/Ctrl + P) and run "WriteTex: Start Server".

2. Connect Client (e.g., iOS App):

   • Open the WriteTex app on your phone.
   • Ensure your phone and computer are on the same Wi-Fi network.
   • The app should automatically discover "WriteTex Obsidian @ [YourHostname]".
   • If automatic discovery fails, manually enter your computer's IP address.

For other platforms (Windows, Android, MacOS), follow the guide in VS Code.

3. Insert Handwritten Formula with WriteTex:
   • Place your cursor in an Obsidian note where you want the code to appear.
   • Use the mobile app to write a math formula.
   • The plugin will receive the image, analyze it with the context of your current note, and insert the LaTeX/Markdown result directly into your editor.

Troubleshooting

• Server won't start: Check if port 50905 is being used by another application. If you have enabled the WriteTex Server in the VS Code extension, please disable it before launching Obsidian.
• Mobile app can't connect:
  • Ensure both devices are on the same Wi-Fi.
  • Check your computer's firewall settings to allow incoming connections on port 50905.
  • Some school or corporate networks may block between device connections. In this case, you can try using a VPN or hotspot.
• "Unauthorized" error: Ensure the client app sends the API key writetex.