Git Writer

A minimalistic, cross-platform note-taking app that uses Git repositories to keep your Markdown notes version-controlled and synchronized across devices. Supports all major platforms (Linux, macOS, Windows, Android, iOS).

---

Installation

Download binaries from the Releases page.

Warning

• macOS: app is not signed, to make it work, you may need run this command: xattr -d com.apple.quarantine /Applications/GitWriter.app
• iOS: The .ipa is unsigned. Sideload it using tools like AltStore, SideStore, or Sideloadly with your free Apple ID.

---

---

Support this project with a coffee:

---

Used technologies:

• Kotlin Multiplatform & Compose Multiplatform
• Git Integration: JGit (Desktop and Android), libgit2
• Image & File Handling: Coil 3 & FileKit
• Markdown parsing & rendering: multiplatform-markdown-renderer & jetbrains-markdown

---

Spell Checking

• misspellings are checked against the spell check language in the app settings, which defaults to the app language

Platform	Setup
Windows	Install the language under Settings -> Time & Language -> Language & region -> Add a language, including Basic typing. The keyboard layout is not needed.
macOS	Nothing to do, the dictionaries ship with the system. If your language is not underlined, enable it under System Settings -> Keyboard -> Text Input -> Edit... -> Spelling.
Linux	Install your language's hunspell package. Names are distro and region specific.

sudo apt/dnf search hunspell-<language> 
sudo apt/dnf install hunspell-es

Package names include the region: hunspell-es and hunspell-cs, but hunspell-de-de on Debian and Ubuntu. Chinese is not spell checked, hunspell has no dictionary with word segmentation.

---

Building app

Desktop Distributions

• Current OS:

  ./gradlew :desktopApp:packageDistributionForCurrentOS

• Linux (.deb / .rpm):

  ./gradlew :desktopApp:packageDeb
  ./gradlew :desktopApp:packageRpm

• macOS (.dmg / .pkg):

  ./gradlew :desktopApp:packageDmg
  ./gradlew :desktopApp:packagePkg

• Windows (.msi / .exe):

  ./gradlew :desktopApp:packageMsi
  ./gradlew :desktopApp:packageExe

Output location: desktopApp/build/compose/binaries/main/

Android Release

• Release APK:

  ./gradlew :androidApp:assembleRelease

  Output location: androidApp/build/outputs/apk/release/

iOS Release

• Build in Xcode

---

Contributing

Contributions are always welcome! If you find a bug or have an idea for an enhancement, feel free to open an Issue.