Руководство по плагину Obsidian (Бета)

Как и расширение для VS Code, наш плагин для Obsidian предлагает контекстно-зависимое распознавание OCR, обеспечивая более точную работу благодаря бесшовной интеграции между приложением WriteTex и Obsidian.

ПРЕДУПРЕЖДЕНИЕ: ПЛАГИН НАХОДИТСЯ В СТАДИИ АКТИВНОЙ РАЗРАБОТКИ И НЕ ПРЕДОСТАВЛЯЕТ НИКАКИХ ГАРАНТИЙ. ИСПОЛЬЗУЙТЕ НА СВОЙ СТРАХ И РИСК. СМ. ЛИЦЕНЗИЮ. В настоящее время для использования плагина у вас должна быть рабочая конфигурация API от стороннего провайдера (например, OpenAI).

Особенности

• Компаньон для приложения WriteTex: Бесшовное подключение мобильного приложения WriteTex к вашему десктопному редактору Obsidian.
• Контекстная осведомленность: Автоматически отправляет текст вокруг курсора ИИ, повышая точность за счет понимания стиля и переменных вашего текущего документа.
• Прямая вставка: Сгенерированный код немедленно вставляется в позицию курсора.

Установка

1. Загрузите последнюю версию из нашего репозитория GitHub.
2. Поместите main.js и manifest.json в каталог плагинов вашего хранилища: <VAULT>/.obsidian/plugins/writetex-obsidian/.
3. Откройте настройки Obsidian -> Community Plugins и включите WriteTex.

Вам не нужно устанавливать настольную версию WriteTex для использования плагина Obsidian. Требуется только мобильное приложение на вашем iPad/планшете.

Настройка

Эта часть аналогична настройке для других платформ. Простой пример показан ниже:

Настройка	Значение
API Endpoint	https://api.openai.com/v1
Модель	gpt-5
API Key	sk-...

Пользовательские инструкции (Custom Instructions)
Некоторые дополнительные подсказки для управления моделью ИИ. Например, вы можете добавить: «Используйте \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. Вставка рукописной формулы с помощью WriteTex:
   • Поместите курсор в заметку Obsidian там, где вы хотите, чтобы появился код.
   • Используйте мобильное приложение, чтобы написать математическую формулу.
   • Плагин получит изображение, проанализирует его в контексте вашей текущей заметки и вставит результат LaTeX/Markdown прямо в ваш редактор.

Поиск и устранение неисправностей

• Сервер не запускается: Проверьте, не используется ли порт 50905 другим приложением. Если вы включили сервер WriteTex в расширении VS Code, пожалуйста, отключите его перед запуском Obsidian.
• Мобильное приложение не может подключиться:
  • Убедитесь, что оба устройства находятся в одной сети Wi-Fi.
  • Проверьте настройки брандмауэра вашего компьютера, чтобы разрешить входящие соединения на порту 50905.
  • Некоторые школьные или корпоративные сети могут блокировать соединения между устройствами. В этом случае вы можете попробовать использовать VPN или точку доступа.
• Ошибка "Unauthorized": Убедитесь, что клиентское приложение отправляет ключ API writetex.