Mercurial > repos > public > wdown
annotate README.md @ 13:78282df000f2
Add readme file
| author | Jonatan Werpers <jonatan@werpers.com> |
|---|---|
| date | Mon, 22 Jun 2020 07:55:14 +0200 |
| parents | |
| children | d8199e07d089 |
| rev | line source |
|---|---|
| 13 | 1 # Building |
| 2 The `wdown` command is built using the `go` tool. | |
| 3 ```bash | |
| 4 go build | |
| 5 ``` | |
| 6 | |
| 7 # Usage | |
| 8 Once the executable has been built it can be used to convert a markdown document to html. | |
| 9 | |
| 10 ```bash | |
| 11 ./wdown test.md | |
| 12 ``` | |
| 13 This will write the html to `stdout`. If you want a `.html` file you can do | |
| 14 | |
| 15 ```bash | |
| 16 ./wdown test.md > test.html | |
| 17 ``` | |
| 18 | |
| 19 To use a tmeplate to wrap the produced html you can do | |
| 20 ```bash | |
| 21 ./wdown -tmpl test.tmpl test.md > test.htm | |
| 22 ``` |