GitHub README naar PDF: de in-browser manier (2026)
Een README is vaak het enige document dat een stakeholder leest voordat hij beslist of hij je library adopteert, een project financiert of jou aanneemt. Het delen als PDF laat die eerste indruk overleven door slechte internet, GitHub-storingen en recruiters die weigeren op links te klikken. Hier is de snelste manier om elke README.md om te zetten in een schone PDF zonder Pandoc, LaTeX of een CLI-tool te installeren.
Waarom een README naar PDF converteren?
- Portfolio overdracht. Recruiters en grant-comités geven de voorkeur aan bijlagen boven GitHub-URL's.
- Offline distributie. Conferenties, interne wiki's en gedrukte hand-outs.
- Versie-snapshots. Leg de README vast bij een specifieke commit voor compliance of release notes.
- Documentatie boekjes. Combineer meerdere README's tot een afdrukbare handleiding.
De 30-seconden methode
- Open de GitHub-repository en klik op het
README.md-bestand. - Klik op de Raw -knop. Je krijgt de ongerenderde Markdown-bron.
- Selecteer alles (Ctrl/Cmd + A), kopieer en plak in to-pdf.com/markdown-to-pdf.
- Klik op PDF downloaden.
Dat is alles. De conversie draait in je browser, de bron verlaat nooit je machine, en de output behoudt GitHub-flavored Markdown features: syntax-highlighted codeblokken, tabellen, takenlijsten, blockquotes en voetnoten.
Werken met relatieve afbeeldingspaden
GitHub READMEs verwijzen vaak naar afbeeldingen met relatieve paden zoals
. Die zullen niet oplossen wanneer je raw Markdown in een converter plakt. Twee fixes:
- Herschrijf naar absolute URL's. Vervang
docs/logo.pngmet de volledige GitHub raw URL:https://raw.githubusercontent.com/<owner>/<repo>/main/docs/logo.png. - Gebruik de gerenderde HTML-route. Bekijk de README in GitHub's web UI, kopieer de gerenderde HTML en plak deze in de HTML naar PDF tool. Afbeeldingen blijven als directe GitHub-URL's en laden correct.
Hoe zit het met badges en shields?
Shields.io badges () zijn SVG-afbeeldingen. Ze renderen correct in PDF zolang de URL absoluut is. De meeste badge-URL's zijn dat al, dus je hoeft niets te doen. Als een badge wazig oogt, komt dat omdat de SVG werd gerasteriseerd; schakel de badge naar zijn PNG-variant door
.png aan te hangen als de service dit ondersteunt.
Multi-bestand documentatie in één PDF
Voor projecten met README.md, CONTRIBUTING.md, en een
docs/ -map, plak de bestanden in de volgorde waarin je ze wilt zien verschijnen, elk bestand gescheiden door een Markdown horizontale regel en een kop:
# Project Manual
[contents of README.md]
---
# Contributing
[contents of CONTRIBUTING.md]
---
# Architecture
[contents of docs/architecture.md]
Plak de samengevoegde bron in de Markdown-editor en exporteer. Het resultaat is een gepagineerd PDF-boekje met koppen, pagina-einden tussen secties en één downloadbaar bestand.
Valkuilen om op te letten
Mermaid diagrammen
GitHub rendert ```mermaid -blokken als flowcharts. De meeste browser-gebaseerde converters behandelen ze als platte code. Als de diagrammen ertoe doen, render de README op GitHub, screenshot het diagram en voeg het toe als afbeelding in de Markdown-bron voor het converteren.
HTML embedded in Markdown
GitHub staat raw HTML toe binnen Markdown (bijv. <details>,
<summary>, <img align="right">). De Markdown-editor behoudt deze. Controleer gewoon het voorbeeld-paneel voor het exporteren.
Brede codeblokken
Lange enkele-regel commando's of stack traces kunnen overflowen op de pagina. Wrap handmatig met een backslash continuation, of schakel de paginagrootte naar A3 vanuit de editor-instellingen voor brede referentie-output.
Waarom de in-browser aanpak CLI-tools verslaat
Tools zoals md-to-pdf, pandocen repo2pdf
zijn krachtig maar vereisen Node.js, Python of LaTeX lokaal geïnstalleerd. Voor een eenmalige export — zoals een README aan een email bevestigen — is die overhead overkill. Een browser-gebaseerde converter heeft nul setup, draait offline na het laden, en produceert dezelfde syntax-highlighted output.