.png)
4 months ago
6
Locally preview how GitHub will render your Markdown files.
MEREAD is a command-line tool for previewing Markdown files as they will be presented on GitHub, all completely locally and offline.
I was surprised to find no simple tool that would allow me to preview Markdown files as they would be rendered on GitHub.
I wanted a tool that is:
- shipped as a single binary
- fast
- accurate to GitHub's rendering
- offline
There are other tools that get the job done, better or worse, but they all have some drawbacks that I wanted to avoid:
| grip | Python | Uses GitHub:s markdown API to render Markdown files, causing unnecessary usage of web requests. |
| gh markdown-preview | Go | Is meant to be used as extension in gh, GitHub's CLI. |
| markdown-preview.nvim | Typescript | Requires Neovim. |
For each version, prebuilt binaries are automatically built for Linux, MacOS and Windows.
-
You can download and unpack the latest release from the releases page.
-
Using cargo-binstall
-
Using ubi:
-
Using mise:
# `ubi` under the hood mise use -g ubi:sermuns/meread# `cargo-binstall` under the hood mise use -g cargo:meread
-
git clone https://github.com/sermuns/meread cd meread cargo install
