logseq-meta/Logseq-Git-Sync-101-main/README.md

<h1 align="center">
    Logseq-Git-Sync-101
</h1>

<p align="center">
    <a href="https://github.com/CharlesChiuGit/Logseq-Git-Sync-101/stargazers">
    <img
        alt="GitHub Repo stars"
        src="https://img.shields.io/github/stars/CharlesChiuGit/Logseq-Git-Sync-101?color=957FB8&logo=starship&style=for-the-badge">
    </a>
    <a href="https://github.com/CharlesChiuGit/Logseq-Git-Sync-101/issues">
    <img
        alt="GitHub issues"
        src="https://img.shields.io/github/issues-raw/CharlesChiuGit/Logseq-Git-Sync-101?color=DCA561&logo=gitbook&logoColor=d9e0ee&style=for-the-badge">
    <a href="https://github.com/CharlesChiuGit/Logseq-Git-Sync-101/contributors">
    <img
        alt="GitHub contributors"
        src="https://img.shields.io/github/contributors/CharlesChiuGit/Logseq-Git-Sync-101?color=%2398BB6C&logo=opensourceinitiative&logoColor=d9e0ee&style=for-the-badge">
    </a>
    <img
        alt="GitHub code size in bytes"
        src="https://img.shields.io/github/languages/code-size/CharlesChiuGit/Logseq-Git-Sync-101?color=%237E9CD8&logo=gitlfs&logoColor=d9e0ee&style=for-the-badge">
</p>

<p align="center">
    <img
        alt="shell script"
        src="https://img.shields.io/badge/shell_script-%23121011.svg?style=for-the-badge&logo=gnu-bash&logoColor=white">
    <a href="https://logseq.com/#/">
    <img
        alt="Logseq"
        src="https://img.shields.io/static/v1?label=&message=LOGSEQ&color=002B35&style=for-the-badge">
    </a>

</a>

## Description

This repo aims to help Logseq users to sync their data via Git and GitHub.

<p align="center">
        <img src="./src/ppap-meme.svg" style="width:50%"/>
</p>

## Why use Git + GitHub to sync Logseq graph?

<p align="center">
      <img src="./src/self-managed-sync-v2.png" style="width:100%"/>
</p>

<!-- <blockquote align="center"> -->
<!-- Self Managed Sync Diagram, by @danzu -->
<!-- </blockquote> -->

<div align="center">
    <h6> Self Managed Sync Diagram, by @danzu</h6>
</div>

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](https://syncthing.net/downloads/) 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](https://github.com/CharlesChiuGit/Logseq-Git-Sync-101/wiki/Prerequisite) and get yourself a cup of coffee ☕.

## 🤔 So how does this method work?

Please check [Workflow](https://github.com/CharlesChiuGit/Logseq-Git-Sync-101/wiki/%F0%9F%AA%9C-Workflow).

## Now you need another cup of coffee

### <img src="https://raw.githubusercontent.com/CharlesChiuGit/Logseq-Git-Sync-101/main/src/Windows.svg" width="25"/> For Windows users

Please check [Windows](https://github.com/CharlesChiuGit/Logseq-Git-Sync-101/wiki/For-Windows-users).

### <img src="https://raw.githubusercontent.com/CharlesChiuGit/Logseq-Git-Sync-101/main/src/Apple.svg" width="25"/> For macOS users

Please check [macOS](https://github.com/CharlesChiuGit/Logseq-Git-Sync-101/wiki/For-macOS-users).

### <img src="https://raw.githubusercontent.com/CharlesChiuGit/Logseq-Git-Sync-101/main/src/Apple.svg" width="25"/> For iOS/iPadOS users

Please check [iOS/iPadOS](https://github.com/CharlesChiuGit/Logseq-Git-Sync-101/wiki/For-iOS-iPadOS-users).

### <img src="https://raw.githubusercontent.com/CharlesChiuGit/Logseq-Git-Sync-101/main/src/android.svg" width="25"/> For Android users

Please check [Android](https://github.com/CharlesChiuGit/Logseq-Git-Sync-101/wiki/For-Android-users).

### <img src="https://raw.githubusercontent.com/CharlesChiuGit/Logseq-Git-Sync-101/main/src/linux.svg" width="25"/> For Linux users

<details>
    <summary>Linux users click here</summary>
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.

</details>

## 💥 Omg, Something blows up

Please check [FAQ](https://github.com/CharlesChiuGit/Logseq-Git-Sync-101/wiki/%F0%9F%92%A5-FAQ).

---

## Change log

2022-11-01: Update `Prerequisite`, `For macOS users`, `For Android users`, `FAQ` wiki.

---

## 🪨 References

- [Working Copy on iOS](https://discord.com/channels/725182569297215569/766475028978991104/946787658405908560), by @danieltomasz[^1].
- [Steps to auto sync iOS + Windows](https://discord.com/channels/725182569297215569/924907384730689566/966343847934324776), by @Caps[^3].
- [Gitea - self-hosted git server](https://discord.com/channels/725182569297215569/924907384730689566/963840487712780320), by @Sawhney[^2].
- [Self Managed Sync + Android setup](https://discord.com/channels/725182569297215569/966983361249816586), by @danzu[^5] and @Abulafia[^4].
- [Git hooks settings](https://discord.com/channels/725182569297215569/960982172683100160)
- [What is GitHub?](https://kinsta.com/knowledgebase/what-is-github/)
- [How does Git work?](https://medium.com/@sahoosunilkumar/how-does-git-works-5cc8444ea383)
- [Repository size limits for GitHub.com](https://stackoverflow.com/questions/38768454/repository-size-limits-for-github-com)
- [About large files on GitHub](https://docs.github.com/en/repositories/working-with-files/managing-large-files/about-large-files-on-github)
- [Differences between CRLF and LF](https://violin-tao.blogspot.com/2016/05/crlflf-bug.html), in Chinese.

## 🎉 Acknowledgment

Credits to @danieltomasz[^1], @Sawhney[^2], @Caps[^3], @Abulafia[^4] @qwxlea[^5] for the workflow build up. And credits to @danzu[^6] for the incredible diagram!

FYI, those IDs are IDs in [Logseq Discord Server](https://discord.gg/bZ2jF9taUg).

[^1]: danieltomasz#5748
[^2]: Sawhney#7320
[^3]: Caps#0219
[^4]: Abulafia#3734
[^5]: qwxlea#3490
[^6]: danzu#6567