localMD opens a folder of Markdown files in your browser. Browse the file tree, edit with syntax highlighting, and see the rendered result as you type. Changes save directly to disk, so your notes stay in the folders and Git repositories you already use.

Quick start

Requirements: Bun 1.3 or newer.

Run it without a global install:

bunx --bun @tamtamchik/localmd ./docs

Or install the command:

bun add --global @tamtamchik/localmd
localmd ./docs

Omit ./docs to serve the current directory. localMD opens your browser and prints the address:

  localMD • Local Markdown Editor

  Local    http://127.0.0.1:3000
  Folder   /path/to/docs

  Press Ctrl+C to stop

If port 3000 is busy, it selects the next available port. Run another command in a second terminal to edit a different folder alongside the first.

What it does

• Browse Markdown files in a nested folder tree.
• Switch between editor, split, and preview views with synchronized scrolling.
• Render GitHub-flavored Markdown, tables, task lists, and highlighted code blocks.
• Save automatically, or use the Save button and Cmd+S / Ctrl+S.
• Choose a light, dark, or system theme and restore your editor session on reload.
• Show the last Git change and authors for tracked files.
• Run multiple instances on separate local ports, with bundled editor assets.

Set defaults in localmd.toml, or start with the how-to guides for common workflows.

Development

bun install
bun run dev

Run the same checks as CI:

bun run check     # Biome, TypeScript, and tests
bun run lint      # Lint, formatting, and import checks
bun run lint:fix  # Apply safe fixes
bun run format   # Format TypeScript, JavaScript, and JSON

Biome uses two-space indentation, separates built-in, package, and local imports with blank lines, and uses separate import type declarations. Run bun run lint:fix to apply formatting and import organization together. Dependency resolution excludes versions published within the last 10 days. bun run dev enables development mode and restarts the server when source files change; ordinary launches keep bundler logs out of the terminal.

Pull requests, bug reports, and feature requests are welcome.

License

MIT