This repository helps you start writing an academic journal paper on GitHub. The source file of the paper in the pandoc markdown format. You can find the source file in the src folder.
To start writing your own paper, you need to fork or duplicate this repository and edit the source file of the paper. Note that if you fork the repository, you cannot make your repository private. To create a private copy of this repository, you need to duplicate it.
Each time that a change is made to the repository, a GitHub Action is executed. Each GitHub Action in this repository generates an artifact, which is a zip file that contains the PDF version of the paper.
The example template in the templates folder is for Elsevier journals. You can use all the other journal templates in this folder. You just need to change csl and template locations in the source file from templates/ to rticles/inst/rmarkdown/templates/ and then add the folder of your desired journal.
You need to clone the repository and run this command to clone the git submodules (lua-filters and rticles):
make clone
If you have docker on your computer, to generate the PDF file (in the output folder), run this command:
./md2pdf.sh
You can also run make md2pdf.
Another method is to install pandoc on your computer and run this command:
make build