marky 0.4.0

Markdown to HTML/PDF converter with pretty themes
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

# Marky

Converts Markdown documents into themed HTML pages with support
for code syntax highlighting, LaTeX and Mermaid diagrams.

Supports PDF conversion via headless chromium.

<!--toc:start-->
- [Examples](#examples)
- [Install](#install)
- [Help](#help)
- [Build](#build)
<!--toc:end-->

## Examples

Convert `doc.md` to `doc.html`
```bash
marky doc.md
```

Convert to PDF
```bash
marky doc.md --pdf
```

Start a live file watcher (will recompile your document on each save)
```bash
marky doc.md --watch
```

Enable extensions
```bash
# Or use --all to enable all
marky doc.md --math --diagrams --highlight
```

Select and use a different theme with fzf
```bash
marky doc.md --theme $(marky --list-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

```
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
  -l, --list-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                   Enable file watcher
  -O, --open                    Open output file in the default app
  -p, --pdf                     Saves document as PDF using headless chrome
  -h, --help                    Print help
  -V, --version                 Print version
```

## Build

```bash
cargo install --path .
```