annotate README.md @ 16:c21a0e7b695f felix

Close before merge
author Jonatan Werpers <jonatan@werpers.com>
date Thu, 25 Jun 2020 21:17:58 +0200
parents d8199e07d089
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
13
78282df000f2 Add readme file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
1 # Building
78282df000f2 Add readme file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
2 The `wdown` command is built using the `go` tool.
78282df000f2 Add readme file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
3 ```bash
78282df000f2 Add readme file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
4 go build
78282df000f2 Add readme file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
5 ```
78282df000f2 Add readme file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
6
78282df000f2 Add readme file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
7 # Usage
78282df000f2 Add readme file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
8 Once the executable has been built it can be used to convert a markdown document to html.
78282df000f2 Add readme file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
9
78282df000f2 Add readme file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
10 ```bash
78282df000f2 Add readme file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
11 ./wdown test.md
78282df000f2 Add readme file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
12 ```
78282df000f2 Add readme file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
13 This will write the html to `stdout`. If you want a `.html` file you can do
78282df000f2 Add readme file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
14
78282df000f2 Add readme file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
15 ```bash
78282df000f2 Add readme file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
16 ./wdown test.md > test.html
78282df000f2 Add readme file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
17 ```
78282df000f2 Add readme file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
18
14
d8199e07d089 Fix typos in Readme
FWerpers
parents: 13
diff changeset
19 To use a template to wrap the produced html you can do
13
78282df000f2 Add readme file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
20 ```bash
14
d8199e07d089 Fix typos in Readme
FWerpers
parents: 13
diff changeset
21 ./wdown -tmpl test.tmpl test.md > test.html
13
78282df000f2 Add readme file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
22 ```