mdopen
| Crates.io | mdopen |
| lib.rs | mdopen |
| version | 0.5.0 |
| created_at | 2024-03-10 12:48:52.714842+00 |
| updated_at | 2025-03-07 17:28:20.41584+00 |
| description | Preview markdown files in a browser |
| homepage | |
| repository | https://github.com/immanelg/mdopen |
| max_upload_size | |
| id | 1168670 |
| size | 112,387 |
(immanelg)
documentation
README
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.