Skip to content

adapole/cicada-sync

Repository files navigation

CICADA-SYNC

NOTE: This is a continued work form YAOS, which focus on team collaboration and syncronize.

Features

  • Single Sync Button: provides a single sync button that handles all your Git operations. No need to worry about multiple commands or complex workflows.
  • Easy Branch Switch Setting: provides a simple branch switch setting. No need to use git commands to switch branch or for pushing new branch to remote.

Prerequisites

It's recommended that you have a basic understanding of Git. Check the links below to get started.

  • Install Git: download git from this link.
  • Configure username and email: follow this guide to setup git username and email for local machine.
  • ssh-key: Generate ssh-key and add to github account. Refer to docs

Usage

After installing the plugin, you'll find a new "Sync" button in Obsidian. Simply press this button to sync your vault with the remote Git repository.

Attribution

Cicada-Sync is adapted from the Yaos library by Mahyar Mirrashed link.