Kategorien

← View All Tools

GitHub README zu PDF

Ruft ein GitHub README ab und rendert es als PDF

Erstellt ein PDF aus einem GitHub README.

Quelle:

  • Repo-URL oder owner/repo
  • Optionale Branch- und README-Pfade

Ausgabe:

  • GitHub-ähnliches Styling mit Druckoptionen

Beispielergebnisse

1 Beispiele

Beispiel: GitHub README to PDF

Automatisch erzeugtes PDF-Beispiel: Repository README converted to PDF

github-readme-to-pdf-example1.pdf Datei anzeigen
Eingabeparameter anzeigen
{ "repository": "https://github.com/meilisearch/meilisearch", "theme": "print", "baseFontSize": 13 }

Wichtige Fakten

Kategorie
Document Tools
Eingabetypen
text, select, number, checkbox
Ausgabetyp
file
Sample-Abdeckung
4
API verfügbar
Yes

Überblick

Mit dem GitHub README zu PDF Tool konvertieren Sie Dokumentationen aus GitHub-Repositories schnell und einfach in professionelle PDF-Dateien mit authentischem GitHub-Layout.

Wann verwenden

  • •Erstellung von Offline-Dokumentationen für Projekte ohne Internetzugang.
  • •Archivierung von Projekt-READMEs für Berichte oder technische Dokumentationen.
  • •Druckvorbereitung von README-Dateien für Meetings oder Präsentationen.

So funktioniert es

  • •Geben Sie die URL des GitHub-Repositories oder das Format 'owner/repo' ein.
  • •Wählen Sie optional den Branch und den Pfad zur README-Datei aus.
  • •Passen Sie Layout-Einstellungen wie Seitengröße, Ränder und Schriftgröße an.
  • •Starten Sie die Konvertierung, um das fertig formatierte PDF direkt herunterzuladen.

Anwendungsfälle

Erstellung von PDF-Handbüchern aus Open-Source-Projekten.
Erstellung von Ausdrucken für die Offline-Code-Review.
Archivierung von Projekt-Meilensteinen in PDF-Form.

Beispiele

1. Technische Dokumentation exportieren

Softwareentwickler
Hintergrund
Ein Entwickler muss die Dokumentation eines Open-Source-Frameworks für ein Offline-Meeting ausdrucken.
Problem
Das direkte Drucken aus dem Browser führt oft zu unsauberen Seitenumbrüchen und abgeschnittenen Inhalten.
Verwendung
Repository-URL eingeben, 'Print'-Theme wählen und A4-Format einstellen.
Beispielkonfiguration
repository: 'https://github.com/meilisearch/meilisearch', theme: 'print', pageSize: 'A4'
Ergebnis
Ein sauber formatiertes PDF mit korrektem Seitenumbruch und optimierter Lesbarkeit.

Mit Samples testen

markdown, pdf
PDF-Beispiele
Generierte PDF-Beispiele von Tools zwischen 2026-02-01 und 2026-02-10
title token pdf
markdown, pdf
Markdown Foliensatz Beispiele
Remark/Marp Markdown Decks zum Testen des PDF Exports
matched family markdown,pdf
markdown, pdf
GitHub Actions Testing - CI/CD Integration
Umfassende GitHub Actions Test-Workflows einschließlich automatisierter Tests, paralleler Ausführung, Test-Berichte, Caching und fortgeschrittene CI/CD-Patterns für moderne Entwicklungs-Pipelines
title token github
sample
GitHub Actions Samples
Comprehensive CI/CD automation examples including workflows, actions, secrets management, and deployment strategies
title token github
sample

Verwandte Hubs

Markdown-Convert-Tools
Entdecken Sie 15 markdown-Tools für convert-Workflows und vergleichen Sie ähnliche Utilities schnell.
Pdf-Convert-Tools
Entdecken Sie 28 pdf-Tools für convert-Workflows und vergleichen Sie ähnliche Utilities schnell.
Pdf-Tools
Entdecken Sie 12 pdf-Tools für utility-Workflows und vergleichen Sie ähnliche Utilities schnell.
Pdf-Generate-Tools
Entdecken Sie 10 pdf-Tools für generate-Workflows und vergleichen Sie ähnliche Utilities schnell.

FAQ

Kann ich auch andere Dateien als die Standard-README.md konvertieren?

Ja, Sie können im Feld 'README-Pfad' einen benutzerdefinierten Pfad zu jeder Markdown-Datei im Repository angeben.

Bleibt das GitHub-Design im PDF erhalten?

Ja, das Tool rendert die Markdown-Inhalte mit einem GitHub-ähnlichen Styling, das für die PDF-Ausgabe optimiert ist.

Was bewirkt die Option 'Hintergrund drucken'?

Diese Einstellung sorgt dafür, dass Hintergrundfarben und grafische Elemente, die im Web-Design enthalten sind, auch im PDF-Dokument korrekt übernommen werden.

Wie kann ich die Lesbarkeit des PDFs verbessern?

Sie können die 'Basis-Schriftgröße' anpassen oder das Seitenlayout über die Randeinstellungen und das Querformat optimieren.

Unterstützt das Tool private Repositories?

Das Tool ist primär für öffentliche GitHub-Repositories konzipiert, die über eine URL öffentlich zugänglich sind.

API-Dokumentation

Request-Endpunkt

POST /de/api/tools/github-readme-to-pdf

Request-Parameter

Parameter-Name Typ Erforderlich Beschreibung
repository text Ja -
branch text Nein -
readmePath text Nein -
theme select Nein -
baseFontSize number Nein -
pageSize select Nein -
landscape checkbox Nein -
printBackground checkbox Nein -
marginTop number Nein -
marginBottom number Nein -
marginLeft number Nein -
marginRight number Nein -
waitUntil select Nein -
waitTime number Nein -

Antwortformat

{
  "filePath": "/public/processing/randomid.ext",
  "fileName": "output.ext",
  "contentType": "application/octet-stream",
  "size": 1024,
  "metadata": {
    "key": "value"
  },
  "error": "Error message (optional)",
  "message": "Notification message (optional)"
}
Datei: Datei

MCP-Dokumentation

Fügen Sie dieses Tool zu Ihrer MCP-Server-Konfiguration hinzu: 

{
  "mcpServers": {
    "elysiatools-github-readme-to-pdf": {
      "name": "github-readme-to-pdf",
      "description": "Ruft ein GitHub README ab und rendert es als PDF",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=github-readme-to-pdf",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

Sie können mehrere Tools verketten, z.B.: `https://elysiatools.com/mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp`, maximal 20 Tools.

Wenn Sie auf Probleme stoßen, kontaktieren Sie uns bitte bei [email protected]