SharkDown
SharkDown
Sign in
Open Source

Write Markdown like Notion.
Push to GitHub instantly.

SharkDown is a visual editor for GitHub documentation. Compose in a rich WYSIWYG editor, export pristine GitHub Flavored Markdown, and commit — all without leaving your browser.

Start Writing View on GitHub
shayen71421 / SharkDown
#

SharkDown

A visual-first, Markdown-native editor for developers, maintainers, and technical writers. Compose in a rich editor — push straight to GitHub as commits and pull requests.

✓Tables & checklists
✓Code blocks w/ syntax
✓Browse & edit repos
✓Commit & PR
# SharkDown
A visual-first, Markdown-native editor for developers.
- [x]Tables & checklists
- [x]Code blocks w/ syntax
- [x]Browse & edit repos
- [x]Commit & PR
Visual modeGFM compatible
Why SharkDown

Documentation shouldn't be this hard

The gap between writing and publishing is full of friction. SharkDown eliminates it.

The problem
  • Raw Markdown is painful to write and preview
  • Editing READMEs requires context-switching to the browser
  • AI-generated Markdown is messy and inconsistent
SharkDown
  • Visual WYSIWYG editor — no Markdown syntax needed
  • Commit directly to GitHub from the editor
  • Pristine GitHub Flavored Markdown export every time
Everything you need

A complete doc workflow

From blank page to merged PR — without leaving your editor.

Visual Editing

Write like Word. No Markdown syntax required.

  • Rich WYSIWYG powered by TipTap / ProseMirror
  • Headings, bold, italic, lists, tables, code blocks
  • Three modes: Visual, Split, and Raw Markdown

GitHub Integration

Edit any repo README without leaving the editor.

  • Browse repos, switch branches, edit README.md
  • Commit changes and create pull requests
  • OAuth 2.0 sign-in — token stored server-side

Smart Image Handling

Paste an image. It uploads and inserts automatically.

  • Drag-and-drop or paste images directly into the editor
  • Auto-uploads PNG, JPEG, WebP, and GIF to your repo
  • Markdown image syntax inserted automatically

Markdown Export Engine

Lossless round-trip. What you see is what you merge.

  • GitHub Flavored Markdown — tables, tasks, footnotes
  • Export .md files or copy to clipboard
  • Import any .md, edit visually, export clean diffs
Live preview

See it in action

A real SharkDown editor session. Write visually, see the raw Markdown side by side.

shayen71421 / SharkDown

Getting Started

SharkDown lets you write documentation visually. No Markdown knowledge required — just type, format, and push.

Quick start

  1. 1Sign in with GitHub
  2. 2Select a repository from your dashboard
  3. 3Edit your README visually — or start a new doc
  4. 4Commit with a message, or create a PR
# Getting Started
SharkDown lets you write documentation visually.
## Quick Start
1.Sign in with GitHub
2.Select a repository from your dashboard
3.Edit your README visually
4.Commit with a message, or create a PR
visual-editorgithub

Start building better documentation

Join developers who write docs visually, commit instantly, and ship to GitHub without the friction.

Start Writing View on GitHub