markdown-peek
| Crates.io | markdown-peek |
| lib.rs | markdown-peek |
| version | 0.1.6 |
| created_at | 2025-12-28 05:05:53.601233+00 |
| updated_at | 2026-01-06 13:09:34.448529+00 |
| description | Markdown previewer in browser and terminal |
| homepage | |
| repository | https://github.com/takeshid/markdown-peek |
| max_upload_size | |
| id | 2008251 |
| size | 2,902,811 |
tkcd (takeshiD)
documentation
README
Markdown Peek
Markdown Peek (mdpeek) is a lightweight CLI tool that watches a markdown file and renders it either in your browser (live preview) or directly in the terminal.
Features
- ⚡ Fast
- 🔄 Live Reload
- ⚙️ Easy Configure
- 🌐🖥️ Preview in Browser or in Terminal
- 📝 Supported Github Flavored Markdown(GFM), GitLab Flavored Markdown(GLFM)
Quick start
Preview on your browser
mdpeek detects README.md on default and previews markdown on browser.
mdpeek
INFO mdpeek::watcher: Watching: "README.md"
INFO mdpeek::server: Listening on http://127.0.0.1:3000NFO mdpeek::watcher Watching: "README.md"
Preview on your terminal
mdpeek detects README.md on default.
If you want preview on termianl, using term subcommand.
mdpeek term
Installation
cargo
cargo install markdown-peek
nix(Planed)
nix-shell -p markdown-peek --command mdpeek
npm(Planed)
npm install -g markdown-peek
download prebuild-binary
curl -SL https://github.com/takeshid/markdown-peek
Status
GFM
- Table
- TaskList
- Strike throough
- Fenced Code
- Syntax Hightlight
- Emoji
- Alert
- MathJax
- Color Model
- Auto Link
- InPage Link
- Footnote
- Table of Contents
- Theme Switch(Light/Dark)
GLFM(Planed)
- Table
- Strike throough
- TaskList
- Fence Code
- Syntax Hightlight
- Auto Link
- Emoji
- Alert
- Math equation
Terminal
- Table
- TaskList
- Strike throough
- Fenced Code
- Syntax Hightlight
- Emoji
- Alert
- Math Equation
- Color Model
- Footnote
License
MIT License. See LICENSE.