https://github.com/loiccoyle/localleaf

🍃 Easy breezy latex, monitor .tex files & builds pdf on change - a local overleaf
https://github.com/loiccoyle/localleaf

docker latex overleaf papers script

Last synced: 3 months ago
JSON representation

🍃 Easy breezy latex, monitor .tex files & builds pdf on change - a local overleaf

• Host: GitHub
• URL: https://github.com/loiccoyle/localleaf
• Owner: loiccoyle
• License: mit
• Created: 2023-01-21T19:57:21.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-01-15T13:29:03.000Z (4 months ago)
• Last Synced: 2025-01-15T15:18:18.313Z (4 months ago)
• Topics: docker, latex, overleaf, papers, script
• Language: Shell
• Homepage: https://loiccoyle.com/projects/localleaf
• Size: 80.1 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  

  

  



🍃 localleaf 🍃

Easy breezy LaTeX: A tool to monitor and build LaTeX projects, powered by Docker.


## ✨ Key Features

- Monitors source files and rebuilds the project automatically.

- Supports various LaTeX engines (e.g., `pdflatex`, `xelatex`, `lualatex`).

- Keeps your project directory clean with configurable output paths.

## 📋 Usage

To start monitoring and building a LaTeX project, run:

```bash

localleaf project_dir/ -m project_dir/main_document.tex

```

If in doubt check the `-h`elp.

```console

$ localleaf -h

Easy breezy latex.

Spins up a latex docker image, monitors source files and builds on change.

Usage: localleaf [OPTIONS] [PROJECT_DIR] -- [EXTRA_ARGS]

  -h                          Show this message and exit.

  -m MAIN_DOCUMENT            The main document of the latex project.

  -e ENGINE                   Latex engine. [pdflatex] {latex,pdflatex,xelatex,lualatex}

  -i IMAGE                    Docker image. [loiccoyle/localleaf]

  -c                          Commit changes on exit.

  -1                          Don't monitor, build once and exit.

  PROJECT_DIR                 Root directory of the latex project. ['.']

  EXTRA_ARGS                  Extra arguments to pass to latexmk, e.g. --outdir=build/

```

> [!TIP]

> Run with `localleaf {your args} -- --outdir=build/ --auxdir=aux/` to not clutter the root directory with the build and auxiliary files.

## 📦 Installation

### Dependencies

You only need `docker`.

### Manual

Clone this repo and add the script somewhere on your `$PATH`.

```bash

git clone https://github.com/loiccoyle/localleaf

mv localleaf/localleaf ~/.local/bin/

```

### Arch

Using your favourite AUR helper:

```bash

paru -S localleaf-git

```

> [!TIP]

> To keep the docker image up to date, run `docker pull loiccoyle/localleaf` from time to time.