Welcome to Sync Engine Documentation

A sync plugin that's also a platform — extend it with modules, no fork required.

Thank you for choosing the plugin Sync Engine. We aim to become the fastest and most versatile free syncing plugin in the Obsidian ecosystem through technical innovation and constant evolution. Your every adoption of Sync Engine is an aknowledgement for its engineering rigor.

The Sync Engine documentation contains three sections: Usage, Development, and Deep Dive, each section serve for its specific purpose:

• Usage: explains how to use Sync Engine and what users care most (reliability, security, and data privacy) in the language that everyone can understand. Designed for ordinary users to familiarize and explore around Sync Engine.
• Development: elaborates Sync Engine's modular contract and SDK API. Designed for technical users who want to extend Sync Engine with their own modules.
• Deep Dive: walks you through every technical detail in Sync Engine and official modules. Designed for learners who curious about how Sync Engine achieves its functionalities, and auditors who wants to verify the claims of Sync Engine.

We are here in the Usage section, you might feel interested in:

• Why Sync Engine: why Sync Engine is different from other syncing plugins. And how to start your first sync.
• Settings: what does each setting of Sync Engine mean.
• Benchmark: see how Sync Engine flex on other plugins with real statistics.
• Security, Permissions: the central claims made by Sync Engine, establish trust with verifiable proof.
• Develop a module: learn how to develop a Sync Engine module.