simonmichael/hledger
1
1
Fork 0
mirror of https://github.com/simonmichael/hledger.git synced 2024-09-20 10:47:29 +03:00
Code Issues Projects Releases Wiki Activity
6258dc0db3
hledger/site/docs.md

91 lines
1.9 KiB
Markdown
Raw Normal View History

site: simplify, clean up, refresh - Docs are now collected on a single page - Lots of copy updates - The front page is less cluttered - More whitespace at the sides - The (still WIP) man pages are now linked - Describe and link to plaintextaccounting.org
2016-02-21 23:39:32 +03:00
# Documentation
<style>
site: docs: put all-in-one at top, more descriptions, styling
2016-05-28 18:52:23 +03:00
h2 { font-size:larger; margin-top:0.5em; }
h3 { font-size:large; }
h4 { margin-bottom:0.2em; }
site: simplify, clean up, refresh - Docs are now collected on a single page - Lots of copy updates - The front page is less cluttered - More whitespace at the sides - The (still WIP) man pages are now linked - Describe and link to plaintextaccounting.org
2016-02-21 23:39:32 +03:00
/*div.col-sm-5 { border:thin solid gray; }*/
</style>
<div class="container">
<div class="row">
site: new simpler docs page This docs page is less verbose, and should make it easier to know what you should read next, and what you don't need to read. The reference docs are still in flux, with three alternatives presented: 1. the old manual, 2. the new individual man pages, and 3. the new manual which combines the man pages. At this point I think that 2 will get top billing, 3 will also be provided, and 1 will be dropped when 2/3 are a bit better.
2016-04-08 17:03:23 +03:00
<div class="col-sm-3">
site: docs: put all-in-one at top, more descriptions, styling
2016-05-28 18:52:23 +03:00
## Getting started
site: new simpler docs page This docs page is less verbose, and should make it easier to know what you should read next, and what you don't need to read. The reference docs are still in flux, with three alternatives presented: 1. the old manual, 2. the new individual man pages, and 3. the new manual which combines the man pages. At this point I think that 2 will get top billing, 3 will also be provided, and 1 will be dropped when 2/3 are a bit better.
2016-04-08 17:03:23 +03:00
#### [Home](index.html)
What is hledger, and what can it do for you ?
site: simplify, clean up, refresh - Docs are now collected on a single page - Lots of copy updates - The front page is less cluttered - More whitespace at the sides - The (still WIP) man pages are now linked - Describe and link to plaintextaccounting.org
2016-02-21 23:39:32 +03:00
#### [Download](download.html)
site: new simpler docs page This docs page is less verbose, and should make it easier to know what you should read next, and what you don't need to read. The reference docs are still in flux, with three alternatives presented: 1. the old manual, 2. the new individual man pages, and 3. the new manual which combines the man pages. At this point I think that 2 will get top billing, 3 will also be provided, and 1 will be dropped when 2/3 are a bit better.
2016-04-08 17:03:23 +03:00
How to get it.
site: simplify, clean up, refresh - Docs are now collected on a single page - Lots of copy updates - The front page is less cluttered - More whitespace at the sides - The (still WIP) man pages are now linked - Describe and link to plaintextaccounting.org
2016-02-21 23:39:32 +03:00
site: docs: cleanup
2016-04-06 02:39:58 +03:00
#### [Step by Step Tutorial](step-by-step.html)
site: simplify, clean up, refresh - Docs are now collected on a single page - Lots of copy updates - The front page is less cluttered - More whitespace at the sides - The (still WIP) man pages are now linked - Describe and link to plaintextaccounting.org
2016-02-21 23:39:32 +03:00
Small, guided exercises introducing data entry, reporting, and accounting.
site: new simpler docs page This docs page is less verbose, and should make it easier to know what you should read next, and what you don't need to read. The reference docs are still in flux, with three alternatives presented: 1. the old manual, 2. the new individual man pages, and 3. the new manual which combines the man pages. At this point I think that 2 will get top billing, 3 will also be provided, and 1 will be dropped when 2/3 are a bit better.
2016-04-08 17:03:23 +03:00
#### [Release Notes](release-notes.html)
site: docs: cleanup
2016-04-06 02:39:58 +03:00
#### [FAQ](faq.html)
site: simplify, clean up, refresh - Docs are now collected on a single page - Lots of copy updates - The front page is less cluttered - More whitespace at the sides - The (still WIP) man pages are now linked - Describe and link to plaintextaccounting.org
2016-02-21 23:39:32 +03:00
site: new simpler docs page This docs page is less verbose, and should make it easier to know what you should read next, and what you don't need to read. The reference docs are still in flux, with three alternatives presented: 1. the old manual, 2. the new individual man pages, and 3. the new manual which combines the man pages. At this point I think that 2 will get top billing, 3 will also be provided, and 1 will be dropped when 2/3 are a bit better.
2016-04-08 17:03:23 +03:00
</div>
site: more docs page fiddling. Getting there
2016-04-11 04:20:55 +03:00
<div class="col-sm-3">
site: simplify, clean up, refresh - Docs are now collected on a single page - Lots of copy updates - The front page is less cluttered - More whitespace at the sides - The (still WIP) man pages are now linked - Describe and link to plaintextaccounting.org
2016-02-21 23:39:32 +03:00
site: docs: put all-in-one at top, more descriptions, styling
2016-05-28 18:52:23 +03:00
## Reference
site: simplify, clean up, refresh - Docs are now collected on a single page - Lots of copy updates - The front page is less cluttered - More whitespace at the sides - The (still WIP) man pages are now linked - Describe and link to plaintextaccounting.org
2016-02-21 23:39:32 +03:00
site: docs: put all-in-one at top, more descriptions, styling
2016-05-28 18:52:23 +03:00
#### [All-in-one manual](manual.html)
All the below on one page.
site: simplify, clean up, refresh - Docs are now collected on a single page - Lots of copy updates - The front page is less cluttered - More whitespace at the sides - The (still WIP) man pages are now linked - Describe and link to plaintextaccounting.org
2016-02-21 23:39:32 +03:00
site: docs: put all-in-one at top, more descriptions, styling
2016-05-28 18:52:23 +03:00
### User Interfaces
site: simplify, clean up, refresh - Docs are now collected on a single page - Lots of copy updates - The front page is less cluttered - More whitespace at the sides - The (still WIP) man pages are now linked - Describe and link to plaintextaccounting.org
2016-02-21 23:39:32 +03:00
site: docs: put all-in-one at top, more descriptions, styling
2016-05-28 18:52:23 +03:00
#### [`hledger`](hledger.html)
The main command-line UI.
Good for data entry, control and scriptability.
#### [`hledger-ui`](hledger-ui.html)
A curses-style UI
, for quick review.
#### [`hledger-web`](hledger-web.html)
A web UI
, for browsing, data entry and sharing.
#### [`hledger-api`](hledger-api.html)
A basic web API
, for building client-side apps.
### File formats
site: simplify, clean up, refresh - Docs are now collected on a single page - Lots of copy updates - The front page is less cluttered - More whitespace at the sides - The (still WIP) man pages are now linked - Describe and link to plaintextaccounting.org
2016-02-21 23:39:32 +03:00
site: new simpler docs page This docs page is less verbose, and should make it easier to know what you should read next, and what you don't need to read. The reference docs are still in flux, with three alternatives presented: 1. the old manual, 2. the new individual man pages, and 3. the new manual which combines the man pages. At this point I think that 2 will get top billing, 3 will also be provided, and 1 will be dropped when 2/3 are a bit better.
2016-04-08 17:03:23 +03:00
#### [Journal](journal.html)
site: docs: put all-in-one at top, more descriptions, styling
2016-05-28 18:52:23 +03:00
hledger's native data format, representing an accounting journal.
site: simplify, clean up, refresh - Docs are now collected on a single page - Lots of copy updates - The front page is less cluttered - More whitespace at the sides - The (still WIP) man pages are now linked - Describe and link to plaintextaccounting.org
2016-02-21 23:39:32 +03:00
site: new simpler docs page This docs page is less verbose, and should make it easier to know what you should read next, and what you don't need to read. The reference docs are still in flux, with three alternatives presented: 1. the old manual, 2. the new individual man pages, and 3. the new manual which combines the man pages. At this point I think that 2 will get top billing, 3 will also be provided, and 1 will be dropped when 2/3 are a bit better.
2016-04-08 17:03:23 +03:00
#### [CSV](csv.html)
site: docs: put all-in-one at top, more descriptions, styling
2016-05-28 18:52:23 +03:00
Comma Separated Values, used for import/export.
site: simplify, clean up, refresh - Docs are now collected on a single page - Lots of copy updates - The front page is less cluttered - More whitespace at the sides - The (still WIP) man pages are now linked - Describe and link to plaintextaccounting.org
2016-02-21 23:39:32 +03:00
rename timelog format to timeclock
2016-04-13 07:10:02 +03:00
#### [Timeclock](timeclock.html)
site: docs: put all-in-one at top, more descriptions, styling
2016-05-28 18:52:23 +03:00
For time logging, with clock-in/clock-out records.
site: simplify, clean up, refresh - Docs are now collected on a single page - Lots of copy updates - The front page is less cluttered - More whitespace at the sides - The (still WIP) man pages are now linked - Describe and link to plaintextaccounting.org
2016-02-21 23:39:32 +03:00
site: new simpler docs page This docs page is less verbose, and should make it easier to know what you should read next, and what you don't need to read. The reference docs are still in flux, with three alternatives presented: 1. the old manual, 2. the new individual man pages, and 3. the new manual which combines the man pages. At this point I think that 2 will get top billing, 3 will also be provided, and 1 will be dropped when 2/3 are a bit better.
2016-04-08 17:03:23 +03:00
#### [Timedot](timedot.html)
site: docs: put all-in-one at top, more descriptions, styling
2016-05-28 18:52:23 +03:00
A more human-editable time logging format.
site: more docs page fiddling. Getting there
2016-04-11 04:20:55 +03:00
site: fix man page TOCs, add combined man page
2016-04-07 18:52:41 +03:00
</div>
site: new simpler docs page This docs page is less verbose, and should make it easier to know what you should read next, and what you don't need to read. The reference docs are still in flux, with three alternatives presented: 1. the old manual, 2. the new individual man pages, and 3. the new manual which combines the man pages. At this point I think that 2 will get top billing, 3 will also be provided, and 1 will be dropped when 2/3 are a bit better.
2016-04-08 17:03:23 +03:00
<div class="col-sm-3">
site: docs: put all-in-one at top, more descriptions, styling
2016-05-28 18:52:23 +03:00
## More
site: new simpler docs page This docs page is less verbose, and should make it easier to know what you should read next, and what you don't need to read. The reference docs are still in flux, with three alternatives presented: 1. the old manual, 2. the new individual man pages, and 3. the new manual which combines the man pages. At this point I think that 2 will get top billing, 3 will also be provided, and 1 will be dropped when 2/3 are a bit better.
2016-04-08 17:03:23 +03:00
#### [How to read CSV files](how-to-read-csv-files.html)
#### [How to use account aliases](how-to-use-account-aliases.html)
#### [How to use another account separator character](how-to-use-another-account-separator-character.html)
#### [More docs](more-docs.html)
Some useful links not yet moved to..
#### [plaintextaccounting.org](http://plaintextaccounting.org)
More tips and tools from the plain text accounting community
site: docs: cleanup
2016-04-06 02:39:58 +03:00
site: simplify, clean up, refresh - Docs are now collected on a single page - Lots of copy updates - The front page is less cluttered - More whitespace at the sides - The (still WIP) man pages are now linked - Describe and link to plaintextaccounting.org
2016-02-21 23:39:32 +03:00
</div>
</div>
site: new simpler docs page This docs page is less verbose, and should make it easier to know what you should read next, and what you don't need to read. The reference docs are still in flux, with three alternatives presented: 1. the old manual, 2. the new individual man pages, and 3. the new manual which combines the man pages. At this point I think that 2 will get top billing, 3 will also be provided, and 1 will be dropped when 2/3 are a bit better.
2016-04-08 17:03:23 +03:00
</div>
Reference in New Issue Copy Permalink