Skip to content

Commit 2bfe0c7

Browse files
committed
docs: better README structure
1 parent 2696768 commit 2bfe0c7

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,12 @@ for code syntax highlighting, LaTeX and Mermaid diagrams.
55

66
Supports PDF conversion via headless chromium.
77

8-
## Screenshots
9-
10-
> To be added...
8+
<!--toc:start-->
9+
- [Examples](#examples)
10+
- [Install](#install)
11+
- [Help](#help)
12+
- [Build](#build)
13+
<!--toc:end-->
1114

1215
## Examples
1316

@@ -44,11 +47,17 @@ cat doc.md | marky --out doc.html --open
4447

4548
> See `--help` for more info
4649
47-
## Help
50+
## Install
51+
52+
Install using [cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html)
4853

54+
```bash
55+
cargo install marky
4956
```
50-
Markdown to HTML converter with beautiful themes
5157

58+
## Help
59+
60+
```
5261
Usage: marky [OPTIONS] [PATH]
5362
5463
Arguments:
@@ -57,7 +66,6 @@ Arguments:
5766
Options:
5867
--completion <GENERATOR> [possible values: bash, elvish, fish, powershell, zsh]
5968
-t, --theme <THEME> Theme to use
60-
--stdin Read input from stdin
6169
--string <STRING> Read input from string
6270
-l, --list-themes List available themes
6371
--where-config Print config path
@@ -74,12 +82,6 @@ Options:
7482
-V, --version Print version
7583
```
7684

77-
## Install
78-
79-
```bash
80-
cargo install marky
81-
```
82-
8385
## Build
8486

8587
```bash

0 commit comments

Comments
 (0)