GitHub README zu PDF: Der Browser-Weg (2026)
Ein README ist oft das einzige Dokument, das ein Stakeholder liest, bevor er entscheidet, ob er Ihre Bibliothek übernehmen, ein Projekt finanzieren oder Sie einstellen soll. Es als PDF zu teilen, lässt diesen ersten Eindruck wackeliges Internet, GitHub-Ausfälle und Recruiter überleben, die sich weigern, Links zu klicken. Hier ist der schnellste Weg, jedes README.md in ein sauberes PDF zu verwandeln, ohne Pandoc, LaTeX oder ein CLI-Tool zu installieren.
Warum ein README in PDF konvertieren?
- Portfolio-Übergabe. Recruiter und Stipendienausschüsse bevorzugen Anhänge gegenüber GitHub-URLs.
- Offline-Verteilung. Konferenzen, interne Wikis und gedruckte Handouts.
- Versionierte Snapshots. Erfassen Sie das README zu einem bestimmten Commit für Compliance- oder Release-Notes.
- Dokumentationsbroschüren. Kombinieren Sie mehrere READMEs zu einem druckbaren Handbuch.
Die 30-Sekunden-Methode
- Öffnen Sie das GitHub-Repository und klicken Sie auf die
README.md-Datei. - Klicken Sie auf den Raw -Button. Sie erhalten den ungerenderten Markdown-Quellcode.
- Wählen Sie alles aus (Ctrl/Cmd + A), kopieren und einfügen in to-pdf.com/markdown-to-pdf.
- Klicken Sie auf PDF herunterladen.
Das war's. Die Konvertierung läuft in Ihrem Browser, der Quellcode verlässt nie Ihre Maschine, und die Ausgabe behält GitHub-Flavored-Markdown-Features: syntaxhervorgehobene Codeblöcke, Tabellen, Aufgabenlisten, Blockzitate und Fußnoten.
Arbeiten mit relativen Bildpfaden
GitHub-READMEs referenzieren oft Bilder mit relativen Pfaden wie
. Diese werden nicht aufgelöst, wenn Sie rohes Markdown in einen Konverter einfügen. Zwei Lösungen:
- Auf absolute URLs umschreiben. Ersetzen Sie
docs/logo.pngmit der vollständigen GitHub-Raw-URL:https://raw.githubusercontent.com/<owner>/<repo>/main/docs/logo.png. - Verwenden Sie den gerenderten HTML-Weg. Sehen Sie das README in der Web-UI von GitHub an, kopieren Sie das gerenderte HTML und fügen Sie es in das HTML zu PDF -Tool ein. Bilder bleiben als direkte GitHub-URLs und werden korrekt geladen.
Was ist mit Badges und Shields?
Shields.io-Badges () sind SVG-Bilder. Sie werden im PDF korrekt gerendert, solange die URL absolut ist. Die meisten Badge-URLs sind das bereits, also müssen Sie nichts tun. Wenn ein Badge unscharf aussieht, ist das, weil das SVG gerastert wurde; wechseln Sie das Badge zur PNG-Variante, indem Sie
.png anhängen, wenn der Service dies unterstützt.
Mehrdatei-Dokumentation in einer PDF
Für Projekte mit README.md, CONTRIBUTING.md, und einem
docs/ -Ordner verketten Sie die Dateien in der Reihenfolge, in der sie erscheinen sollen, und trennen jede Datei mit einer horizontalen Markdown-Linie und einer Überschrift:
# Project Manual
[contents of README.md]
---
# Contributing
[contents of CONTRIBUTING.md]
---
# Architecture
[contents of docs/architecture.md]
Fügen Sie den verketteten Quellcode in den Markdown-Editor ein und exportieren Sie. Das Ergebnis ist eine paginierte PDF-Broschüre mit Überschriften, Seitenumbrüchen zwischen Abschnitten und einer einzigen herunterladbaren Datei.
Fallstricke, auf die man achten sollte
Mermaid-Diagramme
GitHub rendert ```mermaid -Blöcke als Flussdiagramme. Die meisten browserbasierten Konverter behandeln sie als reinen Code. Wenn die Diagramme wichtig sind, rendern Sie das README auf GitHub, machen Sie einen Screenshot des Diagramms und fügen Sie es als Bild im Markdown-Quellcode vor der Konvertierung ein.
HTML eingebettet in Markdown
GitHub erlaubt rohes HTML innerhalb von Markdown (z.B. <details>,
<summary>, <img align="right">). Der Markdown-Editor bewahrt diese. Überprüfen Sie einfach den Vorschaubereich vor dem Export.
Breite Codeblöcke
Lange einzeilige Befehle oder Stack-Traces können die Seite überlaufen. Brechen Sie manuell mit einer Backslash-Fortsetzung um, oder wechseln Sie die Seitengröße in den Editor-Einstellungen zu A3 für breite Referenzausgabe.
Warum der Browser-Ansatz CLI-Tools schlägt
Tools wie md-to-pdf, pandoc, und repo2pdf
sind mächtig, erfordern aber lokal installierte Node.js, Python oder LaTeX. Für einen einmaligen Export — etwa das Anhängen eines READMEs an eine E-Mail — ist dieser Aufwand übertrieben. Ein browserbasierter Konverter hat null Setup, läuft offline nach dem Laden und produziert dieselbe syntaxhervorgehobene Ausgabe.