The Easiest Way to Connect Your Obsidian Vault with GitHub (Updated)

I use the Chirpy theme with GitHub Pages to publish my blogs, and I wanted a way to publish my blogs easily without leaving Obsidian and opening the command line or Git to type commands.

By the end of this tutorial, you will be able to sync your notes or publish your blogs from Obsidian to GitHub for free!

Prerequisites

1. Create a repository or use any existing repository on GitHub
2. Download Git and install it on your system
3. Create a personal access token from GitHub
   • Example:

• Set scopes to “repo” and expiration to “no expiration” or anything you want

Setup Steps

1. Install the Obsidian Git community plugin

1. Create a folder in Obsidian to store the repository
2. Run the command (Cmd/Ctrl + P): Clone an existing remote repo
3. Paste the URL of the repository in the following format:

https://<PERSONAL_ACCESS_TOKEN>@github.com/<USERNAME>/<REPO>.git

For example, it might look like this:

https://ghp_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX@github.com/USERNAME/REPO-NAME.git

1. Enter the folder name you created in step 5 (e.g., remote-blog/)
   • Leave blank and click enter if it asks for any more options
2. Restart Obsidian
3. Make edits to your notes
4. Publish your notes by running the commands:
   • “Git: commit”
   • “Git: push”
   • Open the command palette (Cmd/Ctrl + P) to run these commands

References

• YouTube Tutorial
• Obsidian Forum Guide