Skip to content

Commit

Permalink
doc: Commands/Balance.md: document hyperlinks and --base-url
Browse files Browse the repository at this point in the history
  • Loading branch information
thielema committed Sep 14, 2024
1 parent 7ece4d0 commit 2cc730a
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions hledger/Hledger/Cli/Commands/Balance.md
Original file line number Diff line number Diff line change
Expand Up @@ -385,6 +385,19 @@ $ hledger bal -% cur:\\$
$ hledger bal -% cur:€
```

### Hyperlinks

The HTML and FODS output formats support hyperlinks to `hledger-web`'s
Register pages for every account and period.
E.g. if your `hledger-web` server is reachable
under the URL `http://localhost:5000/`
then you might run the `balance` command
with the extra option `--base-url=http://localhost:5000/`.
The export function will not add any slash
in order to support relative hyperreferences.
Thus it is important that you add the trailing slash to the URL yourselves,
where needed.

### Multi-period balance report

With a [report interval](#report-intervals) (set by the `-D/--daily`,
Expand Down

0 comments on commit 2cc730a

Please sign in to comment.