diff --git a/hledger-lib/hledger_journal.5.md b/hledger-lib/hledger_journal.5.md index 82d8c7d4e..b10e7f432 100644 --- a/hledger-lib/hledger_journal.5.md +++ b/hledger-lib/hledger_journal.5.md @@ -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: diff --git a/site/.gitignore b/site/.gitignore index 8f8b8ecf4..8935f8a3b 100644 --- a/site/.gitignore +++ b/site/.gitignore @@ -1,3 +1,4 @@ +hakyll-std _cache _site files/downloads diff --git a/site/css/style.css b/site/css/style.css index d72623e58..86032a595 100644 --- a/site/css/style.css +++ b/site/css/style.css @@ -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%; diff --git a/site/docs.md b/site/docs.md new file mode 100644 index 000000000..7f42a7787 --- /dev/null +++ b/site/docs.md @@ -0,0 +1,88 @@ + + +# Documentation + + + +
+ +
+
+## 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 + + + + +
+
+## 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. + +
+
+ +
+ diff --git a/site/download.md b/site/download.md index 8d2bc4590..1ff04b840 100644 --- a/site/download.md +++ b/site/download.md @@ -1,13 +1,14 @@
-paypal -Flattr this -
+ + +
+  
# Download -**[Release notes](release-notes.html)** +### [Release notes](release-notes.html) @@ -16,7 +17,8 @@ @@ -30,7 +32,7 @@ Download, unzip, and run and/or [hledger-web-0.26-win64.zip](http://hledger.org/downloads/hledger-web-0.26-win64.zip) -
(The current release is 0.27. To contribute binaries for windows or mac, please get in touch.) +(The current release is 0.27. To contribute binaries for windows or mac, please get in touch.) - diff --git a/site/faq.md b/site/faq.md index ac6766b13..0e552085c 100644 --- a/site/faq.md +++ b/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 diff --git a/site/index.md b/site/index.md index 5d95daa71..dbdded8af 100644 --- a/site/index.md +++ b/site/index.md @@ -5,26 +5,28 @@ title: home -
- -
-
+ - + +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 { | |---------------------------|------------------------------------------------------------------------- -| IRC | [#hledger](http://irc.hledger.org) +| 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), @LedgerTips | Github | [code](http://github.com/simonmichael/hledger), [bugs](http://bugs.hledger.org), [issues](http://issues.hledger.org) +--> + + + + + + +
+ + +
+
-
- -
- -
- -
- -paypal  \ - -bountysource   -Flattr this   - +  
-
- -

hledger

-Simple, precise, future-proof accounting for techies. +Simple, precise, plain text accounting. +

-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..) +
+### 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..) + + + -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! @@ -108,23 +112,28 @@ finances, and accounting becomes fun. [Try it!](step-by-step.html) +
-### 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. -[![license](https://img.shields.io/badge/license-GPLv3+-brightgreen.svg)](http://www.gnu.org/licenses/gpl.html) + +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.
### 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). + + +
@@ -145,8 +154,8 @@ transactions, but does not change existing ones.) 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))
@@ -154,11 +163,11 @@ keystrokes and less effort ([screencast](https://asciinema.org/a/29665)). -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).
@@ -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!
-
+
+### fully documented - - -
- - - -
-### Latest tweets about hledger and Ledger: - - -
+Time to check out those **[docs](docs.html)**, +or maybe **[look deeper](developer-guide.html)**.
-
+
+ + +
+ +
+### Recent related tweets: + + +
+ +
diff --git a/site/manual2.md b/site/manual2.md deleted file mode 100644 index 568adf492..000000000 --- a/site/manual2.md +++ /dev/null @@ -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. - -
-
-
- -## 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) - -
-
- -## 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) - -
-
-
diff --git a/site/more-docs.md b/site/more-docs.md index 06365b204..4b3257755 100644 --- a/site/more-docs.md +++ b/site/more-docs.md @@ -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 diff --git a/site/site.tmpl b/site/site.tmpl index b8cde5254..5524cc002 100644 --- a/site/site.tmpl +++ b/site/site.tmpl @@ -2,6 +2,7 @@ + @@ -19,7 +20,12 @@ + + +
+
+
+
+
+ +
+
+
$body$ -
-
+
+
+ +
+
+ diff --git a/site/step-by-step.md b/site/step-by-step.md index 205dd9971..d9cfa4054 100644 --- a/site/step-by-step.md +++ b/site/step-by-step.md @@ -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! +
## 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"
@@ -39,7 +41,7 @@ and/or `brew install hledger`
+
**on Debian or Ubuntu** `apt-get install hledger hledger-web` @@ -59,7 +61,7 @@ and/or
**on NixOS** - + `nix-env -iA nixpkgs.haskellPackages.hledger nixpkgs.haskellPackages.hledger-web`