A Github repository template for writing LaTeX documents collaboratively with automatic rendering using Github actions.
- Renders the paper on every push to master
- Renders the paper for pull requests, including latex-diff with master
- Calculates document word count for pull requests using texcount
Compiling locally is possible with any LaTeX distribution; the github actions workflow (Ubuntu 20.04) uses the following packages (all installable via apt
):
texlive-latex-recommended
texlive-latex-extra
texlive-extra-utils
(optional: needed fortexcount
)rubber
(optional: needed for Makefile usage)perl
(optional: needed for texcount and latexdiff)latexdiff
(optional)
For running the spellcheck, the following packages are required:
textidote
(for generating plain-text from tex)codespell
(installable withpip3
)
For convenience a Makefile is included which relies on the rubber LaTeX wrapper:
$ make # generate paper.pdf
$ make clean # cleanup
$ make spellcheck # run codespell
$ make count # run TexCount
$ make diff # run latexdiff with master