MDPress

GitHub-Markdown als PDF

README in PDF umwandeln, für jedes GitHub-Projekt

Ein README ist zum Lesen auf GitHub gedacht, muss aber manchmal als Datei unterwegs sein: eine Übergabe an einen Kunden, ein Compliance-Ordner, eine Studienabgabe. MDPress liest dasselbe GitHub-Flavored Markdown, sodass Aufgabenlisten, Tabellen und Codeblöcke als paginiertes PDF mit hervorgehobenem Code und auswählbarem Text herauskommen.

Konverter öffnen

GitHub-README in drei Schritten in PDF umwandeln.

  1. 01

    Rohes Markdown holen

    Öffne README.md auf GitHub und klicke auf die Schaltfläche Raw, oder nutze das Symbol zum Kopieren der Rohdatei daneben. Wenn du das Repository geklont hast, liegt die Datei bereits auf deiner Festplatte.

  2. 02

    Einfügen oder hochladen

    Füge den Text in den Editor ein oder wähle Markdown hochladen und öffne die .md-Datei. Die Live-Vorschau zeigt jeden Abschnitt auf echten Seiten, sodass du ein fehlendes Bild oder eine zu lange Codezeile vor dem Export erkennst.

  3. 03

    Seite einstellen und herunterladen

    Der Stil Technisch nummeriert die Abschnitte und gibt Codeblöcken mehr Raum, was zu Dokumentationen passt. Wähle A4 oder US Letter, aktiviere ein Inhaltsverzeichnis, wenn das README lang ist, und lade herunter.

Ein kleines README, bereit zur Umwandlung.

Füge eine Datei wie diese ein, und jeder Teil davon wird ins PDF übernommen.

# tinycache

Ein kleiner In-Memory-Cache für Node.js mit zeitbasiertem Ablauf.

## Installation

```bash
npm install tinycache
```

## Verwendung

```js
import { createCache } from "tinycache";
const cache = createCache({ ttl: 60_000 });
cache.set("user:1", { name: "Ada" });
```

## Roadmap

- [x] Ablauf pro Schlüssel
- [ ] Größenbegrenzung

tinycache

Ein kleiner In-Memory-Cache für Node.js mit zeitbasiertem Ablauf.

Installation

npm install tinycache

Verwendung

import { createCache } from "tinycache";
const cache = createCache({ ttl: 60_000 });
cache.set("user:1", { name: "Ada" });

Roadmap

  • Ablauf pro Schlüssel
  • Größenbegrenzung

Warum ein README hier umwandeln.

Es liest GitHub-Flavored Markdown

Aufgabenlisten, Pipe-Tabellen, Codeblöcke mit Sprachangabe, Autolinks und Durchstreichungen werden alle verstanden, weil der Konverter dieselbe Variante wie GitHub verwendet. Ein Mermaid-Block wird als Diagramm gezeichnet, genau wie auf der Repository-Seite.

Code, der auf Papier lesbar bleibt

Installationsbefehle und Konfigurationsbeispiele werden je nach Sprache hervorgehoben. Eine Zeile, die breiter als die Seite ist, bricht innerhalb ihres Blocks um, statt über den Rand zu laufen, sodass niemand das Ende eines langen Befehls raten muss.

Ein Inhaltsverzeichnis aus deinen Überschriften

Lange READMEs haben in ihren Überschriften bereits eine Gliederung. Das Inhalt-Werkzeug listet die ersten drei Überschriftenebenen vorne auf einer Seite auf, mit Seitenzahlen, und das Deckblatt-Werkzeug fügt eine Titelseite mit Projektname, Autor und Datum hinzu.

Tipps und ehrliche Grenzen.

  • Relative Bildpfade wie docs/screenshot.png laden nicht, weil der Konverter dein Repository nicht sehen kann. Lade das Bild über das Bilder-Werkzeug hoch, oder ersetze den Pfad durch die vollständige Webadresse des Bildes.
  • Rohes HTML wird als Text angezeigt und nicht gerendert. Viele READMEs nutzen HTML für ein zentriertes Logo, Badges in einer Reihe oder einen ausklappbaren Abschnitt, also schreibe diese Teile als reines Markdown um oder entferne sie.
  • Relative Links auf andere Dateien im Repository, wie CONTRIBUTING.md, führen im PDF nirgendwohin. Ändere sie vor dem Export in vollständige GitHub-Adressen.

Fragen zu README in PDF.

Kann ich einen GitHub-Link einfügen und das README direkt umwandeln?
Nein. MDPress ruft keine Repositories ab. Öffne das README auf GitHub, klicke auf Raw, kopiere den Text und füge ihn ein, oder lade die Datei README.md aus deinem Klon hoch. Das dauert wenige Sekunden und funktioniert auch für private Repositories, weil du den Text selbst bereitstellst.
Warum fehlen die Bilder in meinem README-PDF?
Das README verweist wahrscheinlich mit relativen Pfaden auf Bilder, die nur innerhalb des Repositorys aufgelöst werden. Füge jedes Bild über das Bilder-Werkzeug hinzu, damit es im Dokument eingebettet wird, oder verlinke eine absolute Adresse im Web. Eingebettete Bilder zählen zum 4-MB-Limit.
Funktionieren Badges und HTML-Blöcke in einem README?
Badges, die in Markdown-Bildsyntax mit vollständiger Webadresse geschrieben sind, laden wie jedes andere Bild. Alles, was als HTML-Tag geschrieben ist, wird als reiner Text ausgegeben, also muss ein zentrierter Kopfbereich oder ein Details-Abschnitt zuerst in Markdown umgewandelt werden.

Mach das README zu einer Datei, die du versenden kannst.

Rohes Markdown einfügen oder README.md hochladen, Vorschau prüfen und herunterladen. Für die ersten vier PDFs am Tag brauchst du kein Konto.

Konverter öffnen