Write in Your Favorite Editor with GitHub Sync

If you prefer writing in VS Code, Vim, or your terminal over web-based editors, SimplyBlog's GitHub integration is for you. Connect a repository, write in Markdown, push your changes, and your blog updates automatically.

How It Works

The setup takes about two minutes:

  1. Go to your blog settings and click "Connect GitHub"
  2. Enter your repository (e.g., yourname/blog-posts)
  3. Specify the folder containing your posts (defaults to posts/)
  4. Add a Personal Access Token with repo scope

Once connected, SimplyBlog creates a webhook on your repository. Every time you push, your posts sync automatically.

Writing Posts

Create Markdown files with YAML frontmatter:

---
title: My First Post
published_at: 2026-01-27
tags: writing, thoughts
---

Your content here. Use standard Markdown—headers, lists, code blocks, links, images.

The title field is required. Everything else is optional:

  • published_at or date — when the post was published
  • tags — comma-separated list of tags
  • draft: true — keeps the post unpublished

Image Handling

Reference images in your Markdown as you normally would:

![Screenshot](./images/screenshot.png)

SimplyBlog downloads images from your repository and hosts them for you. No need to worry about paths or hosting—just commit your images alongside your posts.

What Happens on Push

When you push changes to your repository:

  • New files become new blog posts
  • Modified files update existing posts
  • Deleted files unpublish the corresponding posts (they become drafts, not deleted)

The sync is smart—it skips files that haven't changed since the last sync.

Sync Activity

Your dashboard shows recent sync activity with the status of each file:

  • Synced successfully processed
  • Skipped unchanged since last sync
  • Failed something went wrong (with error details)
  • Removed file was deleted, post moved to draft

Your Workflow, Your Tools

This integration is designed for developers who want to:

  • Write in their preferred editor with familiar keybindings
  • Use Git for version control and history
  • Collaborate through pull requests
  • Keep posts in a repository they control
  • Automate publishing with their existing CI/CD pipeline

Push to main, and your blog is updated. That's it.

Getting Started

Head to your blog settings and connect a GitHub repository. If you don't have posts yet, create a posts/ folder in your repo and add your first Markdown file. Push, and watch it appear on your blog.