← Tilbage til blog

Sådan gemmer du GitHub READMEs og issues som Markdown

· Save Team
githubdocumentationdevelopmentcode

GitHub er hjemstedet for open source — fyldt med uvurderlig dokumentation, issue-diskussioner og kodeeksempler. Selvom GitHub allerede bruger Markdown, er det ikke altid ligetil at udtrække indhold til dine egne noter eller dokumentation. Her er, hvordan Save gør det nemt.

Hvorfor gemme GitHub-indhold som Markdown?

Selvom GitHub-indhold allerede er i Markdown, vil du måske:

  • Oprette offline-dokumentation til reference
  • Bygge projekt-wikis fra flere kilder
  • Arkivere vigtige issues inden de lukkes
  • Kompilere research fra flere repositories
  • Føde dokumentation til AI-assistenter

Hvad Save fanger fra GitHub

README-filer

  • Fuldt README-indhold med formatering
  • Kodeblokke med syntax highlighting bevaret
  • Tabeller og lister intakte
  • Billedreferencer bibeholdt

Issues og diskussioner

  • Issue-titel og beskrivelse
  • Alle kommentarer i tråden
  • Kodestykker og logs
  • Referencellinks

Pull Requests

  • PR-beskrivelse og ændringer
  • Review-kommentarer
  • Linkede issues

Eksempel output

# Projektnavn

![Build Status](badge-url)

## Installation

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

## Brug

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

## Konfiguration

| Mulighed | Standard | Beskrivelse |
|----------|----------|-------------|
| debug | false | Aktiver debug-tilstand |
| timeout | 5000 | Anmodningstimeout i ms |

Anvendelsestilfælde

Bygning af personlig dokumentation

  • Kompilér opsætningsguider fra flere repos
  • Lav hurtigreferencer
  • Byg fejlfindingsguider fra issues

Projektforskning

  • Sammenlign hvordan forskellige projekter løser lignende problemer
  • Analysér kodemønstre på tværs af repositories
  • Dokumentér biblioteker til dit team

Issue-sporing

  • Arkivér løste issues til fremtidig reference
  • Gem fejlrapporter med fuld kontekst
  • Dokumentér omveje og løsninger

AI-udviklingsassistance

Feed GitHub-indhold til AI-assistenter for at:

  • Forklare kompleks dokumentation
  • Foreslå implementeringer baseret på eksempler
  • Debug issues baseret på lignende problemer

Tips til bedste resultater

  1. Virker på enhver GitHub-side — repos, issues, PRs, diskussioner
  2. Fanger kodeblokke — med ordentlig syntaksformatering
  3. Bevarer tabeller — almindelige i dokumentation

GitHub vs. Raw Markdown

Selvom du kunne kopiere raw Markdown fra GitHub, giver Save:

  • Inkluderet gengivet indhold (nyttigt til genererede docs)
  • Fangede fulde issue-tråde
  • Virker på wiki-sider også
  • Håndterer GitHub-specifik formatering

Kom i gang

Installer Save fra Chrome Web Store — forbedre din udviklingsworkflow.


Har du spørgsmål? Kontakt os på [email protected]