Skip to content

DavidAlphaFox/markamd

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

157 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

marka.md app icon

marka.md

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

site release downloads stars macos mit notarized

a native macos markdown editor specialized for ai context management. live editor on the left (codemirror 6), rendered preview on the right (markdown-it + shiki + mermaid). minimal chrome, full catppuccin + matcha themes, macos vibrancy, orange octopus mascot. ~10 mb bundle.

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

works with claude, chatgpt, gemini, your local agent β€” anywhere that reads plain markdown.

features

  • live preview β€” debounced ~50 ms render with code blocks (shiki) and mermaid diagrams
  • 5 themes β€” catppuccin latte / frappΓ© / macchiato / mocha + matcha (washi paper + kelly green) + system auto-switch
  • reading mode β€” ⌘. flips to distraction-free preview-only with iA-style typography
  • command palette β€” ⌘k, fuzzy-searchable, grouped by category
  • find / replace β€” ⌘f opens a themed codemirror search panel
  • folder sidebar β€” load a folder of .md, fuzzy-search across the tree, click to load
  • share to ai β€” βŒ˜β‡§c copies the current markdown to your clipboard, paste anywhere
  • export to pdf β€” ⌘p renders preview-styled html, opens system print dialog
  • macos vibrancy with opt-in transparency
  • auto-save off by default β€” ⌘s commits. trust your fingers, not background daemons.
  • fully keyboard-driven β€” every command has a shortcut, palette covers the rest

install

download the latest release β†’

macOS (apple silicon, notarized)

grab marka.md.dmg β†’ drag marka.md.app into /Applications β†’ open.

Windows (10+, x64)

grab marka.md_*-setup.exe β†’ run.

Windows SmartScreen may show "Windows protected your PC". Click More info β†’ Run anyway. marka.md is free + MIT β€” we don't sign Windows builds (paid certs aren't worth it for a free OSS project). Full source is right here if you'd rather build it yourself.

Linux (x86_64)

three flavors, pick what fits your distro:

  • AppImage (works anywhere): chmod +x marka.md_*.AppImage β†’ run. self-contained, no install step needed.
  • .deb (Debian / Ubuntu / Mint / Pop!_OS): sudo dpkg -i marka.md_*_amd64.deb
  • .rpm (Fedora / RHEL / Rocky / openSUSE): sudo dnf install marka.md-*.x86_64.rpm

no signing required on Linux β€” it's the freedom platform 🐧

from source

requires bun (or npm), rust toolchain. on macOS: xcode command line tools. on Windows: MSVC build tools (Visual Studio installer β†’ "Desktop development with C++"). on Linux: libwebkit2gtk-4.1-dev libsoup-3.0-dev + friends.

bun install
bun run tauri dev      # native window with hmr
bun run tauri build    # produces .dmg (macOS) / -setup.exe (Windows) under src-tauri/target/release/bundle/

keyboard

key does
⌘K command palette
⌘O open a .md file
βŒ˜β‡§O open a folder of notes
⌘N new untitled buffer
⌘S save (manual β€” no autosave)
⌘B toggle sidebar
⌘. toggle reading mode
⌘F find / replace in editor
⌘G find next match
βŒ˜β‡§C copy markdown to clipboard
⌘P export to pdf
βŒƒβŒ˜F toggle fullscreen
⌘/ help overlay
esc close any popup

stack

layer choice
shell tauri 2 (rust + webview), apple silicon target
frontend react 19 Β· vite 7 Β· typescript 5.8 Β· bun
editor codemirror 6 + @codemirror/lang-markdown + @codemirror/search
markdown markdown-it + shiki + mermaid
icons lucide-react
styling css variables, no framework

project structure

src/
β”œβ”€β”€ app.tsx                       # shell β€” state + layout
β”œβ”€β”€ main.tsx                      # react entry
β”œβ”€β”€ app.css                       # @imports + shell grid
β”œβ”€β”€ components/
β”‚   β”œβ”€β”€ primitives/               # button, icon, popover, overlay, kbd, tooltip
β”‚   β”œβ”€β”€ chrome/                   # title-bar, breadcrumb, status-bar, logo
β”‚   β”œβ”€β”€ editor/                   # editor, preview, splitter
β”‚   β”œβ”€β”€ files/                    # sidebar, file-tree
β”‚   β”œβ”€β”€ overlays/                 # palette, help, about, welcome, toast, drop
β”‚   └── features/                 # top-level barrel
β”œβ”€β”€ hooks/                        # debounced, persisted-state, shortcuts, sync-scroll
β”œβ”€β”€ lib/                          # markdown, theme, files, storage, commands, demo
β”œβ”€β”€ styles/                       # tokens, globals + per-domain css
└── assets/mascot/                # in-app sprites
src-tauri/
β”œβ”€β”€ src/lib.rs                    # rust entry + vibrancy + finder open-with
β”œβ”€β”€ tauri.conf.json               # overlay title bar + bundle config
β”œβ”€β”€ capabilities/default.json     # fs + opener + dialog scopes
└── Cargo.toml
docs/
└── auto-update.md                # tauri updater wiring plan (post-notarization)
.github/workflows/release.yml     # tauri-action; auto-skips signing if no certs

every folder exports its public api via index.ts. path alias @/* resolves to src/*.

roadmap

shipped (v1.0):

  • branded shell + mascot + welcome flow
  • codemirror editor + live preview + resizable splitter + scroll sync (counter-based echo prevention)
  • 5 themes (catppuccin family + matcha) + transparency
  • code blocks: copy-on-hover + shiki highlighting
  • mermaid diagrams
  • ide-style sidebar β€” drag-to-move files/folders, right-click rename / new folder, ⌘βŒ₯Z undo
  • ⌘K command palette grouped by category + ⌘/ help overlay
  • reading mode (⌘.) with iA-style typography
  • find / replace (⌘F + ⌘G)
  • export to pdf (⌘P) with hardened print css
  • about overlay (version + mit + github + author)
  • apple-style toast (bottom-center, glass blur, auto-dismiss for info)
  • title-bar window-drag + tooltip viewport clamping
  • notarized macOS build signed with Apple Developer ID
  • auto-updater via tauri-plugin-updater + minisign-signed bundles
  • /changelog page on landing (fetched from gh releases)

planned (v1.x):

  • "context tray" β€” multi-file bundling, ⌘-click to stage, copy as one prompt blob
  • session restore β€” remember last folder + open file + scroll position
  • faq section on landing
  • windows + linux builds
  • intel mac support (currently apple silicon only)

privacy

local-first. nothing ever leaves your machine. no telemetry, no analytics, no accounts, no cloud sync. your .md files stay on disk. clipboard transfers happen only when you press βŒ˜β‡§C β€” and then they're yours, going wherever you paste them.

license

mit Β· matt enarle (@mattenarle10)

About

πŸ™ local markdown, live markdown editor + live preview built with tauri + react.

Resources

License

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • TypeScript 72.6%
  • CSS 25.9%
  • Rust 1.1%
  • Other 0.4%