5f3996e350
* Head off confusion about which vim plugin supports what While the *hledger-vim* project has some good ideas, it is not fully developed and hasn't been worked on for a long time. In the meanwhile the *vim-ledger* plugin has started to support `hledger` out of the box as one of the command backends. At the risk of self promotion since I'm now maintaining the *vim-ledger* plugin, this changes the order and adds a note about compatibly so it is more apparent to a newcomer where to start and they don't skip *vim-ledger* entirely assuming from the names that *hledger-vim* is the only plugin that supports `hledger`. * Fix typography, English does not allow comma before space Leave it to a Haskell programmer to try to separate list items with a comma on after a newline in Markdown. Note that most Markdown flavors (including Pandoc) add a trailing space to lines when they join them. This means you cannot start new lines with punctuation.
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.htmlas follows:- Ensure you have pandoc 2.5+ and [GNU Make] installed, and run
make. (Preferred). - If you don't have GNU Make, you can run
pandoc -f markdown-smart+autolink_bare_uris --template index.tmpl index.md -o index.html - If you don't have pandoc, you can update
index.htmlby hand (ok for trivial changes).
- Ensure you have pandoc 2.5+ and [GNU Make] installed, and run
- Commit the changes (source files and regenerated html files, eg both
index.mdandindex.html). git pushto 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 liverenderto update index.html - In another window,
make livereloadto 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.