simonmichael / hledger_site Goto Github PK
View Code? Open in Web Editor NEWThe repo for hledger.org, the hledger project's website.
License: GNU General Public License v3.0
The repo for hledger.org, the hledger project's website.
License: GNU General Public License v3.0
This is hledger_site, the repo for the hledger.org website. It contains most of the source files for the hledger.org website. This repo was created in 2019 by combining the site/ subfolder previously in the main hledger repo, and the github wiki, preserving the essential histories of both (though for the true original history of site/ up to 2019/08, see the main hledger repo.) It is intended to be cloned as the "site" subdirectory of the main hledger repo. Currently this is done manually, not via git submodule or subtree. In 2021, this site was converted from sphinx to mdbook. Site configuration is in book.toml. Some static assets are kept in css/, theme/, js/ and highslide/. A few more assets and most of the site's content source is in src/. Some hledger docs are kept in the main hledger repo, and included in the website via symbolic links in src/. These are: - developer docs like CONTRIBUTING.md and README.md. (The latter is linked as src/dev-README.md so mdbook and github don't give it special treatment.) - the hledger/hledger-ui/hledger-web user manuals (web versions). These should be generated/updated before rendering the website, by doing "make Shake && ./Shake" webmanuals in the main hledger repo. To render the latest site content (in out/): make To render the latest content (in out/), and the old versions of the user manuals, and the latest dev version of the manual (in out2/, built separately due to mdbook limitations): make buildall
The hledger manual has a broken link in the section https://hledger.org/1.34/hledger.html#journal
at paragraph 3:
differences and interoperation tips are described at [hledger and Ledger]
That linke to 1.34/ledger.html ... but 404.
When I search the docs, i only care about a specific version. I don't know how to select the version i'm interested in (hint: there should be an obvious one), so I just type something in the search field of hledger.org (say, cookbook
), and here is what I see
the list is polluted with matches from previous versions
Even if one decided to keep matches from all versions, the matches have no indication of the version they relate to, this is really annoying.
The current mdbook site does not handle duplicated headings on a page well. Eg https://hledger.org/hledger.html has a Tags section under COMMANDS (https://hledger.org/hledger.html#tags) and also under JOURNAL FORMAT (https://hledger.org/hledger.html#tags-1). Distinct anchors are created, but links in the page TOC and in search results all point to the first (https://hledger.org/hledger.html#tags). This is quite confusing.
rust-lang/mdBook#1493
[See also simonmichael/hledger#1534.]
I searched for hledger documentation on Google, and got these results:
The first result leads to https://hledger.org/MANUAL.html . That URL redirects to https://hledger.org/hledger.html , which redirects in turn to https://hledger.org/1.29/hledger.html , which gives a 404 error.
The second result is https://hledger.org/hledger-ui.html , which redirects to https://hledger.org/1.29/hledger-ui.html , which gives a 404 error.
I think it would be useful if the old URLs redirected to useful pages.
I have an issue with the following transaction
2022-01-01 Bitcoins
assets:binance:wallet USDT-500.00
assets:binance:crypto 0.01335609 BTC @ USDT37436.1
If you calculate the value of transaction in the 2nd account it equals 499.999920849
In order to get the correct value, the unit price should be as follows
2022-01-01 Bitcoins
assets:binance:wallet USDT-500.00
assets:binance:crypto 0.01335609 BTC @ USDT37436.10592621044
I got this number by running the division in the haskell ghc.
I can solve this by doing @@ total_price
instead of @ unit_price
, but I kind of lose that unit price value in the journal.
Any suggestions ?
From: https://hledger.org/start.html
Clearly just a hang-over from some re-organisation, but I can't even guess where this should be referring to; perhaps it can become a link?
These parameters are not available for version 1.21:
gander@toast ~/.hledger/load_from_here (master)
$ hledger --version
hledger 1.21
gander@toast ~/.hledger/load_from_here (master)
$ hledger --declare payees
hledger: Unknown flag: --declare (use -h to see usage)
gander@toast ~/.hledger/load_from_here (master)
$ hledger --used payees
hledger: Unknown flag: --used (use -h to see usage)
but are listed in the help:
hledger payees -h
payees [OPTIONS] [QUERY]
List the unique payee/payer names that appear in transactions.
Flags:
--declared show payees declared with payee
directives
--used show payees referenced by
transactions
Hi, according to the documentation, the print command should omit comments, but I am getting inline comments. Stand alone comments are in fact omitted. If this is expected behavior, can someone suggest a way to remove in line comments with hledger? (Otherwise I'll be forced to use sed).
cat <<EOF | hledger -f - print
2018/01/01 * "Income" ; comment 1
income 100 ; comment 2
expenses ; comment 3
; comment 4
EOF
Yields:
2018-01-01 * "Income" ; comment 1
income 100 ; comment 2
expenses ; comment 3
Link to the So, you want to learn Bookkeeping !
tutorial from Bean Counter is broken.
A computation that is important for business owners (especially bootstrapped entrepreneurs) is the burn rate, or rather it's complement, the runway, which is the answer to "how long can the company stay in business given the current recurring revenue and expenses".
I found the following to be useful:
hledger bal -b "today" --monthly --historical --forecast "Assets:Business"
Unfortunately I don't have the journal used in the existing documentation to run this query on it, but maybe you do, and show how this could help determine whether the business is a going concern, or a household can visualize when they'll enter the danger zone.
The month when the total drops below zero is the moment you're insolvent (or entering debt), and the count of month until then is how long you'd have to turn the company around or get new income, or cut expenses, or adjust budgets, or or or... very useful
https://hledger.org/command-line-completion.html
'source ~/.hledger-completion.bash'
this to the end of your ~/.bashrc file
.should be:
- Add the command `source ~/.hledger-completion.bash` to the end of your `~/.bashrc file`.
without the single quotes around the command. And no "this".
hledger_site/download.md windows binary is listed 1.16.1 but downloaded version is 1.15.2
*.hledger.org and other sites hosted on this server were down for a while and may have issues for a while longer.
Boring details: Linode did a migration causing a server restart. My old caddy 0.10.0 refuses to use the hledger.org TLS certificate because it is within 30 days of expiring (may 21). It can't get a new cert because 1. lets encrypt are doing a 3-day planned brownout of their acmev1 API; and 2. after upgrading caddy to 0.10.14 to use the acmev2 API, it can't pass the acme http challenge which requires the site to be up. (Maybe this is failing because it's running on a non-standard port ? because I need to keep other sites running for now.) The dns challenge method requires building a custom plugin. The third challenge method I do not understand. Doing anything with caddy 1 is painful as old downloads and docs are obfuscated. Upgrading to caddy 2 is of course the goal but it turns out to be much too difficult to do quickly. For now, sites are hopefully mostly working by disabling https on the server (Cloudflare proxying should still be enabling https in most cases).
The page https://hledger.org/support.html has a broken link for the item "open issues by category".
Probably intends to go to https://hledger.org/ISSUES.html
I use a no-symbol commodity for most postings since it's easier to type and takes less space in reports. It's easier but I have a problem with prices.
Let's say my default currency is Serbian dinar, RSD. When I try to set a market price I have a problem.
Eg, euro to dinars. One euro is 117,58 RSD. This way it's ok since I use symbol for euros:
P 2021/10/25 EUR 117,58
Now dinar to euros. I want to show that one dinar is 0,0085 euros. This way it's not possible:
P 2021/10/25 0,0085 EUR
Can it be done somehow?
https://hledger.org/1.21/hledger.html#auto-detected-account-types
Screenshot:
Looks like this is because mdBook uses¹ Github-flavored Markdown syntax for tables, so |
needs to be escaped in table cells.
Syntax reference: https://github.github.com/gfm/#example-200
¹ This actually took a bit of digging to confirm, but mdBook docs say it uses the pulldown-cmark
crate whose readme says it accepts GFM-style tables.
Hi, I'm trying to open https://hledger.org/, it is accessible but shows empty page.
Literal blocks have an invisible component spanning the full page width (see the position of the copy icon), which eg in this example makes the TOC links to the right unclickable:
Related: #82
Hi team
I am just starting to work with hledger which works great for me thus far.
I have a quick issue with the roi command. After the below declaration:
hledger roi -f personal.journal --investment assets:Investments -Q --cost --value=then,"$" --infer-market-price --pnl "unrealized"
I get an error message:
hledger: Amounts could not be converted to a single cost basis
I am using a separate .prices file for ease of data management which works a charm with commands like 'bs' or 'is' but does not seem to work with 'roi'.
My declaration of the price file is:
include personal.prices
Is this a known issue or is there a declaration I am not instructing 'roi' properly?
Many thanks in advance
M
My config below:
hledger 1.22.2, mac-x86_64
https://hledger.org/?search=not: should find not:
at https://hledger.org/hledger.html#queries (reported on chat).
https://hledger.org/download.html mentions that I can test my installation with hledger iadd --version
, but this results in:
hledger: command iadd is not recognized, run with no command to see a list
I'm assuming iadd
has been renamed to add
(as hledger add --version
does work1), but I could be wrong.
I am on macOS Catalina and I installed hledger with brew install hledger
.
Cheers! 👋
However it only shows the hledger
version, not the hledger add
version, if that would even be a thing? ↩
Hey team-
Just noticed that https://hledger.org/1.21/timedot.html gives a blank page. Turning to the network tab in my browser dev tools shows the page is missing:
Maybe this issue is more about establishing an informative 404 page; not sure if mdbook has support for this out of the box, but it might help readers navigate out of the above situation in the future.
Thanks!
on https://hledger.org/journal.html?highlight=aliases#rewriting-accounts following the link
See also [Cookbook: Rewrite account
names](https://github.com/simonmichael/hledger/wiki/Rewrite-account-names).
leads to the github project page for hledger
I expected a journal.md
to be present in the top-level of this project, but couldn't find it.
Knowing where journal.md is located for the hledger master branch, i would modify it to point to
[Cookbook: Rewrite account
names](rewrite-account-names.html)
Expense account type should be singular here
Save the example in a journal file and run hledger stats
account assets ; type:Asset
account liabilities ; type:Liability
account equity ; type:Equity
account revenues ; type:Revenue
account expenses ; type:Expenses
5 | account expenses ; type:Expenses
| ^
invalid account type code Expenses, should be one of A, L, E, R, X, ASSET, LIABILITY, EQUITY, REVENUE, EXPENSE
Change 'type:Expenses' to 'type:Expense'
Included files :
Transactions span : to (0 days)
Last transaction : none
Transactions : 0 (0.0 per day)
Transactions last 30 days: 0 (0.0 per day)
Transactions last 7 days : 0 (0.0 per day)
Payees/descriptions : 0
Accounts : 0 (depth 0)
Commodities : 0 ()
Market prices : 0 ()
I was doing some homework on CSV imports and found that the file referenced in the csv link of this site, doesnt seem to exist.
"This is described in detail in the csv format manual, but here are some quick examples."
and also the next para, by the rules link:
"Create a rules file named checking.csv.rules in the same directory."
So, to build the site:
"To render the latest site content (in out/):
and call make
"
I dont have the 'out/
directory. Should I?
If someone could nudge me in the correct direction, I'll see if I can change the above.
Maybe I could a small note about where to get mdbook
from.
@MatthiasKauer, all: FYI I've completed a first draft of a new https://hledger.org/investments.html tutorial. And now I understand the older https://hledger.org/tracking-investments.html better. I think right now the new one is a superset of the old, covering more details. I am thinking to keep the old one around as inspiration at least until I've done a second draft, which will hopefully be shorter and clearer. If you have any feedback I'd welcome it.
According to mdBook's documentation, .md
links should be converted to .html
, but this does not happen on e.g. the double entry accounting link on https://hledger.org/5-minute-quick-start.html#how-do-i-use-it- -- it retains the .md
, resulting in a 404.
Oddly enough, this does not happen on the install.md
link, just (at least) the accounting.md
one.
Given data a like this:
# repro.timedot
2022.5.1
work:projectA ....
work:admin ..
2022.5.6
work:projectB ....
work:admin ..
2022.6.2
work:admin ..
work:projectB ....
2022.6.12
work:projectB ....
I was surprised to see this output. Specifically, it seems like the -M flag overrides the date filter. Is that expected behaviour?
It feels pretty unintuitive, and seems like it would warrant a warning with the output that the dates of the table produced don't match the query.
> hledger -f repro.timedot balance date:"from 2022.5.6 to 2022.6.10" --tree -T
2.00 work
1.00 admin
1.00 projectB
--------------------
2.00
> hledger -f repro.timedot balance date:"from 2022.5.6 to 2022.6.10" --tree -T -M
Balance changes in 2022-05-01..2022-06-30:
|| May Jun Total
============++=====================
work || 3.00 0.50 3.50
admin || 1.00 0.50 1.50
projectA || 1.00 0 1.00
projectB || 1.00 0 1.00
------------++---------------------
|| 3.00 0.50 3.50
A past fix for code blocks overlapping the TOC seems to have broken copying text out of those code blocks. Eg the ones at https://hledger.org/dev/hledger.html#setting-ledger_file
Related: #64
I think that [convert]
in the following line is dangling.
Line 121 in 85a2fe7
Hello,
Assume I want to see how many times I've been to costco and I want to use hledger
to do.
I know I can grep/rg the file, but is there an hledger
way to give me a count?
hledger print desc:costco
will list all the transactions
hledger register -m costco
will tell me the most recent amount I've spent
hledger bal --count
shows total number of transactions across all accounts
What's the right command to tell me how many times I've been to costco?
Thanks!
at this location:
https://hledger.org/1.30/hledger.html#including-files
there's a link to "include" but it just refers back to this same section that doesn't actually tell how a person might set up a master file that would include all the sub-journal files.
After googling a bit, I still don't know how.
Hello,
hledge web -h says this:
--host=IPADDR listen on this IP address (default: 127.0.0.1)
So I've tried that:
$ hledger web --host=0.0.0.0
hledger: Error: Unknown flag: --host (use -h to see usage)
$ hledger web --host 192.168.0.79
hledger: Error: Unknown flag: --host (use -h to see usage)
Running this version:
$ hledger web --version
hledger-web 1.34, linux-x86_64
hledger.html
is loading up blank for me in real web browsers. Looking under the hood a bit:
; GET https://hledger.org/hledger.html#csv-rules
error code: 1010
; HEAD https://hledger.org/hledger.html#csv-rules
403 Forbidden
Cache-Control: private, max-age=0, no-store, no-cache, must-revalidate, post-check=0, pre-check=0
Connection: close
Date: Sat, 31 Jul 2021 20:22:05 GMT
Server: cloudflare
Content-Length: 16
Content-Type: text/plain; charset=UTF-8
Expires: Thu, 01 Jan 1970 00:00:01 GMT
Alt-Svc: h3-27=":443"; ma=86400, h3-28=":443"; ma=86400, h3-29=":443"; ma=86400, h3=":443"; ma=86400
CF-RAY: 6779896addf4175a-FRA
Cf-Request-Id: 0b9fd436cb0000175a4a81d000000001
Client-Date: Sat, 31 Jul 2021 20:22:05 GMT
Client-Peer: 2606:4700:3031::ac43:b8ef:443
Client-Response-Num: 1
Client-SSL-Cert-Issuer: /C=US/O=Cloudflare, Inc./CN=Cloudflare Inc ECC CA-3
Client-SSL-Cert-Subject: /C=US/ST=California/L=San Francisco/O=Cloudflare, Inc./CN=sni.cloudflaressl.com
Client-SSL-Cipher: TLS_AES_256_GCM_SHA384
Client-SSL-Socket-Class: IO::Socket::SSL
Client-SSL-Version: TLSv1_3
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
NEL: {"report_to":"cf-nel","max_age":604800}
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=RkKZzZVB5mIrGjsnVpkrTxweiyy%2FkRnt5tH6mBziO70PRfPoshvm%2Bbmz2PLJy%2F4TKHimbHlXbwCG8tPme5ZR%2BgC2RakJrpMLGRtLQzg5%2BOnqUW2lj5Lm4xJUBVB0LbjhsCRUI4hhlf6LeA%3D%3D"}],"group":"cf-nel","max_age":604800}
X-Frame-Options: SAMEORIGIN
Let's say I'm trying to find some documentation about postings. I open Google and search for "hledger posting". These are the results that I see:
As you can see, the first results look similar. The first three have the same title "journal manual - hledger", and they have the same breadcrumb "https://hledger.org › journal". The links of the first three results are:
(At the time of writing, the latest version of hledger is 1.25)
As you can see, these results are basically the same page, but for different versions of hledger. As you can imagine, this can make it harder to find what I was looking for.
Here are some suggestions:
<title>
tag of these pages. That way, the titles on Google will look different, like "journal manual - hledger 1.0", "journal manual - hledger 1.13", and so on.<meta name="robots" content="noindex">
for older versions of hledger only, or consider removing older versions altogetherThe site search finds a bunch of hits for "--gain", but none of them are in https://hledger.org/hledger.html#balance where it is introduced. Also a bunch of the hits it does find are duplicated.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.