From 0bfda24a822705bbaa7cb27f3f900197a177ea0e Mon Sep 17 00:00:00 2001 From: Nicolas Date: Sat, 24 Oct 2026 10:32:44 +0200 Subject: [PATCH] docs: Add VS Code configuration guide for LaTeX Workshop and tasks --- README.md | 102 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 102 insertions(+) diff --git a/README.md b/README.md index a2359dd..5682657 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,9 @@ Docker-Image und Build-Umgebung zum plattformunabhängigen, reproduzierbaren Kom - [4. Reines Docker CLI](#4-reines-docker-cli) - [5. Makefile](#5-makefile) - [Nutzung durch Mitstudierende (Beliebige Ordnerstrukturen)](#nutzung-durch-mitstudierende-beliebige-ordnerstrukturen) +- [VS Code Integration](#vs-code-integration) + - [Variante A: Mit der Extension "LaTeX Workshop" (Auto-Build bei Speichern)](#variante-a-mit-der-extension-latex-workshop-auto-build-bei-speichern) + - [Variante B: Über VS Code Tasks (Strg + Shift + B)](#variante-b-%C3%BCber-vs-code-tasks-strg--shift--b) - [Image selbst bauen](#image-selbst-bauen) - [Git Remote & Image Registry](#git-remote--image-registry) - [Code ins Git-Repo pushen](#code-ins-git-repo-pushen) @@ -148,6 +151,105 @@ docker run --rm -v "${PWD}:/workspace" latex-docker:latest build mein_projekt.te .\build-seminar.ps1 -ProjectPath "C:\Pfad\Zu\Beliebigem\Projekt" ``` +--- + +## VS Code Integration + +### Variante A: Mit der Extension "LaTeX Workshop" (Auto-Build bei Speichern) + +Wenn Sie oder Ihre Kollegen die beliebte Extension **LaTeX Workshop** (`James-Yu.latex-workshop`) nutzen, kann Docker als Standard-Compiler hinterlegt werden. Bei jedem **`Strg + S`** baut Docker das PDF automatisch und aktualisiert die Vorschau in VS Code. + +Fügen Sie dazu in Ihrem LaTeX-Projekt in `.vscode/settings.json` Folgendes ein: + +```json +{ + "latex-workshop.latex.outDir": "%DIR%/out", + "latex-workshop.latex.tools": [ + { + "name": "docker-latexmk", + "command": "docker", + "args": [ + "run", + "--rm", + "-v", + "%DIR%:/workspace", + "-w", + "/workspace", + "latex-docker:latest", + "build", + "%DOCFILE%" + ] + } + ], + "latex-workshop.latex.recipes": [ + { + "name": "Docker LaTeX", + "tools": [ + "docker-latexmk" + ] + } + ], + "latex-workshop.latex.recipe.default": "Docker LaTeX", + "latex-workshop.latex.autoBuild.run": "onSave" +} +``` + +--- + +### Variante B: Über VS Code Tasks (`Strg + Shift + B`) + +Funktioniert komplett ohne spezielle LaTeX-Erweiterung über die integrierte Task-Funktion von VS Code. + +Erstellen Sie im LaTeX-Projekt die Datei `.vscode/tasks.json`: + +```json +{ + "version": "2.0.0", + "tasks": [ + { + "label": "Build LaTeX (Docker)", + "type": "shell", + "command": "docker", + "args": [ + "run", + "--rm", + "-v", + "${workspaceFolder}:/workspace", + "-w", + "/workspace", + "latex-docker:latest", + "build" + ], + "group": { + "kind": "build", + "isDefault": true + }, + "problemMatcher": ["$latex"] + }, + { + "label": "Clean LaTeX (Docker)", + "type": "shell", + "command": "docker", + "args": [ + "run", + "--rm", + "-v", + "${workspaceFolder}:/workspace", + "-w", + "/workspace", + "latex-docker:latest", + "clean" + ], + "problemMatcher": [] + } + ] +} +``` + +- **Bauen:** Tastenkombination `Strg + Shift + B` +- **Bereinigen:** Menü `Terminal` -> `Run Task...` -> `Clean LaTeX (Docker)` + + --- ## Image selbst bauen