site: new simpler docs page
This docs page is less verbose, and should make it easier to know what you should read next, and what you don't need to read. The reference docs are still in flux, with three alternatives presented: 1. the old manual, 2. the new individual man pages, and 3. the new manual which combines the man pages. At this point I think that 2 will get top billing, 3 will also be provided, and 1 will be dropped when 2/3 are a bit better.
This commit is contained in:
Simon Michael
parent
775ab2fd4e
commit
ed1122fec1
151
site/docs.md
151
site/docs.md
@ -10,88 +10,115 @@ margin-bottom:0.2em;
|
||||
</style>
|
||||
|
||||
<div class="container">
|
||||
|
||||
<div class="row">
|
||||
<div class="col-sm-5">
|
||||
## Intro
|
||||
<div class="col-sm-3">
|
||||
|
||||
**Getting started**
|
||||
|
||||
#### [Home](index.html)
|
||||
What is hledger, and what can it do for you ?
|
||||
|
||||
#### [Download](download.html)
|
||||
How to get hledger installed.
|
||||
How to get it.
|
||||
|
||||
#### [Step by Step Tutorial](step-by-step.html)
|
||||
Small, guided exercises introducing data entry, reporting, and accounting.
|
||||
|
||||
#### [FAQ](faq.html)
|
||||
Some questions and answers, mostly comparing hledger and Ledger.
|
||||
#### [Release Notes](release-notes.html)
|
||||
|
||||
**Examples:**
|
||||
#### [FAQ](faq.html)
|
||||
|
||||
</div>
|
||||
<div class="col-sm-4">
|
||||
|
||||
**Reference**
|
||||
|
||||
Take your pick:
|
||||
|
||||
#### 1. [Old manual](manual.html)
|
||||
|
||||
#### 2. New man pages
|
||||
|
||||
<div style="margin-left:1em;">
|
||||
|
||||
Tools:
|
||||
|
||||
<!-- **[hledger](manual2.html#hledger)** -->
|
||||
|
||||
<!-- **[hledger-ui](manual2.html#hledger-ui)** -->
|
||||
|
||||
<!-- **[hledger-web](manual2.html#hledger-web)** -->
|
||||
|
||||
<!-- **[hledger-api](manual2.html#hledger-api)** -->
|
||||
|
||||
#### [hledger](hledger.html)
|
||||
<!-- The main reporting tool and command-line interface. -->
|
||||
|
||||
#### [hledger-ui](hledger-ui.html)
|
||||
<!-- A curses-style UI for quick exploration. -->
|
||||
|
||||
#### [hledger-web](hledger-web.html)
|
||||
<!-- A web UI for browsing and data entry, personal or shared. -->
|
||||
|
||||
#### [hledger-api](hledger-api.html)
|
||||
<!-- A REST-y JSON and file server, good for building client-side UIs. -->
|
||||
|
||||
File formats:
|
||||
|
||||
<!-- **[Journal](manual2.html#journal-format)** -->
|
||||
|
||||
<!-- **[CSV](manual2.html#csv-format)** -->
|
||||
|
||||
<!-- **[Timeclock](manual2.html#timelog-format)** -->
|
||||
|
||||
<!-- **[Timedot](manual2.html#timedot-format)** -->
|
||||
|
||||
#### [Journal](journal.html)
|
||||
<!-- hledger's primary data format, representing a general journal. -->
|
||||
|
||||
#### [CSV](csv.html)
|
||||
<!-- How hledger reads Comma Separated Value data. -->
|
||||
|
||||
#### [Timeclock](timelog.html)
|
||||
<!-- Timeclock format, a sequence of clock-in/clock-out records. -->
|
||||
|
||||
#### [Timedot](timedot.html)
|
||||
<!-- Timedot format, an alternative time logging format. -->
|
||||
|
||||
</div>
|
||||
|
||||
#### 3. [New man pages, one page](manual2.html)
|
||||
|
||||
</div>
|
||||
<div class="col-sm-3">
|
||||
|
||||
**More**
|
||||
|
||||
#### [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.
|
||||
|
||||
#### [How to use another account separator character](how-to-use-another-account-separator-character.html)
|
||||
Writing `some.sub.account` instead of `some:sub:account`.
|
||||
|
||||
**General info:**
|
||||
|
||||
#### [More docs](more-docs.html)
|
||||
Some useful links, eg on accounting, not yet moved to...
|
||||
Some useful links not yet moved to..
|
||||
|
||||
#### [plaintextaccounting.org](http://plaintextaccounting.org)
|
||||
A comprehensive collection of resources and practices from the plain text accounting community
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="col-sm-5">
|
||||
## Reference
|
||||
|
||||
#### [User Manual](manual.html)
|
||||
The hledger reference manual, all on one page.
|
||||
|
||||
Or, as man pages (work in progress):
|
||||
|
||||
<div style="padding-left:1em;">
|
||||
|
||||
#### [hledger(1)](hledger.html)
|
||||
The main reporting tool and command-line interface.
|
||||
|
||||
#### [hledger-ui(1)](hledger-ui.html)
|
||||
A curses-style UI for quick exploration.
|
||||
|
||||
#### [hledger-web(1)](hledger-web.html)
|
||||
A web UI for browsing and data entry, personal or shared.
|
||||
|
||||
#### [hledger-api(1)](hledger-api.html)
|
||||
A REST-y JSON and file server, good for building client-side UIs.
|
||||
|
||||
**File formats:**
|
||||
|
||||
#### [hledger_journal(5)](journal.html)
|
||||
hledger's primary data format, representing a general journal.
|
||||
|
||||
#### [hledger_csv(5)](csv.html)
|
||||
How hledger reads Comma Separated Value data.
|
||||
|
||||
#### [hledger_timelog(5)](timelog.html)
|
||||
Timeclock format, a sequence of clock-in/clock-out records.
|
||||
|
||||
#### [hledger_timedot(5)](timedot.html)
|
||||
Timedot format, an alternative time logging format.
|
||||
|
||||
**Combined:**
|
||||
|
||||
#### [All man pages](manual2.html)
|
||||
All hledger man pages on one web page.
|
||||
|
||||
</div>
|
||||
More tips and tools from the plain text accounting community
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="container">
|
||||
<div class="row">
|
||||
<div class="col-sm-4">
|
||||
|
||||
</div>
|
||||
<div class="col-sm-4">
|
||||
|
||||
** **
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
97
site/docs1.md
Normal file
97
site/docs1.md
Normal file
@ -0,0 +1,97 @@
|
||||
<!-- * 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">
|
||||
## Intro
|
||||
|
||||
#### [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.
|
||||
|
||||
#### [FAQ](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.
|
||||
|
||||
#### [How to use another account separator character](how-to-use-another-account-separator-character.html)
|
||||
Writing `some.sub.account` instead of `some:sub:account`.
|
||||
|
||||
**General info:**
|
||||
|
||||
#### [More docs](more-docs.html)
|
||||
Some useful links, eg on accounting, not yet moved to...
|
||||
|
||||
#### [plaintextaccounting.org](http://plaintextaccounting.org)
|
||||
A comprehensive collection of resources and practices from the plain text accounting community
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="col-sm-5">
|
||||
## Reference
|
||||
|
||||
#### [User Manual](manual.html)
|
||||
The hledger reference manual, all on one page.
|
||||
|
||||
Or, as man pages (work in progress):
|
||||
|
||||
<div style="padding-left:1em;">
|
||||
|
||||
#### [hledger(1)](hledger.html)
|
||||
The main reporting tool and command-line interface.
|
||||
|
||||
#### [hledger-ui(1)](hledger-ui.html)
|
||||
A curses-style UI for quick exploration.
|
||||
|
||||
#### [hledger-web(1)](hledger-web.html)
|
||||
A web UI for browsing and data entry, personal or shared.
|
||||
|
||||
#### [hledger-api(1)](hledger-api.html)
|
||||
A REST-y JSON and file server, good for building client-side UIs.
|
||||
|
||||
**File formats:**
|
||||
|
||||
#### [hledger_journal(5)](journal.html)
|
||||
hledger's primary data format, representing a general journal.
|
||||
|
||||
#### [hledger_csv(5)](csv.html)
|
||||
How hledger reads Comma Separated Value data.
|
||||
|
||||
#### [hledger_timelog(5)](timelog.html)
|
||||
Timeclock format, a sequence of clock-in/clock-out records.
|
||||
|
||||
#### [hledger_timedot(5)](timedot.html)
|
||||
Timedot format, an alternative time logging format.
|
||||
|
||||
**Combined:**
|
||||
|
||||
#### [All man pages](manual2.html)
|
||||
All hledger man pages on one web page.
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user