mirror of
https://github.com/simonmichael/hledger.git
synced 2024-09-19 10:17:35 +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
This commit is contained in:
Simon Michael
parent
848309c3f9
commit
671ade5062
@ -18,7 +18,7 @@ hledger_journal - reference for hledger's journal file format
|
||||
hledger's usual data source is a plain text file containing journal entries in hledger journal format.
|
||||
This file represents a standard accounting [general journal](http://en.wikipedia.org/wiki/General_journal).
|
||||
I use file names ending in `.journal`, but that's not required.
|
||||
The journal file contains a number of transaction entries,
|
||||
The journal file contains a number of transaction entries,
|
||||
each describing a transfer of money (or any commodity) between two or more named accounts,
|
||||
in a simple format readable by both hledger and humans.
|
||||
|
||||
@ -28,8 +28,8 @@ so hledger can work with [compatible](faq.html#file-format-differences) ledger j
|
||||
It's safe, and encouraged, to run both hledger and ledger on the same journal file,
|
||||
eg to validate the results you're getting.
|
||||
|
||||
You can use hledger without learning any more about this file;
|
||||
just use the [add](#add) or [web](#web) commands to create and update it.
|
||||
You can use hledger without learning any more about this file;
|
||||
just use the [add](#add) or [web](#web) commands to create and update it.
|
||||
Many users, though, also edit the journal file directly with a text editor, perhaps assisted by the helper modes for emacs or vim.
|
||||
|
||||
Here's an example:
|
||||
|
||||
1
site/.gitignore
vendored
1
site/.gitignore
vendored
@ -1,3 +1,4 @@
|
||||
hakyll-std
|
||||
_cache
|
||||
_site
|
||||
files/downloads
|
||||
|
||||
@ -67,7 +67,9 @@ pre {
|
||||
.right {
|
||||
float:right;
|
||||
}
|
||||
.navbar-brand {font-weight:bold;}
|
||||
.navbar { font-size:x-large; }
|
||||
.navbar-brand { font-weight:bold; font-size:xx-large; }
|
||||
.navbar-nav { margin-left:1em; }
|
||||
/* from https://github.com/blaenk/blaenk.github.io/blob/source/provider/scss/_article.scss */
|
||||
#toc {
|
||||
max-width:40%;
|
||||
|
||||
88
site/docs.md
Normal file
88
site/docs.md
Normal file
@ -0,0 +1,88 @@
|
||||
<!-- * 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">
|
||||
## Getting started
|
||||
|
||||
#### [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.
|
||||
|
||||
#### [Frequently Asked Questions](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.
|
||||
|
||||
## General info
|
||||
|
||||
#### [More docs](more-docs.html)
|
||||
A useful collection of links, eg on accounting, being moved to:
|
||||
|
||||
#### [plaintextaccounting.org](http://plaintextaccounting.org)
|
||||
A comprehensive survey of our larger community and common practices
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="col-sm-5">
|
||||
## Reference
|
||||
|
||||
#### [User Manual](manual.html)
|
||||
The comprehensive manual, all on one page.
|
||||
|
||||
### Tools
|
||||
|
||||
Here is the same manual (more or less) organized as unix man pages
|
||||
(work in progress):
|
||||
|
||||
#### [hledger(1)](hledger.1.html)
|
||||
The main reporting tool and command-line interface.
|
||||
|
||||
#### [hledger-ui(1)](hledger-ui.1.html)
|
||||
A curses-style UI for quick exploration.
|
||||
|
||||
#### [hledger-web(1)](hledger-web.1.html)
|
||||
A web UI for browsing and data entry, personal or shared.
|
||||
|
||||
#### [hledger-api(1)](hledger-api.1.html)
|
||||
A REST-y JSON and file server, good for building client-side UIs.
|
||||
|
||||
### File formats
|
||||
|
||||
#### [hledger_journal(5)](hledger_journal.5.html)
|
||||
hledger's primary data format, representing a general journal.
|
||||
|
||||
#### [hledger_csv(5)](hledger_csv.5.html)
|
||||
How hledger reads Comma Separated Value data.
|
||||
|
||||
#### [hledger_timelog(5)](hledger_timelog.5.html)
|
||||
Timeclock format, a sequence of clock-in/clock-out records.
|
||||
|
||||
#### [hledger_timedot(5)](hledger_timedot.5.html)
|
||||
Timedot format, an alternative time logging format.
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
@ -1,13 +1,14 @@
|
||||
<div style="float:right; text-align:right; white-space:nowrap; ">
|
||||
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=5J33NLXYXCYAY"><img border=0 src="https://www.paypal.com/en_US/i/btn/x-click-but04.gif" alt="paypal"></a>
|
||||
<a style="margin-left:3px;" href="https://flattr.com/submit/auto?user_id=simonmichael&url=http%3A%2F%2Fhledger.org" target="_blank"><img src="//api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" border="0"></a>
|
||||
<div style="display:inline-block; position:relative; top:5px;">
|
||||
<a style="margin-left:3px;" href="https://flattr.com/submit/auto?user_id=simonmichael&url=http%3A%2F%2Fhledger.org" target="_blank"><img src="//api.flattr.com/button/flattr-badge-large.png" alt="" title="Flattr this" border="0"></a>
|
||||
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=5J33NLXYXCYAY"><img width=62 height=31 border=0 src="https://www.paypal.com/en_US/i/btn/x-click-but04.gif" alt=""></a>
|
||||
<div style="display:inline-block; position:relative; top:5px; width:62px; height:31px;">
|
||||
<script data-gratipay-username="simonmichael" data-gratipay-widget="button" src="//grtp.co/v1.js"></script>
|
||||
</div>
|
||||
<a href="https://www.bountysource.com/trackers/536505-simonmichael-hledger"><img border=0 src="https://www.bountysource.com/badge/tracker?tracker_id=536505" alt=""></a>
|
||||
</div>
|
||||
# Download
|
||||
|
||||
**[Release notes](release-notes.html)**
|
||||
### [Release notes](release-notes.html)
|
||||
|
||||
<a name="packaged"></a>
|
||||
|
||||
@ -16,7 +17,8 @@
|
||||
|
||||
<style>
|
||||
tr { vertical-align:top; }
|
||||
td { padding-bottom:1em; padding-right:1em; }
|
||||
td { padding-bottom:.5em; padding-right:1em; }
|
||||
a { white-space:nowrap; }
|
||||
</style>
|
||||
|
||||
<table>
|
||||
@ -30,7 +32,7 @@ Download, unzip, and run
|
||||
<!-- (or the [32-bit build](http://hledger.org/downloads/hledger-0.26-win32.zip)) -->
|
||||
and/or
|
||||
[hledger-web-0.26-win64.zip](http://hledger.org/downloads/hledger-web-0.26-win64.zip)
|
||||
<br><em>(The current release is 0.27. To contribute binaries for windows or mac, please <a href="mailto:simon@joyful.com">get in touch</a>.)</em>
|
||||
<em>(The current release is 0.27. To contribute binaries for windows or mac, please <a href="mailto:simon@joyful.com">get in touch</a>.)</em>
|
||||
</td></tr>
|
||||
|
||||
<tr><td>
|
||||
@ -39,7 +41,7 @@ and/or
|
||||
`brew install hledger`
|
||||
</td></tr>
|
||||
|
||||
<tr><td>
|
||||
<tr><td style="white-space:nowrap;">
|
||||
**on Debian or Ubuntu**
|
||||
</td><td>
|
||||
`apt-get install hledger hledger-web`
|
||||
@ -59,7 +61,7 @@ and/or
|
||||
|
||||
<tr><td>
|
||||
**on NixOS**
|
||||
</td><td style="white-space:nowrap;">
|
||||
</td><td>
|
||||
`nix-env -iA nixpkgs.haskellPackages.hledger nixpkgs.haskellPackages.hledger-web`
|
||||
</td></tr>
|
||||
|
||||
|
||||
14
site/faq.md
14
site/faq.md
@ -58,14 +58,6 @@ the [ledger-cli.org](http://ledger-cli.org) site,
|
||||
IRC support on #ledger,
|
||||
and now [plaintextaccounting.org](http://plaintextaccounting.org).
|
||||
|
||||
|
||||
### Future ?
|
||||
|
||||
There is a [ledger4](https://github.com/ledger/ledger4) repo on
|
||||
github; this is John's 2012/2013 rewrite of some parts of Ledger 3,
|
||||
including the parser, in Haskell. We have a plan to add this parser to
|
||||
hledger in 2015/2016, increasing its ability to read Ledger's files.
|
||||
|
||||
### Features
|
||||
|
||||
Compared to Ledger, hledger builds quickly and has a complete and
|
||||
@ -179,6 +171,12 @@ or [balance assertions](manual.html#assertions-and-ordering).
|
||||
first). hledger requires the fixed lot price to come last (and
|
||||
ignores it).
|
||||
|
||||
### Future ?
|
||||
|
||||
There is a [ledger4](https://github.com/ledger/ledger4) repo on
|
||||
github; this is John's 2012/2013 rewrite of some parts of Ledger 3,
|
||||
including the parser, in Haskell. We have a plan to add this parser to
|
||||
hledger in 2015/2016, increasing its ability to read Ledger's files.
|
||||
|
||||
|
||||
## UI surprises
|
||||
|
||||
156
site/index.md
156
site/index.md
@ -5,26 +5,28 @@ title: home
|
||||
<style>
|
||||
.highslide img {max-width:200px; float:right; margin:0 0 1em 1em;}
|
||||
.highslide-caption {color:white; background-color:black;}
|
||||
.indent0 { margin:0 15em 0 0em; }
|
||||
.indent1 { margin:0 10em 0 5em; }
|
||||
.indent2 { margin:0 5em 0 10em; }
|
||||
.indent3 { margin:0 0 0 15em; }
|
||||
a {white-space:nowrap;}
|
||||
/*div.asciicast { float:right; height:200px; }*/
|
||||
</style>
|
||||
|
||||
<div class="row"> <!-- main row -->
|
||||
<!-- <div class="col-md-9"> <\!-- main column -\-> -->
|
||||
<div class=""> <!-- main column -->
|
||||
|
||||
<div style="float:right; max-width:200px; margin-left:1em;"> <!-- top-right area -->
|
||||
<!-- <div style="float:right; max-width:200px; margin-left:1em;"> <\!-- top-right area -\-> -->
|
||||
|
||||
<!-- get started box -->
|
||||
<!-- get started box
|
||||
<div class="panel panel-primary">
|
||||
<div class="panel-heading">
|
||||
<h2 class="panel-title">Get started</h2>
|
||||
</div>
|
||||
<div class="panel-body">
|
||||
**[Install](download.html)**,
|
||||
**[Download](download.html)**,
|
||||
read the
|
||||
**[release notes](release-notes.html)**,
|
||||
**[tutorial](step-by-step.html)**,
|
||||
or **[manual](manual.html)**,
|
||||
<!-- or **[blog posts](more-docs.html#blog-posts-articles)**, -->
|
||||
or **[manual](docs.html)**,
|
||||
try the **[web UI](http://demo.hledger.org)**,
|
||||
introduce yourself and tell us what's good/bad..
|
||||
|
||||
@ -36,70 +38,72 @@ tr {
|
||||
</style>
|
||||
|
|
||||
|---------------------------|-------------------------------------------------------------------------
|
||||
| IRC | [#hledger](http://irc.hledger.org) <!-- (see also [#ledger](http://webchat.freenode.net?channels=ledger&randomnick=1)) -->
|
||||
| IRC | [#hledger](http://irc.hledger.org)
|
||||
| Mail list | via [google](http://list.hledger.org) or [gmane](http://news.gmane.org/gmane.comp.finance.ledger.hledger)
|
||||
| Twitter | [#ledgercli](https://twitter.com/search?q=%23ledgercli&src=typd&f=realtime), <a href="https://twitter.com/ledgertips">@LedgerTips</a>
|
||||
| Github | [code](http://github.com/simonmichael/hledger), [bugs](http://bugs.hledger.org), [issues](http://issues.hledger.org)
|
||||
-->
|
||||
<!-- (see also [#ledger](http://webchat.freenode.net?channels=ledger&randomnick=1)) -->
|
||||
|
||||
<!-- | More... | [quick links](http://hledger.org/developer-guide.html#quick-links) -->
|
||||
|
||||
<!-- | web UI demo | [demo.hledger.org](http://demo.hledger.org) | -->
|
||||
<!-- [web ui demo](http://demo.hledger.org/register?q=inacct%3Aassets%3Abank%3Achecking+sym%3A\%24) -->
|
||||
|
||||
<!-- </div> -->
|
||||
<!-- </div> <\!-- end of get started box -\-> -->
|
||||
|
||||
<!-- </div> <\!-- end of top-right area -\-> -->
|
||||
|
||||
<div style="float:right; text-align:right; white-space:nowrap; ">
|
||||
<a style="margin-left:3px;" href="https://flattr.com/submit/auto?user_id=simonmichael&url=http%3A%2F%2Fhledger.org" target="_blank"><img src="//api.flattr.com/button/flattr-badge-large.png" alt="" title="Flattr this" border="0"></a>
|
||||
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=5J33NLXYXCYAY"><img width=62 height=31 border=0 src="https://www.paypal.com/en_US/i/btn/x-click-but04.gif" alt=""></a>
|
||||
<div style="display:inline-block; position:relative; top:5px; width:62px; height:31px;">
|
||||
<script data-gratipay-username="simonmichael" data-gratipay-widget="button" src="//grtp.co/v1.js"></script>
|
||||
</div>
|
||||
</div> <!-- end of get started box -->
|
||||
|
||||
</div> <!-- end of top-right area -->
|
||||
|
||||
<div style="float:right; max-width:270px; margin-left:1em;"> <!-- second top-right area -->
|
||||
<!-- donate buttons -->
|
||||
<div style="margin-top:1em; text-align:center;">
|
||||
<!-- Has hledger saved you or your employer money, time or peace of mind ?
|
||||
<!-- Would you like to support our mission ? (and what should it be ?)
|
||||
<!-- Donations: -->
|
||||
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=5J33NLXYXCYAY"><img border=0 src="https://www.paypal.com/en_US/i/btn/x-click-but04.gif" alt="paypal"></a> \
|
||||
<!-- <div style="display:inline; position:relative; top:6px;"><script data-gratipay-username="simonmichael" data-gratipay-widget="button" src="//grtp.co/v1.js"></script></div> -->
|
||||
<a href="https://www.bountysource.com/trackers/536505-simonmichael-hledger"><img border=0 src="https://www.bountysource.com/badge/tracker?tracker_id=536505" alt="bountysource"></a>
|
||||
<a href="https://flattr.com/submit/auto?user_id=simonmichael&url=http%3A%2F%2Fhledger.org" target="_blank"><img src="//api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" border="0"></a>
|
||||
<!-- Also testimonials, examples, blogging, packaging, and patches. -->
|
||||
<a href="https://www.bountysource.com/trackers/536505-simonmichael-hledger"><img border=0 src="https://www.bountysource.com/badge/tracker?tracker_id=536505" alt=""></a>
|
||||
</div> <!-- end of donate buttons -->
|
||||
</div> <!-- end of second top-right area -->
|
||||
|
||||
<!-- main content -->
|
||||
|
||||
<style>
|
||||
.indent0 { margin:0 15em 0 0em; }
|
||||
.indent1 { margin:0 10em 0 5em; }
|
||||
.indent2 { margin:0 5em 0 10em; }
|
||||
.indent3 { margin:0 0 0 15em; }
|
||||
/*div.asciicast { float:right; height:200px; }*/
|
||||
</style>
|
||||
|
||||
<h1 style="font-size:6em;">hledger</h1>
|
||||
|
||||
<img src="/images/coins2-248.png" width="" height="200" style="float:right; margin:1em 1em 0 1em;" />
|
||||
|
||||
<h2 style="margin-top:0; margin-bottom:.5em;">
|
||||
<!-- Making accounting fun for techies. -->
|
||||
Simple, precise, future-proof accounting for techies.
|
||||
Simple, precise, plain text accounting.
|
||||
<!-- Plain text accounting for everyone. -->
|
||||
</h2>
|
||||
|
||||
<div style="font-size:medium;">
|
||||
|
||||
hledger is a lightweight accounting program for tracking money, time, or
|
||||
hledger is an accounting program, for tracking money, time, or
|
||||
other commodities, on unix, mac and windows. With simple yet powerful
|
||||
functionality accessed from command line, terminal or web browser, it is a
|
||||
reliable, cross-platform alternative to Quicken, GnuCash, spreadsheets etc.
|
||||
robust, cross-platform alternative to Quicken, GnuCash, spreadsheets etc.
|
||||
|
||||
**Step 1:** Record your transactions in a plain text file (using any text editor,
|
||||
hledger's add command, the web interface, CSV or OFX import, custom scripts..)
|
||||
<div class="indent0">
|
||||
### plain text ? How does that work ?
|
||||
|
||||
**Step 2:** Ask hledger about your accounts, currencies, balances,
|
||||
monthly averages, market values and more.
|
||||
**Step 1:**
|
||||
Record your transactions in a plain text file.
|
||||
(Use hledger's interactive assistant.. the web interface.. any text editor.. a shell alias.. CSV/OFX import..)
|
||||
<!-- using a simple format. -->
|
||||
<!-- Do it daily, or all at once. -->
|
||||
<!-- Record what you know; you'll get better at it. -->
|
||||
|
||||
You can start out very simple, and get more sophisticated as you learn
|
||||
more about double-entry accounting. You'll feel closer to your
|
||||
finances, and accounting becomes fun. [Try it!](step-by-step.html)
|
||||
**Step 2:**
|
||||
Ask hledger about your accounts.. transactions.. balances.. currencies.. monthly averages.. budgets.. market values..
|
||||
You can start very simply, and get more sophisticated as you learn more about double-entry accounting.
|
||||
|
||||
There is an enthusiastic and growing community practising this way of accounting.
|
||||
which can be quite educational and enjoyable.
|
||||
If you'd like more background,
|
||||
we have collected many useful resources at **[plaintextaccounting.org](http://plaintextaccounting.org)**.
|
||||
|
||||
And.. welcome back. Read on - or if you're eager to make a start,
|
||||
**[download](download.html)** and start the **[tutorial](step-by-step.html)** now!
|
||||
|
||||
<!-- I use it for: -->
|
||||
|
||||
@ -108,23 +112,28 @@ finances, and accounting becomes fun. [Try it!](step-by-step.html)
|
||||
<!-- - getting accurate numbers for client billing and tax filing -->
|
||||
<!-- - tracking invoices -->
|
||||
<!-- - building financial and time clarity and serenity -->
|
||||
</div>
|
||||
|
||||
<div class="indent1">
|
||||
### Free software
|
||||
### hledger is Free software
|
||||
|
||||
hledger is Free software released under GNU GPLv3+, which helps ensure
|
||||
its longevity. It has been developed by
|
||||
[Simon Michael](http://joyful.com) and contributors since 2007.
|
||||
[](http://www.gnu.org/licenses/gpl.html)
|
||||
<a href="http://www.gnu.org/licenses/gpl.html" style="float:right; margin:0 0 1em 0;"><img width="104" height="20" src="https://img.shields.io/badge/license-GPLv3+-brightgreen.svg" /></a>
|
||||
hledger is Free software, created by [Simon Michael](http://joyful.com)
|
||||
and released under GNU GPLv3+.
|
||||
|
||||
I have been actively developing and using hledger since 2007,
|
||||
together with 30+ other committers, and an unknown number of usually happy-sounding users.
|
||||
</div>
|
||||
|
||||
<div class="indent2">
|
||||
### inspired by Ledger
|
||||
|
||||
hledger is a Haskell reimplementation of the excellent [Ledger](faq.html#hledger-and-ledger).
|
||||
It remains substantially compatible with Ledger - if you wish you can keep your data compatible with both -
|
||||
and it is part of the enthusiastic and growing *ledger community.
|
||||
It remains substantially compatible with Ledger, and if you wish you can keep your data compatible with both.
|
||||
Read more about the differences in the [FAQ](faq.html#hledger-and-ledger).
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div class="indent0">
|
||||
@ -145,8 +154,8 @@ transactions, but does not change existing ones.)
|
||||
|
||||
<a href="images/hledger-ui/hledger-ui-bcexample-acc.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-ui/hledger-ui-bcexample-acc.png" title="hledger-ui accounts screen" /></a>
|
||||
hledger also provides a curses-style [console interface](manual#ui)
|
||||
that lets you review account balances and transactions with fewer
|
||||
keystrokes and less effort ([screencast](https://asciinema.org/a/29665)).
|
||||
that lets you review account balances and transactions quickly and without fuss.
|
||||
([screencast](https://asciinema.org/a/29665))
|
||||
</div>
|
||||
|
||||
<div class="indent2">
|
||||
@ -154,11 +163,11 @@ keystrokes and less effort ([screencast](https://asciinema.org/a/29665)).
|
||||
|
||||
<a href="images/hledger-web/normal/register.png" class="highslide" onclick="return hs.expand(this)"><img src="images/hledger-web/normal/register.png" title="Account register view with accounts sidebar" /></a>
|
||||
|
||||
hledger comes with a built-in web server providing a
|
||||
[web interface](manual.html#web)
|
||||
([demo](http://demo.hledger.org)), for assisted data entry and point
|
||||
and click reporting. The web and command-line/curses interfaces can be used
|
||||
simultaneously.
|
||||
And, a zero-setup [web interface](manual.html#web)
|
||||
([demo](http://demo.hledger.org); press `s` to open the sidebar),
|
||||
for assisted data entry and a more point-and-click experience.
|
||||
You can set up your own private or shared web instance with a few
|
||||
clicks at [Sandstorm](https://apps.sandstorm.io/app/8x12h6p0x0nrzk73hfq6zh2jxtgyzzcty7qsatkg7jfg2mzw5n90).
|
||||
</div>
|
||||
|
||||
<div class="indent3">
|
||||
@ -199,26 +208,29 @@ power of text files, revision control, scriptability and double entry
|
||||
accounting.
|
||||
|
||||
I've been using hledger daily and improving it since 2007.
|
||||
I needed a tool like this badly, and I want to keep it growing and
|
||||
helping others to transform their financial lives.
|
||||
I needed a tool like this badly, and I hope it will keep growing and
|
||||
helping folks to transform their financial lives.
|
||||
If you feel the same way, join us!
|
||||
|
||||
</div>
|
||||
|
||||
</div> <!-- end of large text -->
|
||||
<div class="indent1">
|
||||
### fully documented
|
||||
|
||||
<!-- end of main content -->
|
||||
|
||||
<div style="margin-top:3em; text-align:center; ">
|
||||
|
||||
<!-- twitter widget -->
|
||||
<!-- <div class="col-md-3"> -->
|
||||
<div style="margin-top:2em;">
|
||||
### Latest tweets about hledger and Ledger:
|
||||
<a class="twitter-timeline" width="" height="600px" data-dnt="true" href="https://twitter.com/hashtag/ledgercli" data-widget-id="539507319734677504"></a>
|
||||
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+"://platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
|
||||
</div> <!-- end of twitter widget -->
|
||||
Time to check out those **[docs](docs.html)**,
|
||||
or maybe **[look deeper](developer-guide.html)**.
|
||||
|
||||
</div>
|
||||
|
||||
</div> <!-- end of main row -->
|
||||
</div>
|
||||
<!-- end of main content -->
|
||||
|
||||
<div style="margin-top:4em; text-align:center; ">
|
||||
<!-- twitter widget -->
|
||||
<div>
|
||||
### Recent related tweets:
|
||||
<a class="twitter-timeline" width="" height="600px" data-dnt="true" href="https://twitter.com/hashtag/ledgercli" data-widget-id="539507319734677504"></a>
|
||||
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+"://platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
|
||||
</div>
|
||||
<!-- end of twitter widget -->
|
||||
</div>
|
||||
|
||||
@ -1,39 +0,0 @@
|
||||
* 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>
|
||||
@ -2,10 +2,8 @@
|
||||
|
||||
# More docs...
|
||||
|
||||
## How-tos
|
||||
|
||||
- [How to read CSV files](how-to-read-csv-files.html)
|
||||
- [How to use account aliases](how-to-use-account-aliases.html)
|
||||
Most of this has been contributed to the new **[plaintextaccounting.org](http://plaintextaccounting.org)** site,
|
||||
but not yet eg the [accounting](#accounting) links.
|
||||
|
||||
## Blog posts & articles
|
||||
|
||||
|
||||
@ -2,6 +2,7 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
|
||||
<head profile="http://www.w3.org/2005/10/profile">
|
||||
<link rel="icon" type="image/png" href="/images/coins2.ico">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||||
@ -19,7 +20,12 @@
|
||||
<link href="/css/style.css" rel="stylesheet">
|
||||
<!-- <link href="/css/syntax.css" rel="stylesheet"> -->
|
||||
</head>
|
||||
|
||||
<body class="container">
|
||||
|
||||
<div class="row">
|
||||
<div class="col-md-1"></div>
|
||||
<div class="col-md-10">
|
||||
<nav class="navbar navbar-default" role="navigation">
|
||||
<div class="container-fluid">
|
||||
<div class="navbar-header">
|
||||
@ -34,17 +40,24 @@
|
||||
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
|
||||
<ul class="nav navbar-nav">
|
||||
<li><a href="download.html">Download</a>
|
||||
<li><a href="step-by-step.html">Tutorial</a>
|
||||
<li><a href="manual.html">Manual</a>
|
||||
<li><a href="developer-guide.html">Developer Guide</a>
|
||||
<li><a href="faq.html">FAQ</a>
|
||||
<li><a href="more-docs.html">More docs...</a>
|
||||
<li><a href="docs.html">Docs</a>
|
||||
<li><a href="developer-guide.html">Contribute</a>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="row">
|
||||
<div class="col-md-1"></div>
|
||||
<div class="col-md-10">
|
||||
$body$
|
||||
<footer>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
</footer>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -1,36 +1,41 @@
|
||||
* toc
|
||||
|
||||
# hledger step by step
|
||||
# hledger Step by Step
|
||||
|
||||
Here you can learn hledger (and a little
|
||||
[double-entry accounting](https://en.wikipedia.org/wiki/Double-entry_bookkeeping_system))
|
||||
by practicing, one hands-on exercise at a time (similar to the "Learn
|
||||
X the Hard Way" books.)
|
||||
Here you can learn hledger (and a little double-entry bookkeeping)
|
||||
by practicing, one hands-on exercise at a time. You'll need:
|
||||
|
||||
You'll learn the most if you work through each small step in order.
|
||||
If a step specifies no particular task, your task is to run the examples and understand it.
|
||||
1. A little familiarity with
|
||||
the [command](http://tutorial.djangogirls.org/en/intro_to_command_line/index.html)
|
||||
[line](https://en.flossmanuals.net/command-line/).
|
||||
Or, the ability to ask for help on the IRC channel.
|
||||
|
||||
If you get stuck, or have any other feedback, report it on IRC or the mail list, or send a pull request for this page.
|
||||
2. hledger. [Download](download.html) and install it if you haven't already.
|
||||
|
||||
You'll need:
|
||||
|
||||
1. A basic understanding of the command line, text file editing, and regular expressions. Or, the ability to ask for help on the IRC channel.
|
||||
|
||||
2. hledger (see [Download](download.html)). These exercises were last tested with hledger 0.26.
|
||||
You'll learn the most if you master each small step, in order. Most
|
||||
steps give you a task with a clear goal; if not, your task is to run
|
||||
the examples and understand them.
|
||||
|
||||
If you get stuck, find a problem, or have feedback, please report it on the
|
||||
[IRC channel or mail list](developer-guide.html#quick-links),
|
||||
or send a pull request for this page.
|
||||
|
||||
Let's get started!
|
||||
|
||||
<div class="clearfix"></div>
|
||||
## SETUP
|
||||
|
||||
### Check your hledger installation
|
||||
|
||||
Get a command prompt, and run hledger to check the version. It should be reasonably [up to date](release-notes.html):
|
||||
Get a command prompt, and run hledger to check the version. It should be reasonably [up to date](release-notes.html). These exercises were last tested with this version:
|
||||
|
||||
```shell
|
||||
$ hledger --version
|
||||
hledger 0.26
|
||||
```
|
||||
|
||||
|
||||
|
||||
## BASIC DATA ENTRY & REPORTING
|
||||
|
||||
### Locate your journal file with "hledger stats"
|
||||
|
||||
Loading…
Reference in New Issue
Block a user