Документация

Всё, что нужно знать об использовании GitSy

Установка

GitSy доступен для Android-устройств с Android 7.0 или новее. Вы можете установить его из Google Play Store или скачать APK напрямую.

Системные требования

  • Android 7.0+ (API уровень 24)
  • 64МБ свободного места
  • Интернет-соединение для синхронизации
  • Доступ к Git-репозиторию (GitHub, GitLab и т.д.)

Необходимые разрешения

  • Интернет: Для синхронизации Git
  • Хранилище: Для локального хранения заметок
  • Состояние сети: Для определения подключения

Первоначальная настройка

После установки GitSy вам нужно подключить его к вашему Git-репозиторию. Это одноразовый процесс, который включает синхронизацию на всех ваших устройствах.

Шаг 1: Создайте репозиторий

Сначала создайте новый репозиторий на вашем предпочитаемом Git-хостинге:

💡 Совет

Сделайте ваш репозиторий приватным для безопасности заметок. GitSy работает как с публичными, так и с приватными репозиториями.

Шаг 2: Настройте GitSy

Откройте GitSy и выполните следующие шаги:

  1. Нажмите "Добавить репозиторий" на экране приветствия
  2. Введите URL вашего репозитория
  3. Предоставьте учетные данные для аутентификации
  4. Выберите имя локальной папки
  5. Нажмите "Подключить" для установления соединения

Создание первой заметки

После подключения репозитория вы можете сразу начать создавать заметки. GitSy использует простой интерфейс, который фокусируется на вашем контенте.

Основы создания заметок

  1. Нажмите кнопку "+" для создания новой заметки
  2. Введите заголовок для заметки
  3. Начните печатать содержимое
  4. GitSy автоматически сохраняет изменения
  5. Синхронизация происходит автоматически в фоновом режиме

⚠️ Важно

Первая синхронизация может занять несколько минут, поскольку GitSy настраивает начальную структуру репозитория.

Настройка репозитория

GitSy поддерживает различные Git-хостинги и конфигурации. Вот как настроить репозитории для разных провайдеров.

GitHub

Формат URL репозитория:

https://github.com/username/repository-name.git

GitLab

Формат URL репозитория:

https://gitlab.com/username/repository-name.git

Собственный Git-хостинг

Формат URL репозитория:

https://your-git-server.com/username/repository-name.git

Аутентификация

Безопасная аутентификация необходима для доступа к вашему Git-репозиторию. GitSy поддерживает несколько методов аутентификации.

Персональный токен доступа (Рекомендуется)

Самый безопасный метод — использование персонального токена доступа:

  1. Перейдите в настройки вашего Git-провайдера
  2. Сгенерируйте новый персональный токен доступа
  3. Предоставьте разрешения на чтение/запись репозитория
  4. Скопируйте токен и вставьте его в GitSy

Имя пользователя/Пароль

Вы также можете использовать обычные имя пользователя и пароль, но этот метод менее безопасен и может не работать со всеми провайдерами.

🔒 Совет по безопасности

Всегда используйте персональные токены доступа вместо паролей. Они более безопасны и могут быть легко отозваны при необходимости.

Настройки синхронизации

GitSy предлагает гибкие опции синхронизации для баланса между обновлениями в реальном времени и временем работы батареи.

Режимы синхронизации

  • Автоматический: Синхронизация при каждом изменении
  • Ручной: Синхронизация только при нажатии кнопки синхронизации
  • По расписанию: Синхронизация через регулярные интервалы

Частота синхронизации

При использовании запланированной синхронизации вы можете выбрать из:

  • Каждые 5 минут
  • Каждые 15 минут
  • Каждый час
  • Каждые 6 часов
  • Ежедневно

Управление заметками

GitSy предоставляет мощные инструменты для организации и управления заметками, сохраняя при этом чистый и простой интерфейс.

Организация заметок

  • Папки: Организуйте заметки в папки и подпапки
  • Теги: Добавляйте теги к заметкам для легкой категоризации
  • Избранное: Отмечайте важные заметки как избранные
  • Недавние: Быстрый доступ к недавно измененным заметкам

Действия с заметками

  • Создание, редактирование и удаление заметок
  • Дублирование заметок для шаблонов
  • Поделиться заметками как текстом или markdown
  • Экспорт заметок в другие приложения

Поддержка Markdown

GitSy полностью поддерживает форматирование Markdown, что делает легким создание богатых, отформатированных заметок, которые отлично выглядят на любом устройстве.

Поддерживаемые функции Markdown

Заголовки

# H1
## H2
### H3

Форматирование текста

**Жирный текст**
*Курсивный текст*
~~Зачеркнутый~~

Списки

- Неупорядоченный список
1. Упорядоченный список
- [ ] Список задач

Ссылки и изображения

[Текст ссылки](URL)
![Альтернативный текст](url-изображения)

Разрешение конфликтов

Когда одна и та же заметка редактируется на нескольких устройствах одновременно, GitSy использует систему разрешения конфликтов Git для изящной обработки конфликтов.

Как возникают конфликты

Конфликты происходят когда:

  • Одна и та же заметка редактируется на нескольких устройствах
  • Изменения вносятся в автономном режиме
  • Проблемы с сетью препятствуют правильной синхронизации

Процесс разрешения конфликтов

  1. GitSy обнаруживает конфликт во время синхронизации
  2. Вам представляются обе версии заметки
  3. Выберите, какую версию сохранить, или объедините их вручную
  4. Разрешенная заметка сохраняется и синхронизируется

💡 Лучшая практика

Чтобы минимизировать конфликты, старайтесь завершить редактирование заметки перед переключением на другое устройство.

Резервное копирование и восстановление

Ваши заметки автоматически резервируются в ваш Git-репозиторий, но GitSy также предоставляет дополнительные опции резервного копирования для дополнительной безопасности.

Автоматическое резервное копирование Git

Каждый раз при синхронизации ваши заметки резервируются в ваш Git-репозиторий. Это означает, что у вас есть:

  • Полная история версий всех изменений
  • Множественные копии на всех подключенных устройствах
  • Восстановление с любого момента времени

Ручной экспорт

Вы также можете экспортировать заметки вручную:

  • Экспорт всех заметок как ZIP-файла
  • Экспорт отдельных заметок как Markdown-файлов
  • Поделиться заметками через email или другие приложения

Устранение неполадок

Распространенные проблемы и их решения, чтобы помочь вам получить максимум от GitSy.

Проблемы синхронизации

Проблема: Заметки не синхронизируются

Решения:

  • Проверьте интернет-соединение
  • Проверьте учетные данные репозитория
  • Попробуйте ручную синхронизацию
  • Перезапустите приложение

Проблема: Ошибка аутентификации

Решения:

  • Проверьте, не истек ли ваш токен
  • Проверьте разрешения токена
  • Попробуйте повторно ввести учетные данные
  • Проверьте формат URL репозитория

Проблема: Приложение зависает или вылетает

Решения:

  • Обновите до последней версии
  • Очистите кэш приложения
  • Перезагрузите устройство
  • Проверьте доступное место для хранения

Нужна дополнительная помощь?

Если у вас все еще есть проблемы, пожалуйста, посетите нашу страницу контактов, чтобы связаться с нашей службой поддержки.