alexanderdavide / latex-vscode-remote-containers

LaTeX on VSCode Remote Containers

LaTeX VSCode Remote Containers

Prerequisites

1. Install VSCode
2. Install the VSCode Remote Development plugin
3. Install Docker and Docker Compose

Starting

1. Clone this repository
2. Open the folder in VSCode
3. Execute Remote-Containers: Reopen in Container from the VSCode command palette
4. VSCode automatically downloads the dependencies and starts up the LaTeX container.
5. You will be left with a VSCode window to write your LaTeX project in. Every integrated terminal is running inside the LaTeX container.

Shutdown

Simply close VSCode.

Things to know

• This project relies on tianon/latex and LaTeX Workshop.
• Put your LaTeX files in /workspace just as the main.tex.
• Once you save a .tex file, it will automatically be built with Latexmk which seamlessly integrates BibTeX bibliography in the compilation.
• The GitHub Action latex-build runs on each push to build your project with Latexmk and upload the PDF as an artifact of the run. If you don't want to use the action, it is safe to delete the .github folder. You may need to adapt the latex-build.env section to fit your requirements.
  • LATEX_FILE_PATH: path of the used LaTeX file, relative to /workspace
  • OUTPUT_DIR_PATH: path of the output directory, relative to /workspace
  • OUTPUT_BASE_FILENAME: name of the created artifact archive and containing PDF file
  • TZ: timezone of the timestamp that is appended to OUTPUT_BASE_FILENAME to make files uniquely identfiable