#markdown #browser #common-mark #tiny-http

app mdopen

Preview markdown files in a browser

5 releases (breaking)

0.5.0 Mar 7, 2025
0.4.0 Apr 7, 2024
0.3.0 Mar 15, 2024
0.2.0 Mar 11, 2024
0.1.0 Mar 10, 2024

#625 in Text processing

32 downloads per month

BSD-3-Clause

30KB
474 lines

mdopen

github latest_version build_status dependency_status

Quickly preview local markdown files in browser with GitHub-like look.

Doesn't use GitHub API, but locally compiles markdown to HTML in Rust and renders it for a browser.

Supports most of the GitHub markdown features, including syntax highlighting and math formulas.

Has GitHub-like CSS including automatic dark/light colorschemes.

Supports hot-reload.

Installation

Install from main branch:

cargo install --git https://github.com/immanelg/mdopen.git

Install from crates.io:

cargo install mdopen

Usage

Start the server and open served README.md in Firefox:

mdopen --browser firefox README.md 

Run mdopen --help for more info.

Acknowledgements

grip is similar.

Dependencies

~7–15MB
~186K SLoC