hledger/site/docs1.md
2016-04-12 21:13:19 -07:00

98 lines
2.2 KiB
Markdown

<!-- * toc -->
# Documentation
<style>
h4 {
margin-bottom:0.2em;
}
/*div.col-sm-5 { border:thin solid gray; }*/
</style>
<div class="container">
<div class="row">
<div class="col-sm-5">
## Intro
#### [Download](download.html)
How to get hledger installed.
#### [Step by Step Tutorial](step-by-step.html)
Small, guided exercises introducing data entry, reporting, and accounting.
#### [FAQ](faq.html)
Some questions and answers, mostly comparing hledger and Ledger.
**Examples:**
#### [How to read CSV files](how-to-read-csv-files.html)
An example of converting bank data.
#### [How to use account aliases](how-to-use-account-aliases.html)
Aliases for account name rewriting.
#### [How to use another account separator character](how-to-use-another-account-separator-character.html)
Writing `some.sub.account` instead of `some:sub:account`.
**General info:**
#### [More docs](more-docs.html)
Some useful links, eg on accounting, not yet moved to...
#### [plaintextaccounting.org](http://plaintextaccounting.org)
A comprehensive collection of resources and practices from the plain text accounting community
</div>
<div class="col-sm-5">
## Reference
#### [User Manual](manual.html)
The hledger reference manual, all on one page.
Or, as man pages (work in progress):
<div style="padding-left:1em;">
#### [hledger(1)](hledger.html)
The main reporting tool and command-line interface.
#### [hledger-ui(1)](hledger-ui.html)
A curses-style UI for quick exploration.
#### [hledger-web(1)](hledger-web.html)
A web UI for browsing and data entry, personal or shared.
#### [hledger-api(1)](hledger-api.html)
A REST-y JSON and file server, good for building client-side UIs.
**File formats:**
#### [hledger_journal(5)](journal.html)
hledger's primary data format, representing a general journal.
#### [hledger_csv(5)](csv.html)
How hledger reads Comma Separated Value data.
#### [hledger_timeclock(5)](timeclock.html)
Timeclock format, a sequence of clock-in/clock-out records.
#### [hledger_timedot(5)](timedot.html)
Timedot format, an alternative time logging format.
**Combined:**
#### [All man pages](manual2.html)
All hledger man pages on one web page.
</div>
</div>
</div>
</div>