hledger/site/manual2.md
Simon Michael e1c9e51775 tools: new build system for man/web docs
Goal:

Generate man pages and web docs from one source.

Current plan:

The master docs for each package are now the pandoc-style
manpage-markdown files in the package directories -
hledger/hledger.1.md, hledger-lib/hledger_journal.5.md, etc.

Parts of these will be marked as web-only, and parts as man-only, using
divs recognisable by custom pandoc filters.

When generating man pages we strip the web-only parts, and all html
blocks, inline html and hyperlinks.

When generating web docs we strip the man-only parts and apply any other
tweaks needed for easy presentation, perhaps combining them into a
single web page similar to the old user manual.

Shake:

This was hard to do with GNU Make, and so I've introduced Shake, which
is working very well. Both coexist for now but it's probably time to
switch.
2016-02-21 02:21:41 -08:00

40 lines
755 B
Markdown

* toc
# hledger man pages
These are the main content of hledger's unix manual pages, cleaned
and converted back to web format.
The current plan is to reassemble them into something like the
original [user manual](manual.html), but we're not there yet.
<div class="container">
<div class="row">
<div class="col-md-4">
## Tools
### [hledger(1)](hledger.1.html)
### [hledger-api(1)](hledger-api.1.html)
### [hledger-ui(1)](hledger-ui.1.html)
### [hledger-web(1)](hledger-web.1.html)
</div>
<div class="col-md-4">
## File formats
### [hledger_csv(5)](hledger_csv.5.html)
### [hledger_journal(5)](hledger_journal.5.html)
### [hledger_timelog(5)](hledger_timelog.5.html)
### [hledger_timedot(5)](hledger_timedot.5.html)
</div>
</div>
</div>