Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 1.21 KB

README.md

File metadata and controls

42 lines (28 loc) · 1.21 KB

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 in a browser.

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

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

Installation

Install from crates.io:

cargo install mdopen

or directly from this repo:

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

Usage

Start the server and README.md in your favourite browser:

mdopen README.md --browser firefox 

Acknowledgements

grip is similar.