This repository is meant to be a template for any Latex project. I personally use it for my papers in university, but it can be used for pretty much any latex document.
This projects pipeline will automatically build and deploy your pdf document (main.tex -> main.pdf) in
GitHub pages on every change on the master branch. [yourusername.github.io/yourrepositoryname]. To adjust this behaviour
just edit the github action. For this to happen you must enable github pages in your github repository settings and specify the gh-pages branch as the source.
To use this repository just create a new repository from this template .
There are many ways to compile your latex documents. You can find some docker related files in this repository. These can be used to compile your latex document and reload them as soon as changes are detected. The major advantage using this docker based approach is the consistency between the local development machines and the build/deployment machine (GitHub runners). Since the same base image is used in the final workflow everything should work exactly as it did locally. Another benefit is that you don't have to have latex installed on your local machine. Every other method to compile your latex files locally should also work fine but errors and functionality may differ from the final deployment.
To get the build environment running make sure to have docker and docker-compose
installed. After that run docker-compose up -d in the repository folder. To stop the build environment you can just
use docker-compose stop as you would with every other docker-compose stack.
⚠️ If you are using Windows: When using Windows, you need to make sure that all files are downloaded to a local wsl installation and run docker from there. While compilation will work with the files located on your windows partition hot reloading will fail due to different file processing in Linux and Windows. If that's not an issue, you can run it directly from your Windows partition, otherwise it's recommended to move the files to a wsl installation.
Feel free to contribute any changes, ideas or optimizations you have to this repository.