← Terug naar blog

GitHub-README's en issues opslaan als Markdown

· Save Team
githubdocumentationdevelopmentcode

GitHub is de thuisbasis van open source — vol met onschatbare documentatie, issue-discussies en codevoorbeelden. Hoewel GitHub al Markdown gebruikt, is het extraheren van inhoud voor je eigen notities of documentatie niet altijd eenvoudig. Hier lees je hoe Save het gemakkelijk maakt.

Waarom GitHub-inhoud opslaan als Markdown?

Hoewel GitHub-inhoud al in Markdown staat, wil je misschien:

  • Offline documentatie maken voor naslag
  • Projectwiki’s bouwen van meerdere bronnen
  • Belangrijke issues archiveren voor ze worden gesloten
  • Onderzoek compileren van meerdere repositories
  • Documentatie aan AI-assistenten doorgeven

Wat Save vastlegt van GitHub

README-bestanden

  • Volledige README-inhoud met opmaak
  • Codeblokken met syntaxmarkering bewaard
  • Tabellen en lijsten intact
  • Afbeeldingsreferenties behouden

Issues en discussies

  • Issuetitel en -beschrijving
  • Alle reacties in de thread
  • Codefragmenten en logs
  • Referentielinks

Pull requests

  • PR-beschrijving en wijzigingen
  • Reviewopmerkingen
  • Gekoppelde issues

Voorbeelduitvoer

# Projectnaam

## Installatie

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

## Gebruik

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

## Configuratie

| Optie | Standaard | Beschrijving |
|-------|-----------|-------------|
| debug | false | Debugmodus inschakelen |
| timeout | 5000 | Verzoektimeout in ms |

Toepassingen

Persoonlijke documentatie bouwen

  • Installatiegidsen van meerdere repos compileren
  • Snelle naslagbladen maken
  • Probleemoplossende gidsen bouwen van issues

Projectonderzoek

  • Vergelijken hoe verschillende projecten vergelijkbare problemen oplossen
  • Codepatronen over repositories analyseren
  • Bibliotheken documenteren voor je team

Issue-tracking

  • Opgeloste issues archiveren voor toekomstige naslag
  • Bugrapporten opslaan met volledige context
  • Workarounds en oplossingen documenteren

AI-ontwikkelingsassistentie

GitHub-inhoud aan AI-assistenten doorgeven om:

  • Complexe documentatie uit te leggen
  • Implementaties voor te stellen op basis van voorbeelden
  • Problemen te debuggen op basis van vergelijkbare issues

Tips voor beste resultaten

  1. Werkt op elke GitHub-pagina — repos, issues, PR’s, discussies
  2. Legt codeblokken vast — met correcte syntaxopmaak
  3. Behoudt tabellen — gebruikelijk in documentatie

Aan de slag

Installeer Save in de Chrome Web Store — verbeter je ontwikkelworkflow.


Vragen? Bereik ons via [email protected]