slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update doc/README

Browse Source
This commit is contained in:
Simon Michael 2017-12-06 18:54:05 -08:00
parent c18a75ecfe
commit 85d19836f6
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/README
View File

@ -45,12 +45,17 @@ such as m4:
$ ./Shake manuals
Then render the website. This copies the manuals' markdown files into
the website, edits them for web display, concatenates them to form the
one-page manual, and runs hakyll-std (a generic hakyll script, included)
to render everything as html and add site header/footer,
tables of contents, etc.:
The text/man/info manuals are embedded in the hledger executable, so a
rebuild of that now will pick up the latest manuals:
$ stack build hledger
The website uses the markdown manuals. This copies them into the
website, edits them for web display, concatenates them to form the
one-page manual, and runs hakyll-std (a generic hakyll script,
included) which adds tables of contents and renders everything as html
with the site header/footer.
$ ./Shake website
View the rendered website ("open" is mac-specific; use your equivalent):