A deployable markdown editor that connects with your self hosted files and lets you edit in a beautiful interface
0
fork

Configure Feed

Select the types of activity you want to include in your feed.

Go 80.1%
TypeScript 7.9%
CSS 5.6%
JavaScript 2.9%
Makefile 2.1%
Astro 1.4%
7 1 0

Clone this repository

https://tangled.org/usaa.ma/markedit https://tangled.org/did:plc:d362ytwol467iybrp3a7evxx/markedit
git@tangled.org:usaa.ma/markedit git@tangled.org:did:plc:d362ytwol467iybrp3a7evxx/markedit

For self-hosted knots, clone URLs may differ based on your setup.

Download tar.gz
README.md

MarkEdit#

A markdown editor for managing blog posts across multiple storage providers (GitHub, Google Drive, Dropbox). Built with Go and Astro/React, featuring WYSIWYG editing powered by TipTap.

Features#

  • Multi-source Support: Connect to GitHub repositories (Google Drive and Dropbox coming later)
  • WYSIWYG Editing: TipTap-based markdown editor with live preview
  • Git Workflow: Automatic branch management, commits, and pull requests
  • Self-hosted: Run anywhere with Docker
  • Lightweight: Single binary deployment

Quick Start#

Prerequisites#

  • Go 1.21+
  • Node.js 18+
  • Docker (optional, for containerized deployment)
  • GitHub OAuth App credentials

Development Setup#

  1. Create GitHub OAuth App

  2. Configure Environment

    cp .env.example .env
    # Edit .env with your GitHub OAuth credentials
    
  3. Run Backend

    cd backend
    go mod download
    go run cmd/server/main.go
    
  4. Run Frontend

    cd frontend
    npm install
    npm run dev
    
  5. Access Application

    • Open http://localhost:3000
    • Login with GitHub
    • Start editing!

Docker Deployment#

docker-compose up --build

Access at http://localhost:3000

Architecture#

  • Backend: Go with Chi router, GitHub OAuth, go-git for version control
  • Frontend: Astro (client-only) + React + TipTap editor
  • Database: SQLite for session and state management
  • Deployment: Single Docker container

Project Status#

Currently in initial development phase. See IMPLEMENTATION_PLAN.md for detailed roadmap.

MVP Scope#

  • ✅ GitHub authentication
  • ✅ Repository and file browsing
  • ✅ Markdown editing with TipTap
  • ✅ Automatic branch management
  • ✅ Commit and PR creation
  • ❌ Image uploads (links only initially)
  • ❌ Search, version history, collaborative editing (post-MVP)

Documentation#

Contributing#

This project will be open-sourced once MVP is complete. Stay tuned!

License#

TBD