From a7e2b3d4fb59206299434f92d6e256aae75ecd66 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Sat, 28 Apr 2018 11:46:42 -0700 Subject: [PATCH] site: make docs page the front page --- site/docs.md | 178 -------------------------- site/index.md | 340 +++++++++++++++++++++++-------------------------- site/intro.md | 196 ++++++++++++++++++++++++++++ site/site.tmpl | 1 - 4 files changed, 357 insertions(+), 358 deletions(-) delete mode 100644 site/docs.md create mode 100644 site/intro.md diff --git a/site/docs.md b/site/docs.md deleted file mode 100644 index 404db7c76..000000000 --- a/site/docs.md +++ /dev/null @@ -1,178 +0,0 @@ -# hledger docs - - - -
-
-
- -
-## Introduction - -### What is hledger? - -An enhanced, well-documented reimplementation of plain text accounting.\ -**[hledger intro](http://hledger.org)** - -### What is plain text accounting? - -Using plain text data formats and version control for robust, transparent accounting.\ -**[plaintextaccounting.org](http://plaintextaccounting.org)** - -### What is accounting? - -Tracking your use of valuable commodities, such as money or time, for increased awareness and effectiveness.\ -**[Selected accounting links](http://github.com/simonmichael/hledger/wiki/more-docs)** -
- -
-## Help/Feedback - -| -|-------------------|----------------------------------------------------------------------------| -| IRC: | [#hledger](http://irc.hledger.org) on Freenode -| Twitter: | [#hledger](https://twitter.com/search?q=%23hledger&src=typd&f=realtime), [#plaintextaccounting](https://twitter.com/search?q=%23plaintextaccounting&src=typd&f=realtime) -| Reddit: | [/r/plaintextaccounting](https://www.reddit.com/r/plaintextaccounting/) -| Mail list: | [list.hledger.org](http://list.hledger.org), [hledger@googlegroups.com](mailto:hledger@googlegroups.com) -| Issue
tracker: | [bugs.hledger.org](http://bugs.hledger.org) (bugs), [issues.hledger.org](http://issues.hledger.org) (all) -| Other: | [simon@joyful.com](mailto:simon@joyful.com) - - - -
- -
-
- -
-## Reference - -**[Release notes](release-notes.html)**\ -What's new in each hledger version. - -**[User manual](manual.html)**\ -The main hledger manuals combined on one page for easy searching. -Includes: - -
-[hledger](hledger.html)\ -the command-line UI - -[hledger-ui](hledger-ui.html)\ -a curses-style UI - -[hledger-web](hledger-web.html)\ -a web UI - -[hledger-api](hledger-api.html)\ -a HTTP JSON server - -[journal format](journal.html)\ -hledger's native file format - -[csv format](csv.html)\ -hledger's CSV import system - -[timeclock format](timeclock.html)\ -a file format for precise time logging - -[timedot format](timedot.html)\ -a file format for human-friendly approximate time logging -
-
- -
-
- -
-
- -## [User Cookbook](https://github.com/simonmichael/hledger/wiki/Home) - -### Getting started - -[hledger basics tutorial](https://github.com/simonmichael/hledger/wiki/hledger basics tutorial) -[Start a journal](https://github.com/simonmichael/hledger/wiki/Start a journal) -[Common journal entries](https://github.com/simonmichael/hledger/wiki/Common journal entries) -[hledger accounting concepts tutorial](https://github.com/simonmichael/hledger/wiki/hledger accounting concepts tutorial) -[FAQ](https://github.com/simonmichael/hledger/wiki/FAQ) - -### Data entry, import, management - -[Convert CSV files](https://github.com/simonmichael/hledger/wiki/Convert CSV files) -[Track changes with version control](https://github.com/simonmichael/hledger/wiki/Track changes with version control) -[Use another account separator character](https://github.com/simonmichael/hledger/wiki/Use another account separator character) - -### Reporting - -[hledger tags tutorial](https://github.com/simonmichael/hledger/wiki/hledger tags tutorial) -[Queries](https://github.com/simonmichael/hledger/wiki/Queries) -[Rewrite account names](https://github.com/simonmichael/hledger/wiki/Rewrite account names) - -### Accounting tasks - -[Budgeting and forecasting](https://github.com/simonmichael/hledger/wiki/Budgeting and forecasting) -[Project accounting](https://github.com/simonmichael/hledger/wiki/Project accounting) -[Track investments](https://github.com/simonmichael/hledger/wiki/Track investments) - -### Usage tips - -[Addons](https://github.com/simonmichael/hledger/wiki/Addons) -[Mobile apps](https://github.com/simonmichael/hledger/wiki/Mobile apps) -[Save frequently used options](https://github.com/simonmichael/hledger/wiki/Save frequently used options) - -### More.. - -[More docs](https://github.com/simonmichael/hledger/wiki/More docs) - -[plaintextaccounting.org](http://plaintextaccounting.org) - -[ledger‑likes](http://plaintextaccounting.org/#ledger-likes) - -[tools](http://plaintextaccounting.org/#related-tools) - -[docs](http://plaintextaccounting.org/#docs) - -[common tasks](http://plaintextaccounting.org/#common-tasks) - -[discussion](http://plaintextaccounting.org/#discussion) - -[ledger-cli.org](http://ledger-cli.org) - [docs](https://www.ledger-cli.org/docs.html) - [wiki](https://github.com/ledger/ledger/wiki) - -[Beancount's docs](http://furius.ca/beancount/doc/index) - -## [Dev Zone](https://github.com/simonmichael/hledger/wiki/dev/Dev Zone) - -
-
- -
-
-
diff --git a/site/index.md b/site/index.md index 364e6a494..404db7c76 100644 --- a/site/index.md +++ b/site/index.md @@ -1,196 +1,178 @@ ---- -title: home -... +# hledger docs - - -
-[![github](https://img.shields.io/github/stars/simonmichael/hledger.svg?style=social&label=Github){style="min-width:102;" title="Star us!"}](https://github.com/simonmichael/hledger/) -open collective backers -open collective sponsors - -bountysource -paypal +
+
+
+ +
+## Introduction + +### What is hledger? + +An enhanced, well-documented reimplementation of plain text accounting.\ +**[hledger intro](http://hledger.org)** + +### What is plain text accounting? + +Using plain text data formats and version control for robust, transparent accounting.\ +**[plaintextaccounting.org](http://plaintextaccounting.org)** + +### What is accounting? + +Tracking your use of valuable commodities, such as money or time, for increased awareness and effectiveness.\ +**[Selected accounting links](http://github.com/simonmichael/hledger/wiki/more-docs)**
- - -

hledger

- - - -

- - - -Robust, powerful, plain text accounting. -

- -
- -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 -dependable, cross-platform alternative to Quicken, GnuCash, spreadsheets etc. - -
-### plain text ? How does that work ? - -**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..) - - - - -**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)**. - -Read on for more about hledger, or if you're keen to get going, -**[download](download.html)** it and start the **[tutorial](step-by-step.html)** now! - - - - - - - - -
- -
-### hledger is Free software - - -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](https://github.com/simonmichael/hledger/wiki/FAQ#hledger--ledger). -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](https://github.com/simonmichael/hledger/wiki/FAQ#hledger--ledger). - +
+## Help/Feedback +| +|-------------------|----------------------------------------------------------------------------| +| IRC: | [#hledger](http://irc.hledger.org) on Freenode +| Twitter: | [#hledger](https://twitter.com/search?q=%23hledger&src=typd&f=realtime), [#plaintextaccounting](https://twitter.com/search?q=%23plaintextaccounting&src=typd&f=realtime) +| Reddit: | [/r/plaintextaccounting](https://www.reddit.com/r/plaintextaccounting/) +| Mail list: | [list.hledger.org](http://list.hledger.org), [hledger@googlegroups.com](mailto:hledger@googlegroups.com) +| Issue
tracker: | [bugs.hledger.org](http://bugs.hledger.org) (bugs), [issues.hledger.org](http://issues.hledger.org) (all) +| Other: | [simon@joyful.com](mailto:simon@joyful.com) + + + +
+
-
-### a command-line tool, that respects your data +
+## Reference - +**[Release notes](release-notes.html)**\ +What's new in each hledger version. -hledger is first a command-line tool. -Your data lives in a plain text journal file which you can edit -any way you wish; hledger reads that file and produces reports of -various kinds, without changing your data. (It can help you add new -transactions, but does not change existing ones.) +**[User manual](manual.html)**\ +The main hledger manuals combined on one page for easy searching. +Includes: + +
+[hledger](hledger.html)\ +the command-line UI + +[hledger-ui](hledger-ui.html)\ +a curses-style UI + +[hledger-web](hledger-web.html)\ +a web UI + +[hledger-api](hledger-api.html)\ +a HTTP JSON server + +[journal format](journal.html)\ +hledger's native file format + +[csv format](csv.html)\ +hledger's CSV import system + +[timeclock format](timeclock.html)\ +a file format for precise time logging + +[timedot format](timedot.html)\ +a file format for human-friendly approximate time logging +
- -
-### a console UI +
+
- -hledger also provides a curses-style [console interface](manual#ui) -that lets you review account balances and transactions quickly and without fuss. -([screencast](https://asciinema.org/a/29665)) +
+
+ +## [User Cookbook](https://github.com/simonmichael/hledger/wiki/Home) + +### Getting started + +[hledger basics tutorial](https://github.com/simonmichael/hledger/wiki/hledger basics tutorial) +[Start a journal](https://github.com/simonmichael/hledger/wiki/Start a journal) +[Common journal entries](https://github.com/simonmichael/hledger/wiki/Common journal entries) +[hledger accounting concepts tutorial](https://github.com/simonmichael/hledger/wiki/hledger accounting concepts tutorial) +[FAQ](https://github.com/simonmichael/hledger/wiki/FAQ) + +### Data entry, import, management + +[Convert CSV files](https://github.com/simonmichael/hledger/wiki/Convert CSV files) +[Track changes with version control](https://github.com/simonmichael/hledger/wiki/Track changes with version control) +[Use another account separator character](https://github.com/simonmichael/hledger/wiki/Use another account separator character) + +### Reporting + +[hledger tags tutorial](https://github.com/simonmichael/hledger/wiki/hledger tags tutorial) +[Queries](https://github.com/simonmichael/hledger/wiki/Queries) +[Rewrite account names](https://github.com/simonmichael/hledger/wiki/Rewrite account names) + +### Accounting tasks + +[Budgeting and forecasting](https://github.com/simonmichael/hledger/wiki/Budgeting and forecasting) +[Project accounting](https://github.com/simonmichael/hledger/wiki/Project accounting) +[Track investments](https://github.com/simonmichael/hledger/wiki/Track investments) + +### Usage tips + +[Addons](https://github.com/simonmichael/hledger/wiki/Addons) +[Mobile apps](https://github.com/simonmichael/hledger/wiki/Mobile apps) +[Save frequently used options](https://github.com/simonmichael/hledger/wiki/Save frequently used options) + +### More.. + +[More docs](https://github.com/simonmichael/hledger/wiki/More docs) + +[plaintextaccounting.org](http://plaintextaccounting.org) - +[ledger‑likes](http://plaintextaccounting.org/#ledger-likes) - +[tools](http://plaintextaccounting.org/#related-tools) - +[docs](http://plaintextaccounting.org/#docs) - +[common tasks](http://plaintextaccounting.org/#common-tasks) - +[discussion](http://plaintextaccounting.org/#discussion) + +[ledger-cli.org](http://ledger-cli.org) - [docs](https://www.ledger-cli.org/docs.html) - [wiki](https://github.com/ledger/ledger/wiki) + +[Beancount's docs](http://furius.ca/beancount/doc/index) + +## [Dev Zone](https://github.com/simonmichael/hledger/wiki/dev/Dev Zone) + +
-
-### a web UI - - - -And, a zero-setup -[web interface](manual.html#web) ( -[demo](http://demo.hledger.org)) for a more point-and-click experience. -You can also set up your own public/private web instance in a few clicks -at -[Sandstorm](https://apps.sandstorm.io/app/8x12h6p0x0nrzk73hfq6zh2jxtgyzzcty7qsatkg7jfg2mzw5n90). -
- -
-### a Haskell application and library - - - -hledger is written in Haskell, a modern, highly-regarded -programming language which contributes to hledger's robustness, -performance and long-term maintainability. Most functionality is -exposed as -[reusable](http://hackage.haskell.org/package/hledger-lib) -[Haskell](http://hackage.haskell.org/package/hledger) -[libraries](http://hackage.haskell.org/package/hledger-web), making it -easy to write your own hledger-compatible -[scripts](more-docs.html#scripting-examples), [add-ons](manual.html#add-ons) and -applications. -  [![build status (travis)](https://travis-ci.org/simonmichael/hledger.svg?branch=master)](https://travis-ci.org/simonmichael/hledger) -
- - - - - - - - - - - -
-### focussed on serving users - -hledger strives to be usable, practical and to provide real-world value. -Intuitive features, bug-free operation and complete, accurate documentation are top goals. -Currently it is particularly suited to techies, ie users who appreciate the -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 hope it will keep growing and -helping folks to transform their financial lives. -If you feel the same way, join us! - -
- -
-### fully documented - -Time to check out those **[docs](docs.html)**! - -
- -
- - -
-
-#### Tweets (#hledger OR #plaintextaccounting OR #ledgercli): - -
- - - +
+
+
diff --git a/site/intro.md b/site/intro.md new file mode 100644 index 000000000..364e6a494 --- /dev/null +++ b/site/intro.md @@ -0,0 +1,196 @@ +--- +title: home +... + + + + + +
+[![github](https://img.shields.io/github/stars/simonmichael/hledger.svg?style=social&label=Github){style="min-width:102;" title="Star us!"}](https://github.com/simonmichael/hledger/) +open collective backers +open collective sponsors + +bountysource +paypal +
+ + + +

hledger

+ + + +

+ + + +Robust, powerful, plain text accounting. +

+ +
+ +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 +dependable, cross-platform alternative to Quicken, GnuCash, spreadsheets etc. + +
+### plain text ? How does that work ? + +**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..) + + + + +**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)**. + +Read on for more about hledger, or if you're keen to get going, +**[download](download.html)** it and start the **[tutorial](step-by-step.html)** now! + + + + + + + + +
+ +
+### hledger is Free software + + +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](https://github.com/simonmichael/hledger/wiki/FAQ#hledger--ledger). +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](https://github.com/simonmichael/hledger/wiki/FAQ#hledger--ledger). + + + +
+ +
+### a command-line tool, that respects your data + + + +hledger is first a command-line tool. +Your data lives in a plain text journal file which you can edit +any way you wish; hledger reads that file and produces reports of +various kinds, without changing your data. (It can help you add new +transactions, but does not change existing ones.) +
+ + +
+### a console UI + + +hledger also provides a curses-style [console interface](manual#ui) +that lets you review account balances and transactions quickly and without fuss. +([screencast](https://asciinema.org/a/29665)) +
+ +
+### a web UI + + + +And, a zero-setup +[web interface](manual.html#web) ( +[demo](http://demo.hledger.org)) for a more point-and-click experience. +You can also set up your own public/private web instance in a few clicks +at +[Sandstorm](https://apps.sandstorm.io/app/8x12h6p0x0nrzk73hfq6zh2jxtgyzzcty7qsatkg7jfg2mzw5n90). +
+ +
+### a Haskell application and library + + + +hledger is written in Haskell, a modern, highly-regarded +programming language which contributes to hledger's robustness, +performance and long-term maintainability. Most functionality is +exposed as +[reusable](http://hackage.haskell.org/package/hledger-lib) +[Haskell](http://hackage.haskell.org/package/hledger) +[libraries](http://hackage.haskell.org/package/hledger-web), making it +easy to write your own hledger-compatible +[scripts](more-docs.html#scripting-examples), [add-ons](manual.html#add-ons) and +applications. +  [![build status (travis)](https://travis-ci.org/simonmichael/hledger.svg?branch=master)](https://travis-ci.org/simonmichael/hledger) +
+ + + + + + + + + + + +
+### focussed on serving users + +hledger strives to be usable, practical and to provide real-world value. +Intuitive features, bug-free operation and complete, accurate documentation are top goals. +Currently it is particularly suited to techies, ie users who appreciate the +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 hope it will keep growing and +helping folks to transform their financial lives. +If you feel the same way, join us! + +
+ +
+### fully documented + +Time to check out those **[docs](docs.html)**! + +
+ +
+ + +
+
+#### Tweets (#hledger OR #plaintextaccounting OR #ledgercli): + +
+ + + diff --git a/site/site.tmpl b/site/site.tmpl index 88bdf6a19..379cc2ec2 100644 --- a/site/site.tmpl +++ b/site/site.tmpl @@ -49,7 +49,6 @@