GitHub README til PDF: in-browser-vejen (2026)
En README er ofte det eneste dokument, en interessent læser, før han beslutter sig for at adoptere dit bibliotek, finansiere et projekt eller ansætte dig. At dele det som PDF får det første indtryk til at overleve ustabilt internet, GitHub-udfald og rekrutterere, der nægter at klikke på links. Her er den hurtigste måde at forvandle enhver README.md til en ren PDF uden at installere Pandoc, LaTeX eller et CLI-værktøj.
Hvorfor konvertere en README til PDF?
- Portefølje-overdragelse. Rekrutterere og legatkomitéer foretrækker vedhæftninger frem for GitHub-URL'er.
- Offline distribution. Konferencer, interne wikier og udskrevne uddelingsark.
- Versionerede øjebliksbilleder. Fang README ved en bestemt commit til compliance eller versionsnoter.
- Dokumentationshæfter. Kombiner flere README'er til en udskrivbar manual.
30-sekunders-metoden
- Åbn GitHub-arkivet og klik på
README.md-filen. - Klik på Raw -knappen. Du får den uomdannede Markdown-kilde.
- Markér alt (Ctrl/Cmd + A), kopiér og indsæt i to-pdf.com/markdown-to-pdf.
- Klik på Download PDF.
Det er det. Konverteringen kører i din browser, kilden forlader aldrig din maskine, og outputtet beholder GitHub-flavored Markdown-funktioner: syntaksfremhævede kodeblokke, tabeller, opgavelister, blockquotes og fodnoter.
Arbejde med relative billedstier
GitHub README'er refererer ofte til billeder med relative stier som
. De vil ikke blive løst, når du indsætter rå Markdown i en konverter. To rettelser:
- Skriv om til absolutte URL'er. Erstat
docs/logo.pngmed den fulde GitHub raw URL:https://raw.githubusercontent.com/<owner>/<repo>/main/docs/logo.png. - Brug den gengivede HTML-vej. Vis README i GitHubs web-UI, kopiér den gengivede HTML, og indsæt den i HTML til PDF -værktøjet. Billeder forbliver som direkte GitHub-URL'er og indlæses korrekt.
Hvad med badges og shields?
Shields.io-badges () er SVG-billeder. De gengives korrekt i PDF, så længe URL'en er absolut. De fleste badge-URL'er er det allerede, så du behøver ikke gøre noget. Hvis et badge ser sløret ud, er det fordi SVG'en blev rasteriseret; skift badget til dets PNG-variant ved at tilføje
.png hvis tjenesten understøtter det.
Flerfilers-dokumentation i én PDF
Til projekter med README.md, CONTRIBUTING.md, og en
docs/ -mappe, sammenkæd filerne i den rækkefølge, du vil have dem til at vises, ved at adskille hver fil med en Markdown vandret linje og en overskrift:
# Project Manual
[contents of README.md]
---
# Contributing
[contents of CONTRIBUTING.md]
---
# Architecture
[contents of docs/architecture.md]
Indsæt den sammenkædede kilde i Markdown-editoren og eksportér. Resultatet er et pagineret PDF-hæfte med overskrifter, sideskift mellem sektioner og én downloadbar fil.
Faldgruber at være opmærksom på
Mermaid-diagrammer
GitHub gengiver ```mermaid -blokke som flowcharts. De fleste browser-baserede konvertere behandler dem som almindelig kode. Hvis diagrammerne betyder noget, så gengiv README på GitHub, tag et skærmbillede af diagrammet, og indsæt det som et billede i Markdown-kilden før konvertering.
HTML indlejret i Markdown
GitHub tillader rå HTML inde i Markdown (f.eks. <details>,
<summary>, <img align="right">). Markdown-editoren bevarer disse. Tjek bare forhåndsvisningsruden før eksport.
Brede kodeblokke
Lange enkeltlinjes kommandoer eller stack traces kan flyde ud over siden. Ombryd manuelt med en backslash-fortsættelse, eller skift sidestørrelsen til A3 fra editorens indstillinger for bredt reference-output.
Hvorfor in-browser-tilgangen slår CLI-værktøjer
Værktøjer som md-to-pdf, pandocog repo2pdf
er kraftfulde, men kræver Node.js, Python eller LaTeX installeret lokalt. Til en engangs-eksport — for eksempel at vedhæfte en README til en e-mail — er den overhead overkill. En browser-baseret konverter har nul opsætning, kører offline når den er indlæst, og producerer det samme syntaksfremhævede output.