Documentation

Installation

GitSy is available for Android devices running Android 7.0 or later. You can install it from the Google Play Store or download the APK directly.

System Requirements

• Android 7.0+ (API level 24)
• 64MB free storage space
• Internet connection for synchronization
• Access to a Git repository (GitHub, GitLab, etc.)

Initial Setup

After installing GitSy, you'll need to connect it to your Git repository. This is a one-time process that enables synchronization across all your devices.

Step 1: Create a Repository

First, create a new repository on your preferred Git hosting service:

• GitHub: Go to github.com and create a new repository
• GitLab: Visit gitlab.com and create a new project
• Self-hosted: Use your own Git server

Step 2: Configure GitSy

Open GitSy and follow these steps:

1. Tap "Add Repository" on the welcome screen
2. Enter your repository URL
3. Provide your authentication credentials
4. Choose a local folder name
5. Tap "Connect" to establish the connection

Creating Your First Note

Once your repository is connected, you can start creating notes immediately. GitSy uses a simple interface that focuses on your content.

Basic Note Creation

1. Tap the "+" button to create a new note
2. Enter a title for your note
3. Start typing your content
4. GitSy automatically saves your changes
5. Sync happens automatically in the background

Repository Setup

GitSy supports various Git hosting services and configurations. Here's how to set up repositories for different providers.

GitHub

GitLab

Self-hosted Git

Authentication

Secure authentication is essential for accessing your Git repository. GitSy supports multiple authentication methods.

Personal Access Token (Recommended)

The most secure method is using a personal access token:

1. Go to your Git provider's settings
2. Generate a new personal access token
3. Grant repository read/write permissions
4. Copy the token and paste it in GitSy

Username/Password

You can also use your regular username and password, but this method is less secure and may not work with all providers.

Sync Settings

GitSy offers flexible synchronization options to balance between real-time updates and battery life.

Sync Modes

• Automatic: Syncs whenever you make changes
• Manual: Sync only when you tap the sync button
• Scheduled: Sync at regular intervals

Sync Frequency

When using scheduled sync, you can choose from:

• Every 5 minutes
• Every 15 minutes
• Every hour
• Every 6 hours
• Daily

Note Management

GitSy provides powerful tools for organizing and managing your notes while keeping the interface clean and simple.

Note Organization

• Folders: Organize notes into folders and subfolders
• Tags: Add tags to notes for easy categorization
• Favorites: Mark important notes as favorites
• Recent: Quick access to recently modified notes

Note Actions

• Create, edit, and delete notes
• Duplicate notes for templates
• Share notes as text or markdown
• Export notes to other apps

Markdown Support

GitSy fully supports Markdown formatting, making it easy to create rich, formatted notes that look great on any device.

Supported Markdown Features

Search & Organization

Find any note quickly with GitSy's powerful search capabilities and organization features.

Search Features

• Full-text search: Search within note content
• Title search: Find notes by title
• Tag search: Filter by tags
• Date filters: Find notes by creation or modification date

Sorting Options

• By modification date (newest first)
• By creation date
• Alphabetically by title
• By size

Conflict Resolution

When the same note is edited on multiple devices simultaneously, GitSy uses Git's conflict resolution system to handle conflicts gracefully.

How Conflicts Occur

Conflicts happen when:

• The same note is edited on multiple devices
• Changes are made while offline
• Network issues prevent proper synchronization

Conflict Resolution Process

1. GitSy detects the conflict during sync
2. You're presented with both versions of the note
3. Choose which version to keep or merge them manually
4. The resolved note is saved and synced

Backup & Recovery

Your notes are automatically backed up to your Git repository, but GitSy also provides additional backup options for extra security.

Automatic Git Backup

Every time you sync, your notes are backed up to your Git repository. This means you have:

• Complete version history of all changes
• Multiple copies across all connected devices
• Recovery from any point in time

Manual Export

You can also export your notes manually:

• Export all notes as a ZIP file
• Export individual notes as Markdown files
• Share notes via email or other apps

Troubleshooting

Common issues and their solutions to help you get the most out of GitSy.

Sync Issues