Skip to content

A collaborative content editor for markdown or static site generators without lock-in

License

Notifications You must be signed in to change notification settings

tnkuehne/gether

Gether

Gether

A collaborative content editor for markdown or static site generators without lock-in

Features

  • Live collaboration (Cloudflare Durable Objects)
  • Rendered Markdown Preview
  • Live Content Preview (Cloudflare Sandboxes)
  • Just use existing GitHub Auth
  • File navigation
  • UI for frontmatter
  • Branching and Forking
  • Opening pull requests
  • Showing and writing comments on pull requests in UI

Roadmap

  • wysiwyg editor
  • Media upload
  • Collections for easier content navigation
  • Offline Support via CRDTs
  • MDX component insertion

Live Preview

Note

This feature is currently in private beta (send me a DM) until I find out how to limit the costs. It uses Cloudflare sandboxes under the hood, which can get expensive

Add config File gether.jsonc

{
	// Package manager: "npm", "pnpm", "yarn", or "bun"
	"packageManager": "pnpm",

	// Working directory relative to repo root
	"root": ".",

	// Command to install dependencies
	"install": "pnpm install",

	// Command to start dev server
	"dev": "pnpm dev",

	// Port the dev server listens on
	"port": 5173,
}

Deploy your own

You can use a hosted version at gether.md or deploy your own instance following this guide:

  1. Create a GitHub App with repository contents read & write and account email read.
  2. Each service in packages needs to be deployed to Cloudflare workers.
  3. For the UI worker the following secrets/variables need to be set: BETTER_AUTH_SECRET, GITHUB_CLIENT_ID, GITHUB_CLIENT_SECRET, PUBLIC_GITHUB_APP_ID and PUBLIC_GITHUB_APP_SLUG.
  4. The preview worker needs PREVIEW_HOST as a variable set to the host of the preview worker and a wildcard route configured, see Cloudflare's guide

Credits

Heavily inspired by

If you would like to know more about why and how, I wrote down my thoughts in a blog post.

About

A collaborative content editor for markdown or static site generators without lock-in

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •