Skip to content
DeityhubPublic

About

An open-source, local-first Markdown editor with a faithful live preview and a portability checker for GitHub, dev.to and Obsidian.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

225 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mdstudio logo

mdstudio

Write Markdown once. See exactly how it renders everywhere.
An open-source, local-first Markdown editor with a faithful live preview and a portability checker for GitHub, blogging platforms and Obsidian.

CI License: MIT Live app

mdstudio: Markdown editor with live preview and a portability report

Why mdstudio

Most Markdown editors render your text their own way. A post can look right in the editor and break where you publish it: raw HTML gets stripped, a local image path points nowhere, [[wiki-links]] print literally, math and diagrams don't render.

mdstudio keeps your raw Markdown as the single source of truth. The preview shows what the platform you picked will render, with no preview-only tricks (no synthetic line breaks, no smart quotes), and a checker flags every spot that will look different, with a click to jump to it.

Features

  • Faithful live preview. Strict CommonMark and GitHub Flavored Markdown, sanitized, with syntax-highlighted code. Scrolling stays aligned line by line, and clicking a block in the preview puts the editor cursor on its source line.
  • Portability checker. Raw HTML, local images and links, base64 images, wiki-links, ==highlights==, math, Mermaid, trailing-space line breaks, missing alt text, unclosed tags and more. Every issue is clickable. Turn rules on or off, add publication standards (title and description length, required front matter, heading structure) and your own text or regex rules, and share them as a JSON file.
  • Target profiles. Strict CommonMark, GFM extended, GFM without HTML, and Wiki notes. The preview, the checks and the toolbar warnings follow your choice.
  • Edit together. Invite people by email and edit one draft at the same time, online or offline: live cursors, per-person undo, and offline edits merge when the network returns (Yjs). Up to 3 people per draft by default.
  • Review links. Share an expiring read-only copy (1 to 7 days), public or for named people only. Signed-in readers comment on the words they select, and you resolve the comments from the editor.
  • Publish to GitHub. Commit or open a pull request to a repository, or post a gist, with the images committed beside the file.
  • Complete formatting toolbar. Marks, headings, lists, task lists, links, images, footnotes, rules, code blocks, tables with cell navigation, GitHub alerts, math, diagrams and HTML helpers. Fully keyboard accessible.
  • Math and diagrams. KaTeX and Mermaid, rendered on demand, themed for light and dark.
  • Local-first. Drafts autosave to your browser's IndexedDB and everything works offline with no account. Anything that leaves your device (cloud drafts, share links, publishing) is a choice you make per draft.
  • A library that scales. Search every draft and the words inside them, filter by tag, organise drafts in folders (drag and drop), and rename them without touching the text. One search (Ctrl/⌘ K) also finds commands, settings and pages.
  • Version history. Versions are kept automatically as you write; compare any of them side by side with the current draft and restore it.
  • Works offline. The studio keeps working with no connection and can be installed as an app.
  • Import and export. Open .md files, a ZIP or a whole folder, or paste from Google Docs, Notion and the web. Export clean UTF-8 Markdown (LF endings), self-contained Markdown with embedded images, standalone HTML, or every draft at once as a ZIP.
  • AI on your own key. A writer for titles, descriptions and drafts, inline actions on the selection (rewrite, shorten, translate, proofread), and Fix with AI on a flagged check, always shown as a diff you accept or reject. OpenAI, Anthropic, Gemini, Ollama or any OpenAI-compatible endpoint. Keys stay in session memory and requests go straight from your browser to the provider.
  • Responsive and themed. Split view on desktop, single pane with drawers on phones, light and dark mode.
  • Self-hostable. One Docker container with SQLite, or Cloudflare Workers (D1, R2 and Durable Objects). The hosted site is the same code. An admin dashboard manages accounts, plans, limits and server settings.
  • Guides. Practical guides on portable Markdown, reviewing, writing together and publishing, written in Markdown and rendered by mdstudio itself.

The drafts library with search, tags and folders Comparing a saved version with the current draft

A shared page with comments beside the words they are about Publishing a draft to a GitHub repository

Settings: the AI tab listing its integrations The search palette finding a command and a guide

mdstudio in dark mode mdstudio on a phone

Quick start

Use it now at mdstudio.deityhub.com, or run it yourself.

Run locally

Requires Bun 1.3 or newer.

git clone git@github.com:Deityhub/mdstudio.git
cd mdstudio
bun install
bun run dev

Open http://localhost:8080.

Self-host with Docker

docker compose -f infra/docker-compose.yml up -d

The app is served on http://localhost:3000 with data in the mdstudio-data volume. GET /api/health is the liveness probe. Each release also publishes multi-arch images to ghcr.io/deityhub/mdstudio and deityhub/mdstudio on Docker Hub.

Target profiles

Profile Use it for Notes
GFM extended READMEs, issues, docs Tables, task lists, footnotes, alerts, math, Mermaid
Strict CommonMark Anything that must work everywhere Flags every GFM extension
GFM without HTML Blog posts GFM; raw HTML is an error
Wiki notes Notes with wiki-links, highlights GFM extended plus highlights and wiki-links

How it works

  • Engine. unified: remark-parse, GFM, front matter, math, remark-rehype, rehype-sanitize, then highlighting. The output is always sanitized. All Markdown logic lives in src/lib/markdown/markdown.ts.
  • Editor. CodeMirror 6, loaded only in the browser. Editing commands are pure functions with their own tests.
  • Storage. Raw IndexedDB behind a small documentStore interface.
  • Security. Nonce-based Content-Security-Policy in production, a sanitized preview, and no server in the writing path unless you choose a cloud feature.
  • Stack. TanStack Start, React 19, Vite, Tailwind CSS v4, Radix UI.
  • Backend. One Drizzle SQLite schema shared by Cloudflare D1 and better-sqlite3, with R2 or disk storage, cookie sessions, a WebSocket channel on Durable Objects (in process when self-hosted) and a Yjs room per live draft. See infra/.

Development

Command What it does
bun run dev Dev server on port 8080
bun run build Production build (Cloudflare Workers preset)
bun run lint / bun run typecheck ESLint and TypeScript
bun run test Unit and component tests (Vitest)
bun run e2e Builds the self-hosted output and runs Playwright
bun run licenses Audits dependency licenses against the policy
bun run screenshots Regenerates the UI screenshots in docs/ui-screenshots
bun run brand Regenerates the icons and social card
bun run llms Regenerates public/llms.txt from the site copy

Read CONTRIBUTING.md before opening a pull request: branch from dev, write the test first, and use Conventional Commits.

Documentation

Document Contents
docs/SYSTEM_SPEC.md Source of truth: product and use cases, architecture, schema, API, decisions
docs/UI_SPEC.md and docs/DESIGN_SYSTEM.md Every screen, and the design tokens and conventions
docs/RELEASING.md Cutting a release and the required secrets
infra/README.md The backend blueprints and how to run them

Roadmap

What is planned and what is not built yet is in the system spec, and what is released is in the changelog.

Contributing, security and license

Created by Chizoba Jude Ojini.

About

An open-source, local-first Markdown editor with a faithful live preview and a portability checker for GitHub, dev.to and Obsidian.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Sponsor this project

Packages

Contributors

Languages