The plaintextaccounting.org website
This is the source for plaintextaccounting.org, an information portal/overview site for Plain Text Accounting and related tools: Ledger, hledger, beancount, etc.
The repo is named plaintextaccounting.github.io
to make it the
Github Pages site for the
plaintextaccounting organization,
allowing it to be served with the custom plaintextaccounting.org
domain.
How to contribute an update (using web UI)
(Ok for trivial updates)
- Log in to Github and click the pencil at index.md.
- Make your changes to the markdown source. Commit.
- Make the corresponding changes in the generated index.html. Commit. It's ok to skip this step if you must; we'll update the html for you.
- These commits will be bundled into a pull request (I think). Or will be applied immediately if you have commit access.
How to contribute an update (using pandoc)
- Log in to Github, fork this repo, clone it to your machine.
- Make your changes to
index.md
(and/orREADME.md
,css/*
,images/*
). - Regenerate
index.html
as follows: - Commit the changes (source files and regenerated html files, eg both
index.md
andindex.html
). git push
to your fork.- Submit a pull request.
How to get commit access
If you're a recurring contributor and haven't yet been granted commit access, feel free to open an issue to request it.
How to see a live local preview
- Install entr and livereloadx
- In one window,
make liverender
to update index.html - In another window,
make livereload
to run a live-reloading local webserver - Open the page in a browser: http://localhost:10000
- Save changes in
index.md
, see updates in the browser.