Mercurial > repos > public > wdown
changeset 13:78282df000f2
Add readme file
author | Jonatan Werpers <jonatan@werpers.com> |
---|---|
date | Mon, 22 Jun 2020 07:55:14 +0200 |
parents | bfffb69f55aa |
children | d8199e07d089 ebecd141e9d3 |
files | README.md |
diffstat | 1 files changed, 22 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.md Mon Jun 22 07:55:14 2020 +0200 @@ -0,0 +1,22 @@ +# Building +The `wdown` command is built using the `go` tool. +```bash +go build +``` + +# Usage +Once the executable has been built it can be used to convert a markdown document to html. + +```bash +./wdown test.md +``` +This will write the html to `stdout`. If you want a `.html` file you can do + +```bash +./wdown test.md > test.html +``` + +To use a tmeplate to wrap the produced html you can do +```bash +./wdown -tmpl test.tmpl test.md > test.htm +```