Skip to content

Commit 366a8cb

Browse files
committed
docs: update README
1 parent 2b4cb29 commit 366a8cb

File tree

1 file changed

+36
-1
lines changed

1 file changed

+36
-1
lines changed

README.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,42 @@ Supports PDF conversion via headless chromium.
99

1010
> To be added...
1111
12-
## Usage
12+
## Examples
13+
14+
Convert `doc.md` to `doc.html`
15+
```bash
16+
marky doc.md
17+
```
18+
19+
Convert to PDF
20+
```bash
21+
marky doc.md --pdf
22+
```
23+
24+
Start a live file watcher (will recompile your document on each save)
25+
```bash
26+
marky doc.md --watch
27+
```
28+
29+
Enable extensions
30+
```bash
31+
# Or use --all to enable all
32+
marky doc.md --math --diagrams --highlight
33+
```
34+
35+
Select and use a different theme with fzf
36+
```bash
37+
marky doc.md --theme (marky --list-themes | fzf)
38+
```
39+
40+
Pipe from stdout and open compiled file
41+
```bash
42+
cat doc.md | marky --out doc.html --open
43+
```
44+
45+
> See `--help` for more info
46+
47+
## Help
1348

1449
```
1550
Markdown to HTML converter with beautiful themes

0 commit comments

Comments
 (0)