marky-0.5.1 is not a library.

Marky

Markdown Magician 🧙

Features

Hot reload previewing 🔥
Conversion to HTML / PDF 🏭
Themes! ✨
Extensions - Math, diagrams, syntax-highlighting 🧩

Note When converting to PDF it will automatically download a suitable headless chrome binary if one is not present on your system. Everything is automated!

Examples
Install
Help
Build
Screenshots

Examples

Convert doc.md to doc.html

marky doc.md

Convert to PDF

marky doc.md --pdf

Start a local preview server with hot-reload

marky doc.md --live

Enable extensions

# Or use --all to enable all
marky doc.md --math --diagrams --highlight

Select and use a different theme with fzf

marky doc.md --theme $(marky --themes | fzf)

Pipe from stdout and open compiled file

cat doc.md | marky --out doc.html --open

See --help for more info

Install

Install using cargo

cargo install marky

Help

Usage: marky [OPTIONS] [PATH]

Arguments:
  [PATH]  Read input from file

Options:
      --completion <GENERATOR>  [possible values: bash, elvish, fish, powershell, zsh]
  -t, --theme <THEME>           Theme to use
      --string <STRING>         Read input from string
      --themes                  List available themes
      --where-config            Print config path
  -o, --out <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
  -A, --all                     Enable all extra renderers
  -w, --watch                   Recompile file on save
  -l, --live                    Live preview in the browser
      --port <PORT>             Port of the live server [default: 8080]
  -O, --open                    Open output file in the default app
  -p, --pdf                     Saves document as PDF, will auto-download headless-chrome
  -h, --help                    Print help
  -V, --version                 Print version

Build

git clone https://github.com/metafates/marky.git
cd marky
cargo install --path .

Screenshots

Some examples...

marky README.md --theme sakura # default theme

sakura

marky README.md --theme air

air

marky README.md --theme retro

retro

See marky --themes to show all available themes.