← Zurück zum Blog

So speichert man GitHub-READMEs und Issues als Markdown

· Save Team
githubdocumentationdevelopmentcode

GitHub ist die Heimat von Open Source — vollgepackt mit unschätzbarer Dokumentation, Issue-Diskussionen und Code-Beispielen. Obwohl GitHub bereits Markdown verwendet, ist das Extrahieren von Inhalten für eigene Notizen oder Dokumentation nicht immer unkompliziert. So macht Save es einfach.

Warum GitHub-Inhalte als Markdown speichern?

Obwohl GitHub-Inhalte bereits in Markdown vorliegen, möchte man vielleicht:

  • Offline-Dokumentation erstellen für die Referenz
  • Projekt-Wikis aufbauen aus mehreren Quellen
  • Wichtige Issues archivieren, bevor sie geschlossen werden
  • Recherchen kompilieren aus mehreren Repositories
  • Dokumentation an KI-Assistenten weitergeben

Was Save von GitHub erfasst

README-Dateien

  • Vollständiger README-Inhalt mit Formatierung
  • Codeblöcke mit erhaltener Syntaxhervorhebung
  • Tabellen und Listen intakt
  • Bildreferenzen erhalten

Issues und Discussions

  • Issue-Titel und Beschreibung
  • Alle Kommentare im Thread
  • Code-Snippets und Logs
  • Referenzlinks

Pull Requests

  • PR-Beschreibung und Änderungen
  • Review-Kommentare
  • Verknüpfte Issues

Beispielausgabe

# Projektname

![Build-Status](badge-url)

## Installation

\`\`\`bash
npm install project-name
\`\`\`

## Verwendung

\`\`\`javascript
const project = require('project-name');
project.doSomething();
\`\`\`

## Konfiguration

| Option | Standard | Beschreibung |
|--------|----------|--------------|
| debug | false | Debug-Modus aktivieren |
| timeout | 5000 | Request-Timeout in ms |

Anwendungsfälle

Persönliche Dokumentation aufbauen

  • Setup-Anleitungen aus mehreren Repos kompilieren
  • Schnellreferenz-Blätter erstellen
  • Fehlerbehebungsanleitungen aus Issues erstellen

Projektrecherche

  • Vergleichen, wie verschiedene Projekte ähnliche Probleme lösen
  • Code-Muster über Repositories analysieren
  • Bibliotheken für das Team dokumentieren

Issue-Verfolgung

  • Gelöste Issues für zukünftige Referenz archivieren
  • Bug-Reports mit vollem Kontext speichern
  • Workarounds und Lösungen dokumentieren

KI-gestützte Entwicklung

GitHub-Inhalte an KI-Assistenten weitergeben, um:

  • Komplexe Dokumentation zu erklären
  • Implementierungen basierend auf Beispielen vorzuschlagen
  • Issues basierend auf ähnlichen Problemen zu debuggen

Tipps für beste Ergebnisse

  1. Funktioniert auf jeder GitHub-Seite — Repos, Issues, PRs, Discussions
  2. Erfasst Codeblöcke — mit korrekter Syntaxformatierung
  3. Behält Tabellen bei — häufig in der Dokumentation

GitHub vs. Raw Markdown

Obwohl man Raw Markdown von GitHub kopieren könnte, bietet Save:

  • Einschluss gerenderter Inhalte (nützlich für generierte Docs)
  • Vollständige Issue-Threads erfassen
  • Funktioniert auch auf Wiki-Seiten
  • Behandelt GitHub-spezifische Formatierung

Loslegen

Save im Chrome Web Store installieren — Ihren Entwicklungs-Workflow verbessern.


Haben Sie Fragen? Schreiben Sie uns an [email protected]