mdopen

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.