bromd

A console markdown viewer. bromd . starts an http server on localhost, renders .md to HTML and opens the browser. It reads rather than edits: a single static binary with no system dependencies, fully offline, and it never leaves a file in the directory it shows.

The name is browser + markdown.

Status

Early development, nothing released yet. The binary currently does nothing useful - the sections below describe what the first release is being built to do, not what already works.

Planned for v0.1

• start on a directory or on a file (its directory becomes the root, the file the start page)
• GFM rendering, inline data:image illustrations, a built-in theme, a custom stylesheet through the config; syntax highlighting comes after the release
• watch and live-reload of open pages
• relative and ~ links resolved to a canonical URL, broken targets marked in place
• directory index by a priority list (index.md, README.md), falling back to a listing
• navigation past the starting root through grants: block, confirm or auto
• plaintext view of the text files documentation links to, such as LICENSE or a config
• configuration in ~/.config with flags on top, where a flag always wins over a key; nothing is ever written into the browsed directory
• safe defaults: bind to 127.0.0.1, Host validation, inline HTML sanitised with a visible warning (viewed content is untrusted), a narrow allowlist of what gets served

Non-goals

• an editor: no text editing from the browser
• a wiki, a static site generator or a hosting tool
• vaults, graphs, plugins
• network access of any kind: localhost only, no authentication
• a terminal UI

License

Dual-licensed under either MIT or Apache-2.0, at your option.