Skip to content

Repository files navigation

mkdn

A minimal, browser-based markdown editor. No accounts, no cloud — just write.

Try it live

Features

  • WYSIWYG editing powered by Milkdown (ProseMirror-based)
  • Local folder sync via the File System Access API — open, edit, and save files directly on disk
  • Version history with periodic snapshots, manual checkpoints, and restore
  • Keyboard shortcuts — Ctrl+S save, Ctrl+N new, Ctrl+O open, and more
  • Offline-first — everything runs in the browser, no server needed

Getting Started

npm install
npm run dev

Opens on localhost:3000.

Commands

Command Description
npm run dev Start dev server
npm run build Production build to dist/
npm run preview Preview production build

Tech Stack

  • Vite — build tool
  • Milkdown Crepe — WYSIWYG markdown editor
  • Vanilla JS — no framework, imperative DOM with a custom el() helper
  • IndexedDB — offline file cache and history snapshots
  • localStorage — user preferences

License

MIT

About

MKDN - A markdown web viewer/editor

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages