Sync your SiYuan notes with a private GitHub repository via the GitHub REST API. Compatible with Windows, Linux, macOS, and Android.
- Incremental Push — Sends only modified files
- Incremental Pull — Retrieves modified remote files
- Automatic Merge — 3-way merge before push (local / remote / last known state)
- Conflict Management — Local priority in case of conflict
- Diff before push — Displays files added/modified/deleted before pushing
- Plugin Sync — A manifest (
plugin-manifest.json) is pushed with data containing a list of all installed plugins (name + version) - Widget Sync — A manifest (
widget-manifest.json) is pushed with data containing all installed widgets - Automatic Installation — On pull, missing plugins/widgets are automatically installed from the official SiYuan marketplace
- Plugin Sync Exclusion —
siyuan-github-syncNever included in manifests nor installed/removed
- Secure — Stores tokens locally via
saveData() - Groq AI — Automatically generates commit messages (optional)
- Export/Import — Saves and restores the configuration
Copy the dist/ folder or the compiled folder to:
{siyuan-workspace}/data/plugins/siyuan-github-sync/
Then restart SiYuan and activate the plugin in Settings → Marketplace → Install.
npm install
npm run buildThe dist/ folder will be created. Copy it to the data/plugins/ folder of SiYuan.
Use a file manager to copy the siyuan-github-sync folder to Android/data/com.example.siyuan/files/data/plugins/ (or the equivalent path depending on your version).
- Open Settings → click on ⚙️ next to "GitHub Sync"
- Enter GitHub Username, Repository Name, PAT (Personal Access Token) Token (scope
repo) - Click on Test GitHub to verify the connection
- Click on Save
The plugin scans the data/plugins/ and data/widgets/ folders, reads each plugin.json/widget.json file, and generates two manifest files:
data/plugin-manifest.json— List of installed plugins (name + version)data/widget-manifest.json— List of installed widgets (name + version)
These Manifests are pushed alongside the other data files.
After the data pull, the plugin:
- Downloads the two manifests from the remote repository
- Compares the list of remote plugins/widgets with those installed locally
- Automatically installs any missing plugins/widgets from the SiYuan marketplace
- Displays the result in the pull completion message
Note: Only plugins/widgets available on the official marketplace are installed automatically. Custom plugins are not supported.
npm run dev # Watch mode
./compile.sh # Build + automatic deployment to SiYuan (Linux)MIT