https://github.com/metafates/marky
🏭 Convert Markdown documents into themed HTML pages with support for code syntax highlighting, LaTeX and Mermaid diagrams.
https://github.com/metafates/marky
cli markdown markdown-to-html notes pdf rust
Last synced: about 1 year ago
JSON representation
🏭 Convert Markdown documents into themed HTML pages with support for code syntax highlighting, LaTeX and Mermaid diagrams.
- Host: GitHub
- URL: https://github.com/metafates/marky
- Owner: metafates
- Created: 2023-01-29T13:27:08.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-07-20T16:42:48.000Z (almost 3 years ago)
- Last Synced: 2025-03-28T03:01:41.828Z (about 1 year ago)
- Topics: cli, markdown, markdown-to-html, notes, pdf, rust
- Language: Rust
- Homepage: https://crates.io/crates/marky
- Size: 518 KB
- Stars: 29
- Watchers: 1
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Marky
Markdown Magician 🧙
**Features**
- Hot reload previewing 🔥
- Conversion to **HTML** 🏭
- Themes! ✨
- Extensions - Math, diagrams, syntax-highlighting 🧩
- Download base64 encoded images (png, jpg, svg)
- [Examples](#examples)
- [Install](#install)
- [Help](#help)
- [Build](#build)
- [Screenshots](#screenshots)
## Examples
Convert `doc.md` to `doc.html`
```bash
marky doc.md
```
Start a local preview server with hot-reload
```bash
marky doc.md --live
```
Enable extensions
```bash
# Or use --all to enable all
marky doc.md --math --diagrams --highlight
```
Include local images as base64 encoded and compress them (beta)
```bash
# possible values: local, remote, all
marky doc.md --include-images "local" --optimize-images
# or short
marky doc.md -zI local
```
Select and use a different theme with fzf
```bash
marky doc.md --theme $(marky --themes | fzf)
```
Pipe from stdout and open compiled file
```bash
cat doc.md | marky --out doc.html --open
```
> See `--help` for more info
## Install
Install using [cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html)
```bash
cargo install marky
```
## Help
```
Markdown Magician 🧙
Usage: marky [OPTIONS] [PATH]
Arguments:
[PATH] Read input from file
Options:
--completion
[possible values: bash, elvish, fish, powershell, zsh]
-t, --theme
Theme to use
--string
Read input from string
--themes
List available themes
--where-config
Print config path
-o, --out
Output file
--stdout
Output to stdout
-H, --highlight
Enable syntax highligting with highlight.js
-M, --math
Enable math rendering with KaTeX
-D, --diagrams
Enable UML diagrams rendering with Mermaid
-I, --include-images
Include images into file as base64 encoded [possible values: local, remote, all]
-z, --optimize-images
Optimize included images to make them smaller
-A, --all
Enable all extra renderers
-w, --watch
Recompile file on save
-l, --live
Live preview in the browser
--port
Port of the live server [default: 8080]
-O, --open
Open output file in the default app
-h, --help
Print help
-V, --version
Print version
```
## Build
```bash
git clone https://github.com/metafates/marky.git
cd marky
cargo install --path .
```
## Screenshots
Some examples...
```bash
marky README.md --theme sakura # default theme
```
```bash
marky README.md --theme air
```
```bash
marky README.md --theme retro
```
See `marky --themes` to show all available themes.
You can also add your own themes, but it's not documented yet... 😴