Skip to content
 
 

Repository files navigation

marka.md app icon

marka.md

a local markdown editor for the notes you share with ai.

site fork release upstream release stars open collective macos windows linux mit fork build unsigned

a cross-platform (macOS · Windows · Linux) markdown editor specialized for ai context management. live editor, rendered preview, file tabs, csv preview, grouped themes, smarter command palette, and a context tray for staging multiple notes into one AI-ready bundle.

built around one loop: collect notes → write → share with ai. nothing leaves your machine until you copy.

works with claude, chatgpt, gemini, local agents, and anything that reads plain markdown.

about this fork

this is Sasha Merzliakov's fork of mattenarle10/markamd — all credit for the app itself to Matt Enarle.

built openly with AI assistance (Claude) — i find the problems, direct the work, and verify the results in daily use; the AI does the heavy lifting on implementation, root-cause tracing, and tests. commit trailers carry the co-author tag.

the custom branch adds, on top of upstream:

  • text-first file handling — media formats and opaque binaries are enumerated; everything else opens straight in the editor. no extension allowlist to fall off the end of, so .tf, .nix, .tex, Makefile, Dockerfile and friends all just work. a NUL-byte sniff refuses actual binaries with a reason instead of opening them as mojibake
  • live update — every open tab tracks its file on disk, not just the focused one. an agent rewriting a file you're reading updates it in place, cursor and scroll position intact
  • files open as tabs, not modals — images (incl. heic / avif / tiff), PDFs, video and audio render in a tab; the file you were working on stays open behind it. office formats and archives get a launcher card
  • ⌘E — show me the editable form — cycles panes on markdown / html / csv, flips a rendered svg to its source and back
  • editable html with live preview — edit left, rendered pane right, like markdown
  • dotenv files are visible.env and .env.* show in the explorer and open like any other text file
  • folder favourites — star a folder, click it to open as a workspace root
  • app-wide zoom — ⌘= / ⌘+ / ⌘- / ⌘0, persisted (merged upstream in #123)
  • perf: non-scanning folder watchers — fixes a startup / add-folder freeze on large folders (merged upstream in #122)

details and the fork workflow live in CUSTOM.md. generalisable pieces get PRed upstream; the personal ones stay here.

getting this build: the release badges and the install link below point at upstream's releases — downloading those gives you Matt's app, not this fork. to get the features listed above, build from source:

git clone https://github.com/sashamerzliakov/markamd.git
cd markamd && bun install
scripts/local/build-install.sh   # macOS — builds and copies to /Applications

the build script disables updater artifacts (they need upstream's signing key), so this build won't auto-update. decline any in-app update prompt — it would replace the fork with upstream's binary.

what you get

area details
writing live preview, shiki highlighting, mermaid diagrams, media previews, task lists, mark/strike syntax, reading mode, editor-only mode, opt-in vim
ai context stage sidebar files, see file/token counts, copy one AI-ready bundle with relative paths
files tabs, folder sidebar, favorites, search, drag-to-move, undo file ops, copy paths, reveal in file manager, useful dot-tool folders
data + export capped CSV preview, rendered code copy buttons, mermaid-aware PDF export, stable print margins
desktop polish grouped themes, transparency controls, platform-aware shortcuts, session restore, external file watching, signed updates

install

this fork builds for macOS (apple silicon) only. upstream ships Windows, Linux and intel mac — if you want those, get them from mattenarle10/markamd and note you'll be running the original app, without the fork features listed above.

download the latest fork release →

macOS (apple silicon)

grab marka.md.dmg → drag marka.md.app into /Applications → open.

first launch is unsigned, so macOS will block it: right-click the app → Open, then confirm. or xattr -dr com.apple.quarantine /Applications/marka.md.app.

no auto-update. the in-app updater is disabled in this build — it needs upstream's signing key, and pointing it at upstream's manifest would replace this fork with the original app. decline any update prompt. to update, pull and rebuild, or grab the next release here.

not on homebrew. brew install --cask mattenarle10/tap/marka-md installs upstream's build, not this one.

from source

requires bun, rust, and platform build tools. on Linux, install libwebkit2gtk-4.1-dev libsoup-3.0-dev and related Tauri deps.

bun install
bun run tauri dev      # native window with hmr
bun run tauri build    # produces .dmg / .exe / .AppImage / .deb / .rpm under src-tauri/target/release/bundle/

keyboard

shortcuts shown with macOS modifiers below. on Windows / Linux, substitute Ctrl, Alt, Shift.

key does
⌘K command palette
⌘O open a .md file
⌘⇧O open a folder of notes
⌘N new untitled buffer
⌘T new untitled tab
⌘S save
⌘⇧S save as (also handles untitled buffers)
⌘B toggle sidebar
⌘1…9 switch to tab 1 through 9
⌘. toggle reading mode (preview only)
⌘⇧. toggle editor-only mode (preview hidden)
⌘F find / replace in editor · or find in reading mode
⌘G find next match
⌘⌥Z undo last sidebar file op (move / rename / new / delete)
⌘⇧C copy markdown to clipboard
command palette → copy context bundle copy the staged context bundle
⌘P export to pdf (also visible in the top file-action row)
⌃⌘F toggle fullscreen (macOS) · F11 on Windows/Linux
⌘/ help overlay
esc close any popup

stack

layer choice
shell tauri 2.11 (rust + webview), macOS universal (arm64 + x86_64) · Windows · Linux
frontend react 19 · vite 7 · typescript 5.9 · bun
editor codemirror 6 + @codemirror/lang-markdown + @codemirror/search · opt-in vim via @replit/codemirror-vim
markdown markdown-it + markdown-it-mark + markdown-it-task-lists + shiki (lazy themes + langs) + mermaid (lazy)
icons lucide-react
styling css variables, no framework

roadmap

Per-release detail lives on the changelog.

  • v1.5 core loop: context tray, file tabs, CSV preview, grouped themes, interface languages, PDF/export polish, file workflow improvements, preview link handling, and scroll memory
  • v1.5.12 polish: smoother preview scrolling, cleaner sidebar, refreshed demo doc, quickstart tutorial updates, and smarter command palette search
  • v1.5.18 polish: playable media previews and faster tab shortcuts
  • v1.6.0 workflow: separate preview windows, command-palette markdown insertions, and Traditional Chinese localization
  • v1.6.1 workflow: automatic folder monitoring, native file watching, and lazy markdown highlighting
  • next: native/silent PDF generation
  • next: context handoff presets for bring-your-own-ai workflows, starting with markdown and XML-tag bundle formats

Release work follows the release checklist, including the post-release site refresh check.

contributors

Thanks to everyone helping shape marka.md through PRs, issues, testing, and feedback.

marka.md contributors

Small, focused PRs are easiest to review and ship. Good places to help:

  • bug fixes from the issue tracker
  • platform polish for Windows, Linux, and Intel macOS
  • markdown, mermaid, PDF, and translation edge cases
  • small UX improvements with screenshots or short screen recordings

Before opening a PR:

  • keep one behavior change per PR when possible
  • include screenshots for UI changes
  • update help/about/readme copy when the user-facing surface changes
  • run bun test, bun run build, and cargo check --release from src-tauri

privacy

local-first. no telemetry, no accounts, no cloud sync. your .md files stay on disk, and clipboard transfers happen only when you copy.

see the full privacy notice for the website analytics caveat (vercel speed insights, cookieless).

feedback

ideas, bugs, or just want to say hi?

support

marka.md is free + MIT. if it saves you time, star the repo, share it with another dev, or support ongoing development through Open Collective.

license

mit · matt enarle (@mattenarle10)

About

local-first markdown editor with live preview, reading mode, diagrams, themes, and context bundles.

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages