Skip to main content

​
Installation Methods

Sync Folds can be installed through Obsidian’s Community Plugins directory or manually by downloading release files.

​
Method 1: Community Plugins (Coming Soon)

Sync Folds is pending approval in the Obsidian Community Plugins directory. Once approved, you’ll be able to install it directly from within Obsidian.
When available, follow these steps:
1

Open Community Plugins

Navigate to Settings → Community Plugins in Obsidian
2

Search for Sync Folds

In the Community Plugins browser, search for “Sync Folds”
3

Install the plugin

Click Install, then click Enable to activate the plugin

​
Method 2: Manual Installation

For immediate use, install Sync Folds manually from the GitHub releases:
1

Download release files

Visit the Sync Folds releases page and download these files from the latest release:
  • main.js
  • manifest.json
The manifest.json file contains plugin metadata including the plugin ID (sync-folds), version (1.0.0), and minimum Obsidian version (0.15.0).
2

Create plugin directory

In your vault, create the plugin folder:
VaultFolder/.obsidian/plugins/sync-folds/
Replace VaultFolder with your actual vault folder name.
  • Desktop: Your vault folder is wherever you created your Obsidian vault
  • Mobile: Use a file manager app to navigate to your vault location
  • The .obsidian folder is hidden on some systems - enable “Show hidden files” in your file manager
3

Copy files to plugin folder

Move or copy the downloaded main.js and manifest.json files into:
VaultFolder/.obsidian/plugins/sync-folds/
Your final structure should look like:
VaultFolder/
└── .obsidian/
    └── plugins/
        └── sync-folds/
            ├── main.js
            └── manifest.json
4

Reload Obsidian

Completely quit and restart Obsidian to detect the new plugin
On desktop, use Ctrl/Cmd + R to reload, or fully restart the application. On mobile, close and reopen the app.
5

Enable the plugin

Navigate to Settings → Community Plugins and find “Sync Folds” in the installed plugins list. Toggle it on to enable.
If you don’t see the plugin after reloading, verify that:
  • The files are in the correct folder
  • The folder is named exactly sync-folds (matching the id in manifest.json)
  • You’ve enabled Community Plugins (there’s a toggle at the top of the Community Plugins settings)

​
Verify Installation

After installation, verify that Sync Folds is working:
1

Check plugin is enabled

Go to Settings → Community Plugins and confirm “Sync Folds” shows as enabled
2

Verify commands are available

Open the command palette (Ctrl/Cmd + P) and search for “fold”. You should see:
  • Export folds from local storage
  • Import folds into local storage
3

Check data file exists

After the plugin loads, verify that a data file was created:
VaultFolder/.obsidian/plugins/sync-folds/data.json
This file stores your fold states and should contain:
{
  "enableSync": true,
  "folds": "{}" 
}
4

Test fold state sync

  1. Open a note and fold a section
  2. Check that data.json was updated (the folds field should no longer be empty)
  3. Unfold the section and verify the file updates again
If the plugin initializes but finds no existing fold states, it will automatically export your current localStorage fold states to data.json. This ensures you don’t lose any existing folds.

​
Platform Support

Sync Folds works on both desktop and mobile platforms:
  • Desktop: Windows, macOS, Linux
  • Mobile: iOS, Android
The plugin has isDesktopOnly: false in its manifest, meaning it’s fully compatible with Obsidian mobile apps.

​
Next Steps

Quickstart Guide

Learn how to use Sync Folds effectively

Sync Setup

Configure sync settings and behavior

Build docs developers (and LLMs) love

Get started for freeTalk to us