92288eec7f
The default version of Pandoc available on the stable ("Stretch")
release of Debian is too old, so running `make` fails. A newer version
is required. This change updates the docs to mention that.
2.3 KiB
% Contributing
Contributing to plaintextaccounting.org
It's as easy as forking this Github repo, making your changes, and submitting a pull request.
If you're a recurring contributor, open an issue to request commit access if it is not granted to you. This is a human-driven process.
Dependencies
This system requires a few dependencies:
Optional, to make active development easier:
Installation of dependencies
macOS
Using Homebrew
For base requirements:
brew install pandoc
make is already available when Xcode is installed.
For all reloading options:
brew install fswatch npm caskroom/cask/livereload && \
npm install -g livereloadx
Debian (and derivatives) Linux
The version of Pandoc shipped in Debian Stretch is old and lacks required features (specifically, the "smart" extension for Markdown), so you'll need to install it from a newer repository. For example:
sudo apt install -t unstable pandoc
Making changes
Once you've cloned the repository and setup the tools, make changes to whatever is necessary. Don't change the html files. The html is automatically generated!
Before committing, rebuild the html, which requires pandoc):
make
and include it in your commit.
Accelerating development with automated rebuilds
To rebuild on each file change, which requires fswatch:
make watch
Refresh the page in the browser manually.
To rebuild and reload the browser page on file change, there are two methods.
Method 1, which requires livereloadx:
make watch
and in another terminal:
npm install -g livereloadx
make livereload
Then visit localhost:35729 in your browser.
Method 2, requires LiveReload:
- Add the site folder in the LiveReload GUI
- Configure custom command
make - Edit away.