simonmichael/hledger
1
1
Fork 0
mirror of https://github.com/simonmichael/hledger.git synced 2024-09-16 00:37:33 +03:00
Code Issues Projects Releases Wiki Activity
e0cbe65d9b
hledger/doc/tldr
History
Simon Michael 40620666f8 imp: cli: rename --rules-file to --rules; tweak options help 
For brevity, and consistency with --conf.
--rules-file remains supported, as a hidden option.

hledger's main mode now supports the hidden legacy flags,
as the command modes do.
2024-06-25 18:37:55 +01:00
..
hledger-accounts.md doc: tldr: copy tldr pages to the hledger repo for robustness 2024-05-29 15:32:19 -10:00
hledger-add.md doc: tldr: copy tldr pages to the hledger repo for robustness 2024-05-29 15:32:19 -10:00
hledger-aregister.md ;doc: sync with tldr docs 2024-05-29 17:30:50 -10:00
hledger-balance.md doc: tldr: copy tldr pages to the hledger repo for robustness 2024-05-29 15:32:19 -10:00
hledger-balancesheet.md ;doc: sync command summaries between manuals and tldr, updating both 2024-05-29 17:00:11 -10:00
hledger-import.md imp: cli: rename --rules-file to --rules; tweak options help 2024-06-25 18:37:55 +01:00
hledger-incomestatement.md ;doc: sync command summaries between manuals and tldr, updating both 2024-05-29 17:00:11 -10:00
hledger-print.md doc: tldr: copy tldr pages to the hledger repo for robustness 2024-05-29 15:32:19 -10:00
hledger-ui.md ;doc: sync command summaries between manuals and tldr, updating both 2024-05-29 17:00:11 -10:00
hledger-web.md ;doc: sync command summaries between manuals and tldr, updating both 2024-05-29 17:00:11 -10:00
hledger.md ;doc: sync command summaries between manuals and tldr, updating both 2024-05-29 17:00:11 -10:00
README.md doc: tldr: copy tldr pages to the hledger repo for robustness 2024-05-29 15:32:19 -10:00

README.md

tldr-pages provides minimal, example-focussed doc pages for command line tools and their subcommands.

tldr pages are short but high value, and a great counterbalance to PTA's verbose docs. So they are worth prioritising and maintaining. gutjuri made the first hledger tldr page in 2022, and sm added more in 2024.

This directory has local copies of all hledger-related tldr pages The tldr-pages repo has the master copies, so they should be copied here periodically (eg before release). These docs are crafted first to suit tldr and its style rules, but we'll reuse them where we can. Eg they are now embedded in the hledger tools and accessible with --tldr.

https://tldr.inbrowser.app is an online (& offline) tldr viewer, where you can search for hledger command examples.

You can also make a web browser keyword for it (firefox & chrome; safari), like tldr CMD = https://tldr.inbrowser.app/search?query=CMD. Then in your browser's address bar you can type tldr, tldr hledger, tldr hledger-web, tldr hledger-balancesheet, etc.

In the search field's gear icon you can configure preferred languages. If you speak a language other than english, please consider making a few translations! It is relatively easy. You can do it entirely in your web browser if you have a Github account:

  1. Starting with eg https://tldr.inbrowser.app/pages/common/hledger
  2. click "Find this page on GitHub"
  3. click the "Copy raw file" icon (two squares)
  4. navigate to eg https://github.com/tldr-pages/tldr/tree/main/pages.de/common
  5. click "Add file" > "Create new file"
  6. reuse the original file name, paste the original content
  7. translate the content
  8. commit
  9. send a pull request

Here is the tldr translations status.