The plaintextaccounting.org website, a portal to Ledger, hledger, beancount and co. Also the PTA wiki.
% README
This is the source for plaintextaccounting.org, an information portal and community hub for Plain Text Accounting. It is maintained by Simon Michael and fellow PTA fans like you. All help welcome!
The site's repo is https://github.com/plaintextaccounting/plaintextaccounting. The site is markdown pages with double-bracket wiki links, rendered by Pandoc. Source files are in the src/ folder, output files and assets are the out/ folder. The source files are intended to be somewhat compatible with Obsidian, for efficient local editing and viewing.
page.tmpl
defines the page layout, using normalize,
skeleton and our site.css
.
The site is rendered by Cloudflare Pages. Changes merged in the master branch should appear at plaintextaccounting.org within a minute or so. (If not, check https://www.cloudflarestatus.com and https://www.githubstatus.com)
#plaintextaccounting
IRC channel on Libera.chat)git clone https://github.com/plaintextaccounting/plaintextaccounting.wiki.git
, make changes, and send a PR or pushThe markup is Pandoc markdown
(specifically markdown-smart-tex_math_dollars+autolink_bare_uris+wikilinks_title_after_pipe
,
or whatever is in Makefile),
plus [[double-bracket wiki links]] similar to Obsidian's.
To see an accurate preview while editing, clone locally and run make watch
(requires pandoc and livereloadx).
Or, here are some ways to see an approximate preview:
If you edit with Emacs markdown-mode:
This will be applied immediately if you have commit access, otherwise a fork and pull request will be created, which we will review soon.
index.md
(and/or README.md
, css/*
, images/*
).make
(requires GNU Make and pandoc 2.5+) and view index.html
in your web browser.git push
to your fork.Here are two quick and dirty ways:
|
to split the window, switch one into preview mode)For the most accurate rendering, use Pandoc:
pandoc
, run make
, and browse out/index.html
.For live-updating Pandoc rendering:
watchexec
and livereloadx, run make watch
, browse http://localhost:8100
If you're a recurring contributor and haven't yet been granted commit access, please request it in the #plaintextaccounting chat.
In addition to HTML <a href="hyper.html">Links</a>
and [Markdown](links.html)
,
double-bracketed [[Wiki Links]]
(or [[Wiki#section]]
or [[Wiki|Links]]
or [[Wiki#section|Links]]
) are supported
(note that |alternate link text
comes last).
If you are working in Obsidian, note that it expects words in file names and wiki links to be space-separated,
but the currently the site requires file names to be hyphen-separated,
and it will translate spaced wiki links to the hyphenated link targets automatically.
Some old notes from 2022:
Goals:
One goal for this site is to collect concise useful example journal entries for all common accounting situations. These are organized into topic pages which get linked on [[Cookbook]]. Try to make examples reasonably reproducible.
In literal blocks, consider writing a file type after the opening triple backticks. Although PTA file types are not yet well supported by Github, they might be in future, and it can also help with automation. Some suggested types:
journal
- a generic journal file (likely compatible with ledger, hledger, and compatibles)ledger
- a ledger-specific journal file (optional)hledger
- a hledger-specific journal file (optional)beancount
- a beancount journal filetimeclock
- a timeclock filetimedot
- a timedot filecsv
, ssv
, tsv
- comma, semicolon, or tab-separated valuesrules
- a hledger CSV rules file, ...abandon
, tackler
, nledger
, ... - files specific to other PTA appsIn example files, consider writing the filename as a comment on the first line, and using each filename only once within a page. This gives example commands something to reference, and can help users trying out the variations, or automated tests.