mirror of
https://github.com/simonmichael/hledger.git
synced 2024-09-20 02:37:12 +03:00
update doc/README
This commit is contained in:
parent
c18a75ecfe
commit
85d19836f6
17
doc/README
17
doc/README
@ -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):
|
||||
|
Loading…
Reference in New Issue
Block a user