localmd

A Bun-powered local Markdown editor with live preview and automatic saving.

Installation

Install the command globally:

bun add --global @tamtamchik/localmd

LocalMD requires Bun 1.3 or newer.

Usage

Run it without installing:

bunx --bun @tamtamchik/localmd [directory]

Or use the globally installed command:

localmd [directory]

The directory defaults to the current working directory. LocalMD opens a browser at http://localhost:3000 and lists every Markdown file below that directory.

Options:

-p, --port   Port to listen on (overrides localmd.toml)
-c, --config Path to localmd.toml
-h, --help   Show help

Configuration

Add localmd.toml to the directory you serve. Every setting is optional; omitted settings keep the defaults shown below:

[server]
port = 3000
open_browser = true

[ui]
theme = "light" # light, dark, or system
view = "split"  # editor, split, or preview

[editor]
autosave = true
autosave_delay_ms = 2000
line_numbers = true
line_wrapping = true

[preview]
gfm = true
breaks = true
syntax_highlighting = true

[files]
open_readme = true

The --port CLI option takes precedence over server.port. A theme selected with the toolbar button takes precedence over ui.theme in that browser.

To keep the config elsewhere, pass its path explicitly. Relative paths are resolved from the current working directory:

localmd ./docs --config ./configs/docs.toml

Development

bun install
bun run check

Dependency resolution excludes package versions published within the last 10 days.

Start the development server:

bun run dev

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT