https://github.com/grebtsew/overleaf-latex-compiler
Scripts and docker container for local compile of LaTeX projects of any size.
https://github.com/grebtsew/overleaf-latex-compiler
compile docker docker-compose latex overleaf
Last synced: 3 months ago
JSON representation
Scripts and docker container for local compile of LaTeX projects of any size.
- Host: GitHub
- URL: https://github.com/grebtsew/overleaf-latex-compiler
- Owner: grebtsew
- License: mit
- Created: 2023-01-30T12:03:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-17T14:58:37.000Z (about 3 years ago)
- Last Synced: 2025-03-27T17:35:12.722Z (over 1 year ago)
- Topics: compile, docker, docker-compose, latex, overleaf
- Language: Shell
- Homepage:
- Size: 1.71 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Overleaf-LaTeX-Compiler
Since Overleaf online free edition compile only offers a one minute maximum compile time for LaTeX projects this project was created to compile arbitrary LaTeX documents locally of any size. The project contains a docker container that facilitates the usage. The steps below describe how to compile your latex project. The implementation used `Latexmk`, similar to Overleaf, make sure that your projects LaTeX version is supported by `Latexmk` to ensure reliable compilation results.
0. Install necessary programs needed to run the compile.tex.sh script (not needed if using docker). A list of the required programs can be found in the `Dockerfile`.
1. Start by placing your LaTeX projects in the `./document` folder, either as a project folder or `.zip` download from `Overleaf`.
2. Define path to the main project `.tex` file that should be compiled in the `compilelist.txt` file. The relative path is important, an example of an appropriate path would be: `documents/project/thesis_main.tex`. The implementation requires that the symbols `(` and ` ` does note exist in the path. Always leave a blank row at the end of the file.
3. Run the compile script locally or via docker, see how below.
4. The resulting compiled `.pdf` file is moved into the `./target` folder. Done!
**NOTE**: The `./document` and `./target` folder is ignored by git tracking, it is safe to place documents within the folders.
# Demo
# Running Locally
Run the `compile.tex.sh` script:
```
# Make file executable:
chmod +x ./compile.tex.sh
# Run script:
./compile.tex.sh
```
# Running on Docker
The `Dockerfile` contains programs and requirements needed to create the Ubuntu:22.04 docker containers. The containers can be executed directly through docker or with docker-compose. The command below will execute the container.
```Bash
# Using Docker
docker build -t overleaf_latex_compile .
docker run overleaf_latex_compile
# Using Docker Compose
docker-compose up --build
```
**NOTE**: This container takes a long time to build the first time. It is primarily the downloading and installation of programs in the container that takes time. Once the container is built, it is convenient to run it every time documents are to be compiled.
# Testing
The `./tests` folder contains an example latex project and a script to test compile it using docker-compose.
# License
This project is created under a [MIT LICENSE](./LICENSE).
Copyright (c) 2023 Grebtsew