zuwf / fit

File gIT (FIT) to sync your files across mobile and desktop devices using GitHub.

FIT

Sync your files across mobile and desktop devices with one click.

Features

• Universally supported: sync your vault across multiple devices, support both mobile and desktop
• Auto sync is now available 🎉
• One-click to sync your vault.
• Conflict resolution: Stores conflicting changes from remote in the local _fit folder so you can resolve conflicts after sync
• Guided setup: Intuitive settings, easy to configure even if you are new to GitHub
• Works with existing vaults or repos

Note: This plugin is still in alpha, please backup your vault before using this plugin.

Quick demo

Setup

1. Create a personal access token (refers to Github: creating a personal access token)
2. Once the personal access token is filled in, you can authenticate the user. The GitHub username, list of repositories, and branches will auto-populate.
3. Select a repo and branch and you are ready to sync.

Notes about the first sync

• Repo cannot be empty (Select 'Add a README file' if you are creating a new repo)
• It is advised to use a new repo for syncing an existing vault, to minimize the chance of file name conflict on the first sync
• If your existing vault or repo is large, the initial sync would take longer and require a good internet connection

Roadmap

1. Improve user notification
   • allow user to opt in to get list of file changes in Notice
2. Enable integration of other git tools (e.g. gitlab, gitea)

Relevant plugins

There are other community plugins with more advanced git features, if you need features such as branching of your repo, Git is a nice plugin to check out.

There are also other plugins for synchronizing changes such as Git integration, GitHub sync, and YAOS. However, they do not support mobile yet as of writing this plugin.

Acknowledgements

• This plugin used Obsidian Sample Plugin as a template.
• This plugin uses Octokit to interface with GitHub rest api across devices.