Giter VIP home page Giter VIP logo

plaintextaccounting's Introduction

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.

Since 2022-01, there is also a companion wiki: https://wiki.plaintextaccounting.org. (The wiki is hosted on Github and its urls are not finalised, but https://wiki.plaintextaccounting.org[/PAGE] will always redirect to the right place.)

Contributing

Construction and rendering

The site is mainly one big markdown page, plus a few more. These are rendered by Pandoc (chosen originally for its power and dependability, to minimise layout troubleshooting time).

Hosting and deployment

The site's repo is https://github.com/plaintextaccounting/plaintextaccounting. Since 2022-01, the site is rendered by Cloudflare Pages. Changes merged in the master branch appear at plaintextaccounting.org within 2-3 minutes.

Where to discuss / give feedback

The site is managed via

  • the Github issue tracker
  • and the #plaintextaccounting:matrix.org room on Matrix, or the bridged #plaintextaccounting channel on Libera.chat. Site-related questions or discussion are welcome here.

How to make a change through the web

  1. Log in to Github and click the pencil at index.md.
  2. Make your changes to the markdown source.
  3. Use the Preview tab to check the result.
  4. When everything looks right, commit with a descriptive message.

This will be applied immediately if you have commit access, otherwise a fork and pull request will be created, which we will review soon.

How to make a change on your machine

  1. Log in to Github, fork this repo, and clone the fork to your machine.
  2. Make your changes to index.md (and/or README.md, css/*, images/*).
  3. To preview, run make (requires GNU Make and pandoc 2.5+) and view index.html in your web browser.
  4. When everything looks right, commit with a descriptive message.
  5. git push to your fork.
  6. Submit a pull request.

How to see a live preview on your machine

Quick and dirty ways:

  • Use VS Code's preview pane (eg on mac: Cmd k Cmd v while editing index.md)
  • Use Obsidian's preview mode (edit index.md, | to split the window, switch one into preview mode)

For accurate rendering:

How to get commit access

If you're a recurring contributor and haven't yet been granted commit access, please request it in the #plaintextaccounting chat.

plaintextaccounting's People

Contributors

simonmichael avatar colindean avatar tbm avatar mistery avatar alexjj avatar felixc avatar 35vlg84 avatar jaa127 avatar mescanne avatar leplay avatar zoranzaric avatar vlamacko avatar sboehler avatar rgieseke avatar mwfogleman avatar mas-4 avatar marvinpinto avatar glasserc avatar ebridges avatar derekmahar avatar isabekov avatar le-jun avatar bradeskojest avatar maralorn avatar mariosangiorgio avatar mayeu avatar narendraj9 avatar rstacruz avatar siddhantgoel avatar sitanhuang avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.