Skip to content

README.md

Latest commit

 

History

History
94 lines (65 loc) · 3.66 KB

README.md

File metadata and controls

94 lines (65 loc) · 3.66 KB
Raw
markbase logo

markbase

Browse, share, and discuss markdown files from GitHub.

Beautiful rendering. Expiring share links. Inline comments anchored to text.

Website · Features · Quick Start · MCP Server



CI License Deploy


Why

Your team writes docs in GitHub. But reading raw markdown on github.com is painful — no typography, no easy sharing, no way to leave comments on a paragraph.

Markbase connects to your GitHub repos and gives your markdown files a proper reading experience. Share a single file or an entire repo with expiring links. Leave inline comments that stay anchored to the text, like Google Docs.

Features

  • Markdown viewer — GFM, syntax highlighting, frontmatter, table of contents, task lists
  • File tree sidebar — Collapsible folders, active file highlight, comment count badges
  • Sharing — File, folder, or repo scope. Link-based with expiry, or share with specific GitHub users
  • Inline comments — Select any text, add a comment. Threaded replies, resolve/reopen, soft delete with undo
  • File history — Git commit log with inline diff viewer
  • Command palette — Cmd+K to search files, navigate, and take actions
  • Dark mode — Light, dark, and system themes with manual toggle
  • MCP server — Remote MCP tools for managing comments from Claude Code and other AI assistants

Quick Start

Production

Sign in at markbase.io with your GitHub account. Read-only access — your repos stay untouched.

Local Development

# 1. Install dependencies
pnpm install

# 2. Configure environment
cp .env.example .env.local
# Fill in values — see .env.example for docs

# 3. Start dev server
pnpm dev

# 4. Run database migrations
open http://localhost:3000/api/init-db

For local dev without OAuth, set AUTH_BYPASS=true and GITHUB_PAT in .env.local.

Tech Stack

MCP Server

Markbase exposes a remote MCP server for managing inline comments from AI tools.

claude mcp add --transport http markbase https://markbase.io/api/mcp

Tools: get_comments, add_comment, reply_to_comment, resolve_comment, bulk_resolve_comments, reply_and_resolve, unresolve_comment, delete_comment, list_files_with_comments

Testing

pnpm test:unit        # Vitest — 132 tests, 99%+ coverage
pnpm test:e2e         # Playwright — requires Docker + build

License

MIT