Logseq-Git-Sync-101
Description
This repo aims to help Logseq users to sync their data via Git and GitHub.
Why use Git + GitHub to sync Logseq graph?
From the above diagram, it's pretty obvious that Git is the most robust way to sync your graph. iCloud is slow and problematic, and Syncthing is not available on iOS/iPadOS.
However, Git is quite scary for non-programmers, so this doc is here to help!
🎩 Suit up
Please check Prerequisite and get yourself a cup of coffee ☕.
🤔 So how does this method work?
Please check Workflow.
Now you need another cup of coffee
For Windows users
Please check Windows.
For macOS users
Please check macOS.
For iOS/iPadOS users
Please check iOS/iPadOS.
For Android users
Please check Android.
For Linux users
Linux users click here
If you are a Linux user, why are you still watching this repo? Shooo. 😎Lol, just a joke. Take the steps in macOS section as reference if you need it.
💥 Omg, Something blows up
Please check FAQ.
Change log
2023-01-09: Add a-Shell support for iOS/iPadOS users as a free althernative.
2022-11-01: Update Prerequisite, For macOS users, For Android users, FAQ wiki.
🪨 References
- Working Copy on iOS, by @danieltomasz1.
- Steps to auto sync iOS + Windows, by @Caps2.
- Gitea - self-hosted git server, by @Sawhney3.
- Self Managed Sync + Android setup, by @danzu4 and @Abulafia5.
- Git hooks settings
- What is GitHub?
- How does Git work?
- Repository size limits for GitHub.com
- About large files on GitHub
- Differences between CRLF and LF, in Chinese.
- Alternative way of git syncing on iOS using a-shell for free, by Petrus Hyvönen6.
- [Tutorial] How to enable automatic logseq graph sync on iOS with git & shortcut, by @sickmz7.
🎉 Acknowledgment
Credits to @danieltomasz1, @Sawhney3, @Caps2, @Abulafia5 @qwxlea4 for the workflow build up. And credits to @danzu8 for the incredible diagram!
FYI, those IDs are IDs in Logseq Discord Server if not specified.