docs: reorganise/streamline docs page, add all tools
This commit is contained in:
Simon Michael
parent
14be9028e3
commit
60161625f8
@ -52,7 +52,7 @@ There is also a collection of wishes at the old [trello board](http://trello.hle
|
||||
- review and discuss new [pull requests](http://prs.hledger.org) and commits on github
|
||||
- build hledger and test the latest changes in your own repo
|
||||
- read the existing [code docs and source](#quick-links)
|
||||
- send feedback or discuss via [IRC or mail list](/docs.html#get-helpgive-feedback)
|
||||
- send feedback or discuss via [IRC or mail list](/docs.html#helpfeedback)
|
||||
|
||||
#### Build hledger
|
||||
|
||||
@ -207,7 +207,7 @@ If you're new to this process, [help.github.com](http://help.github.com) may be
|
||||
|
||||
#### Add yourself to the contributor list
|
||||
|
||||
- after getting something into the master branch, read and sign the [contributor list & agreement](contributors.html). Or, [ask](/docs.html#get-helpgive-feedback) to be added.
|
||||
- after getting something into the master branch, read and sign the [contributor list & agreement](contributors.html). Or, [ask](/docs.html#helpfeedback) to be added.
|
||||
- give yourself a high five!
|
||||
|
||||
### Technical Writer
|
||||
|
||||
181
site/docs.md
181
site/docs.md
@ -1,4 +1,4 @@
|
||||
# User guide
|
||||
# hledger docs
|
||||
|
||||
<style>
|
||||
h2 { font-size:x-large; margin-top:0.5em; }
|
||||
@ -9,7 +9,10 @@ td:nth-child(1) { padding-right:1em; white-space:nowrap; }
|
||||
|
||||
<div class="container">
|
||||
|
||||
## Get help/give feedback
|
||||
hledger-specific docs are collected here.
|
||||
For more docs relevant to all ledger-likes, see [plaintextaccounting.org](http://plaintextaccounting.org).
|
||||
|
||||
## Help/feedback
|
||||
|
|
||||
|---------------|----------------------------------------------------------------------------|
|
||||
| IRC | [#hledger](http://irc.hledger.org) on Freenode (<!-- [chat log](http://ircbrowse.net/browse/hledger); --> see also [#ledger](http://webchat.freenode.net?channels=ledger&randomnick=1)) <!-- *Quick help and background chat.* --> <!-- *If you don't get an answer promptly, you can type `sm` to alert me, or leave the window open and check back later.* -->
|
||||
@ -21,95 +24,173 @@ td:nth-child(1) { padding-right:1em; white-space:nowrap; }
|
||||
<!-- | hledger-api demo | <\!-- [demo.hledger.org/api](http://demo.hledger.org/api/swagger.json), -\-> [in swagger editor](http://editor.swagger.io/#/?import=demo.hledger.org/api/swagger.json&no-proxy) -->
|
||||
|
||||
<div class="row">
|
||||
|
||||
<div class="col-sm-3">
|
||||
|
||||
## Get started
|
||||
## Introduction
|
||||
|
||||
### [Home](index.html)
|
||||
What is hledger ?
|
||||
### What is hledger?
|
||||
|
||||
### [Download](download.html)
|
||||
How to get it, and [release notes](release-notes.html).
|
||||
[hledger.org](http://hledger.org)\
|
||||
[Misc. links](more-docs.html)\
|
||||
<!-- Some learning resources not yet moved to the above. -->
|
||||
[FAQ](faq.html)\
|
||||
|
||||
### [Step by Step Tutorial](step-by-step.html)
|
||||
Small, guided exercises introducing data entry, reporting, and accounting.
|
||||
|
||||
### [FAQ](faq.html)
|
||||
Some frequently asked questions.
|
||||
### What is plain text accounting?
|
||||
|
||||
### [plaintextaccounting.org](http://plaintextaccounting.org)
|
||||
More background, tips and tools from the plaintext accounting community.
|
||||
[plaintextaccounting.org](http://plaintextaccounting.org)\
|
||||
|
||||
|
||||
### Installing
|
||||
|
||||
[Download](download.html)\
|
||||
[Release notes](release-notes.html)\
|
||||
|
||||
|
||||
### Getting started
|
||||
|
||||
[hledger Step by Step](step-by-step.html) tutorial\
|
||||
|
||||
### [Misc. links](more-docs.html)
|
||||
Some learning resources not yet moved to the above.
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<div class="col-sm-3">
|
||||
|
||||
## Get things done
|
||||
## [Cookbook](cookbook.html){title="all on one page"}
|
||||
|
||||
### [hledger Cookbook](cookbook.html)
|
||||
Practical recipes and examples, including:
|
||||
|
||||
<div style="padding-left:0em;">
|
||||
### Journal management
|
||||
|
||||
[Start a journal](start-journal.html)\
|
||||
[Track changes with version control](version-control.html)\
|
||||
[Example journal entries](entries.html)\
|
||||
[Convert CSV files](csv-import.html)\
|
||||
|
||||
|
||||
### Account names
|
||||
|
||||
[PTA: choosing accounts](http://plaintextaccounting.org/#choosing-accounts)\
|
||||
[Rewrite account names](account-aliases.html)\
|
||||
[Use another account separator character](account-separator.html)\
|
||||
|
||||
|
||||
### Journal entries
|
||||
|
||||
[Example journal entries](entries.html)\
|
||||
|
||||
|
||||
### Data entry/import
|
||||
|
||||
[Convert CSV files](csv-import.html)\
|
||||
|
||||
|
||||
### Investing
|
||||
|
||||
[Track investments](investments.html)\
|
||||
|
||||
</div>
|
||||
|
||||
### More..
|
||||
[PTA: Common tasks](http://plaintextaccounting.org/#common-tasks)
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<div class="col-sm-3">
|
||||
|
||||
## Get the details
|
||||
## [Reference](manual.html){title="all on one page"}
|
||||
|
||||
### [Manuals](manual.html)
|
||||
The full reference guide. Includes:
|
||||
### File formats
|
||||
|
||||
<div style="padding-left:0em;">
|
||||
[hledger_journal(5)](journal.html)
|
||||
is hledger's native data format, representing an accounting journal
|
||||
|
||||
**Tools**
|
||||
[hledger_csv(5)](csv.html)
|
||||
allows CSV import/export
|
||||
|
||||
**[`hledger`](hledger.html)**\
|
||||
The command-line UI
|
||||
, for flexibility and automation.
|
||||
[hledger_timeclock(5)](timeclock.html)
|
||||
is for clock-in/clock-out time logging
|
||||
|
||||
**[`hledger-ui`](hledger-ui.html)**\
|
||||
A curses-style UI
|
||||
, for quick review and monitoring.
|
||||
[hledger_timedot(5)](timedot.html)
|
||||
is for human-friendly time logging
|
||||
|
||||
**[`hledger-web`](hledger-web.html)**\
|
||||
A web UI
|
||||
, for browsing, sharing, and collaboration.
|
||||
### Tools
|
||||
|
||||
**[`hledger-api`](hledger-api.html)**\
|
||||
A basic web API
|
||||
, for building client-side apps.
|
||||
[hledger(1)](hledger.html)
|
||||
is the command-line UI
|
||||
|
||||
**File formats**
|
||||
[hledger-ui(1)](hledger-ui.html)
|
||||
is a curses-style UI
|
||||
|
||||
**[Journal](journal.html)**\
|
||||
hledger's native data format, representing an accounting journal.
|
||||
[hledger-web(1)](hledger-web.html)
|
||||
is a web UI
|
||||
|
||||
**[CSV](csv.html)**\
|
||||
Comma Separated Values, used for import/export.
|
||||
[hledger-api(1)](hledger-api.html)
|
||||
is a HTTP-JSON API
|
||||
|
||||
**[Timeclock](timeclock.html)**\
|
||||
For time logging, with clock-in/clock-out records.
|
||||
### Addon tools
|
||||
|
||||
**[Timedot](timedot.html)**\
|
||||
A more human-friendly time logging format.
|
||||
Available [on Hackage/Stackage](/download.html#d):
|
||||
|
||||
[hledger-diff](http://hackage.haskell.org/package/hledger-diff)
|
||||
shows differences in an account's transactions between one journal file and another.
|
||||
|
||||
[hledger-iadd](http://hackage.haskell.org/package/hledger-iadd)
|
||||
is a curses-style replacement for hledger's add command.
|
||||
|
||||
[hledger-interest](http://hackage.haskell.org/package/hledger-interest)
|
||||
generates interest transactions for an account according to various schemes.
|
||||
|
||||
[hledger-irr](http://hackage.haskell.org/package/hledger-irr)
|
||||
calculates the internal rate of return of an investment account.
|
||||
|
||||
### Experimental tools
|
||||
|
||||
Available [in the hledger repo](/download.html#d):
|
||||
|
||||
[hledger-autosync](https://github.com/simonmichael/hledger/blob/master/bin/hledger-autosync)
|
||||
is a symbolic link for running
|
||||
[ledger-autosync](https://pypi.python.org/pypi/ledger-autosync),
|
||||
which can download or convert OFX data.
|
||||
|
||||
[hledger-budget.hs](https://github.com/simonmichael/hledger/blob/master/bin/hledger-budget.hs#L10)
|
||||
adds Ledger-style periodic transactions and budget reports.
|
||||
|
||||
[hledger-chart.hs](https://github.com/simonmichael/hledger/blob/master/bin/hledger-chart.hs#L47)
|
||||
is an old pie chart generator.
|
||||
|
||||
[hledger-check.hs](https://github.com/simonmichael/hledger/blob/master/bin/hledger-check.hs)
|
||||
checks more powerful account balance assertions.
|
||||
|
||||
[hledger-check-dates.hs](https://github.com/simonmichael/hledger/blob/master/bin/hledger-check-dates.hs#L15)
|
||||
checks that journal entries are ordered by date.
|
||||
|
||||
[hledger-check-dupes.hs](https://github.com/simonmichael/hledger/blob/master/bin/hledger-check-dupes.hs#L21)
|
||||
checks for account names sharing the same leaf name.
|
||||
|
||||
[hledger-equity.hs](https://github.com/simonmichael/hledger/blob/master/bin/hledger-equity.hs#L17)
|
||||
prints balance-clearing/restoring transactions, useful for bringing account balances across file boundaries.
|
||||
|
||||
[hledger-prices.hs](https://github.com/simonmichael/hledger/blob/master/bin/hledger-prices.hs)
|
||||
prints all prices from the journal.
|
||||
|
||||
[hledger-print-unique.hs](https://github.com/simonmichael/hledger/blob/master/bin/hledger-print-unique.hs#L15)
|
||||
prints transactions with unique descriptions.
|
||||
|
||||
[hledger-register-match.hs](https://github.com/simonmichael/hledger/blob/master/bin/hledger-register-match.hs#L23)
|
||||
helps ledger-autosync ignore previously imported transactions.
|
||||
|
||||
[hledger-rewrite.hs](https://github.com/simonmichael/hledger/blob/master/bin/hledger-rewrite.hs#L28)
|
||||
adds Ledger-style automatic postings to existing transactions.
|
||||
|
||||
[hledger-tags.hs](https://github.com/simonmichael/hledger/blob/master/bin/hledger-tags.hs)
|
||||
lists tag names in use.
|
||||
|
||||
</div>
|
||||
|
||||
</div> <!-- col -->
|
||||
|
||||
</div> <!-- row -->
|
||||
</div> <!-- container -->
|
||||
|
||||
<!-- For more docs relevant to all ledger-likes, see also [plaintextaccounting.org](http://plaintextaccounting.org) -->
|
||||
|
||||
|
||||
@ -52,7 +52,7 @@ and here's the less secure, more convenient way:
|
||||
Note this could take significant time (minutes to hours), memory (~2G),
|
||||
and disk space (up to a gigabyte) depending on your connection,
|
||||
machine and past cabal/stack installations. You can kill and rerun it without losing progress.
|
||||
If the installer fails, please help improve it by [reporting](docs.html#get-helpgive-feedback) the full output.
|
||||
If the installer fails, please help improve it by [reporting](docs.html#helpfeedback) the full output.
|
||||
|
||||
Or, you can install manually (all systems):
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user