slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

site: simplify, clean up, refresh

Browse Source 
- 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 2016-02-21 12:39:32 -08:00
parent 848309c3f9
commit 671ade5062
11 changed files with 236 additions and 156 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
site/.gitignore vendored
View File

@ -1,3 +1,4 @@
hakyll-std
_cache _cache
_site _site
files/downloads files/downloads

4
site/css/style.css
View File

@ -67,7 +67,9 @@ pre {
.right { .right {
float: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 */ /* from https://github.com/blaenk/blaenk.github.io/blob/source/provider/scss/_article.scss */
#toc { #toc {
max-width:40%; max-width:40%;

88
site/docs.md Normal file
View 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>

18
site/download.md
View File

@ -1,13 +1,14 @@
<div style="float:right; text-align:right; white-space:nowrap; "> <div style="float:right; text-align:right; white-space:nowrap; ">
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&amp;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&amp;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 style="margin-left:3px;" href="https://flattr.com/submit/auto?user_id=simonmichael&amp;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> <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&amp;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;"> <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> <script data-gratipay-username="simonmichael" data-gratipay-widget="button" src="//grtp.co/v1.js"></script>
</div> </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> &nbsp;
</div> </div>
# Download # Download
**[Release notes](release-notes.html)** ### [Release notes](release-notes.html)
<a name="packaged"></a> <a name="packaged"></a>
@ -16,7 +17,8 @@
<style> <style>
tr { vertical-align:top; } tr { vertical-align:top; }
td { padding-bottom:1em; padding-right:1em; } td { padding-bottom:.5em; padding-right:1em; }
a { white-space:nowrap; }
</style> </style>
<table> <table>
@ -30,7 +32,7 @@ Download, unzip, and run
<!-- (or the [32-bit build](http://hledger.org/downloads/hledger-0.26-win32.zip)) --> <!-- (or the [32-bit build](http://hledger.org/downloads/hledger-0.26-win32.zip)) -->
and/or and/or
[hledger-web-0.26-win64.zip](http://hledger.org/downloads/hledger-web-0.26-win64.zip) [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> </td></tr>
<tr><td> <tr><td>
@ -39,7 +41,7 @@ and/or
`brew install hledger` `brew install hledger`
</td></tr> </td></tr>
<tr><td> <tr><td style="white-space:nowrap;">
**on Debian or Ubuntu** **on Debian or Ubuntu**
</td><td> </td><td>
`apt-get install hledger hledger-web` `apt-get install hledger hledger-web`
@ -59,7 +61,7 @@ and/or
<tr><td> <tr><td>
**on NixOS** **on NixOS**
</td><td style="white-space:nowrap;"> </td><td>
`nix-env -iA nixpkgs.haskellPackages.hledger nixpkgs.haskellPackages.hledger-web` `nix-env -iA nixpkgs.haskellPackages.hledger nixpkgs.haskellPackages.hledger-web`
</td></tr> </td></tr>

14
site/faq.md
View File

@ -58,14 +58,6 @@ the [ledger-cli.org](http://ledger-cli.org) site,
IRC support on #ledger, IRC support on #ledger,
and now [plaintextaccounting.org](http://plaintextaccounting.org). 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 ### Features
Compared to Ledger, hledger builds quickly and has a complete and 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 first). hledger requires the fixed lot price to come last (and
ignores it). 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 ## UI surprises

156
site/index.md
View File

@ -5,26 +5,28 @@ title: home
<style> <style>
.highslide img {max-width:200px; float:right; margin:0 0 1em 1em;} .highslide img {max-width:200px; float:right; margin:0 0 1em 1em;}
.highslide-caption {color:white; background-color:black;} .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> </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 panel-primary">
<div class="panel-heading"> <div class="panel-heading">
<h2 class="panel-title">Get started</h2> <h2 class="panel-title">Get started</h2>
</div> </div>
<div class="panel-body"> <div class="panel-body">
**[Install](download.html)**, **[Download](download.html)**,
read the read the
**[release notes](release-notes.html)**, **[release notes](release-notes.html)**,
**[tutorial](step-by-step.html)**, **[tutorial](step-by-step.html)**,
or **[manual](manual.html)**, or **[manual](docs.html)**,
<!-- or **[blog posts](more-docs.html#blog-posts-articles)**, -->
try the **[web UI](http://demo.hledger.org)**, try the **[web UI](http://demo.hledger.org)**,
introduce yourself and tell us what's good/bad.. introduce yourself and tell us what's good/bad..
@ -36,70 +38,72 @@ tr {
</style> </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&nbsp;&nbsp; | via [google](http://list.hledger.org) or [gmane](http://news.gmane.org/gmane.comp.finance.ledger.hledger) | Mail list&nbsp;&nbsp; | 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> | 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) | 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...&nbsp;&nbsp; | [quick links](http://hledger.org/developer-guide.html#quick-links) --> <!-- | More...&nbsp;&nbsp; | [quick links](http://hledger.org/developer-guide.html#quick-links) -->
<!-- | web UI demo | [demo.hledger.org](http://demo.hledger.org) | --> <!-- | 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) --> <!-- [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&amp;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&amp;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>
</div> <!-- end of get started box --> <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> &nbsp;
</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&amp;hosted_button_id=5J33NLXYXCYAY"><img border=0 src="https://www.paypal.com/en_US/i/btn/x-click-but04.gif" alt="paypal"></a> &nbsp;\
<!-- <div style="display:inline; position:relative; top:6px;"><script data-gratipay-username="simonmichael" data-gratipay-widget="button" src="//grtp.co/v1.js"></script></div> &nbsp; -->
<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> &nbsp;
<a href="https://flattr.com/submit/auto?user_id=simonmichael&amp;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> &nbsp;
<!-- Also testimonials, examples, blogging, packaging, and patches. -->
</div> <!-- end of donate buttons --> </div> <!-- end of donate buttons -->
</div> <!-- end of second top-right area -->
<!-- main content --> <!-- 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> <h1 style="font-size:6em;">hledger</h1>
<img src="/images/coins2-248.png" width="" height="200" style="float:right; margin:1em 1em 0 1em;" /> <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;"> <h2 style="margin-top:0; margin-bottom:.5em;">
<!-- Making accounting fun for techies. --> <!-- Making accounting fun for techies. -->
Simple, precise, future-proof accounting for techies. Simple, precise, plain text accounting.
<!-- Plain text accounting for everyone. -->
</h2> </h2>
<div style="font-size:medium;"> <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 other commodities, on unix, mac and windows. With simple yet powerful
functionality accessed from command line, terminal or web browser, it is a 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, <div class="indent0">
hledger's add command, the web interface, CSV or OFX import, custom scripts..) ### plain text ? How does that work ?
**Step 2:** Ask hledger about your accounts, currencies, balances, **Step 1:**
monthly averages, market values and more. 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 **Step 2:**
more about double-entry accounting. You'll feel closer to your Ask hledger about your accounts.. transactions.. balances.. currencies.. monthly averages.. budgets.. market values..
finances, and accounting becomes fun. [Try it!](step-by-step.html) 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: --> <!-- 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 --> <!-- - getting accurate numbers for client billing and tax filing -->
<!-- - tracking invoices --> <!-- - tracking invoices -->
<!-- - building financial and time clarity and serenity --> <!-- - building financial and time clarity and serenity -->
</div>
<div class="indent1"> <div class="indent1">
### Free&nbsp;software ### hledger is Free software
hledger is Free software released under GNU GPLv3+, which helps ensure <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>
its longevity. It has been developed by hledger is Free software, created by [Simon Michael](http://joyful.com)
[Simon Michael](http://joyful.com) and contributors since 2007. and released under GNU GPLv3+.
[![license](https://img.shields.io/badge/license-GPLv3+-brightgreen.svg)](http://www.gnu.org/licenses/gpl.html)
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>
<div class="indent2"> <div class="indent2">
### inspired by Ledger ### inspired by Ledger
hledger is a Haskell reimplementation of the excellent [Ledger](faq.html#hledger-and-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 - It remains substantially compatible with Ledger, and if you wish you can keep your data compatible with both.
and it is part of the enthusiastic and growing *ledger community.
Read more about the differences in the [FAQ](faq.html#hledger-and-ledger). Read more about the differences in the [FAQ](faq.html#hledger-and-ledger).
</div> </div>
<div class="indent0"> <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> <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&nbsp;interface](manual#ui) hledger also provides a curses-style [console&nbsp;interface](manual#ui)
that lets you review account balances and transactions with fewer that lets you review account balances and transactions quickly and without fuss.
keystrokes and less effort ([screencast](https://asciinema.org/a/29665)). ([screencast](https://asciinema.org/a/29665))
</div> </div>
<div class="indent2"> <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> <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 And, a zero-setup [web&nbsp;interface](manual.html#web)
[web&nbsp;interface](manual.html#web) ([demo](http://demo.hledger.org); press `s` to open the sidebar),
([demo](http://demo.hledger.org)), for assisted data entry and point for assisted data entry and a more point-and-click experience.
and click reporting. The web and command-line/curses interfaces can be used You can set up your own private or shared web instance with a few
simultaneously. clicks at [Sandstorm](https://apps.sandstorm.io/app/8x12h6p0x0nrzk73hfq6zh2jxtgyzzcty7qsatkg7jfg2mzw5n90).
</div> </div>
<div class="indent3"> <div class="indent3">
@ -199,26 +208,29 @@ power of text files, revision control, scriptability and double entry
accounting. accounting.
I've been using hledger daily and improving it since 2007. 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 I needed a tool like this badly, and I hope it will keep growing and
helping others to transform their financial lives. helping folks to transform their financial lives.
If you feel the same way, join us! If you feel the same way, join us!
</div> </div>
</div> <!-- end of large text --> <div class="indent1">
### fully documented
<!-- end of main content --> Time to check out those **[docs](docs.html)**,
or maybe **[look deeper](developer-guide.html)**.
<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 -->
</div> </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>

39
site/manual2.md
View File

@ -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&nbsp;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>

6
site/more-docs.md
View File

@ -2,10 +2,8 @@
# More docs... # More docs...
## How-tos Most of this has been contributed to the new **[plaintextaccounting.org](http://plaintextaccounting.org)** site,
but not yet eg the [accounting](#accounting) links.
- [How to read CSV files](how-to-read-csv-files.html)
- [How to use account aliases](how-to-use-account-aliases.html)
## Blog posts & articles ## Blog posts & articles

27
site/site.tmpl
View File

@ -2,6 +2,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head profile="http://www.w3.org/2005/10/profile"> <head profile="http://www.w3.org/2005/10/profile">
<link rel="icon" type="image/png" href="/images/coins2.ico"> <link rel="icon" type="image/png" href="/images/coins2.ico">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <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/style.css" rel="stylesheet">
<!-- <link href="/css/syntax.css" rel="stylesheet"> --> <!-- <link href="/css/syntax.css" rel="stylesheet"> -->
</head> </head>
<body class="container"> <body class="container">
<div class="row">
<div class="col-md-1"></div>
<div class="col-md-10">
<nav class="navbar navbar-default" role="navigation"> <nav class="navbar navbar-default" role="navigation">
<div class="container-fluid"> <div class="container-fluid">
<div class="navbar-header"> <div class="navbar-header">
@ -34,17 +40,24 @@
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1"> <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav"> <ul class="nav navbar-nav">
<li><a href="download.html">Download</a> <li><a href="download.html">Download</a>
<li><a href="step-by-step.html">Tutorial</a> <li><a href="docs.html">Docs</a>
<li><a href="manual.html">Manual</a> <li><a href="developer-guide.html">Contribute</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>
</ul> </ul>
</div> </div>
</div> </div>
</nav> </nav>
</div>
</div>
<div class="row">
<div class="col-md-1"></div>
<div class="col-md-10">
$body$ $body$
<footer> </div>
</footer> </div>
<footer>
</footer>
</body> </body>
</html> </html>

33
site/step-by-step.md
View File

@ -1,36 +1,41 @@
* toc * toc
# hledger step by step # hledger Step by Step
Here you can learn hledger (and a little Here you can learn hledger (and a little double-entry bookkeeping)
[double-entry accounting](https://en.wikipedia.org/wiki/Double-entry_bookkeeping_system)) by practicing, one hands-on exercise at a time. You'll need:
by practicing, one hands-on exercise at a time (similar to the "Learn
X the Hard Way" books.)
You'll learn the most if you work through each small step in order. 1. A little familiarity with
If a step specifies no particular task, your task is to run the examples and understand it. 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: 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
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. the examples and understand them.
2. hledger (see [Download](download.html)). These exercises were last tested with hledger 0.26.
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 ## SETUP
### Check your hledger installation ### 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 ```shell
$ hledger --version $ hledger --version
hledger 0.26 hledger 0.26
``` ```
## BASIC DATA ENTRY & REPORTING ## BASIC DATA ENTRY & REPORTING
### Locate your journal file with "hledger stats" ### Locate your journal file with "hledger stats"