Markdown in PNG umwandeln: ein README-Beispiel
Exportiere einen kompakten README-Ausschnitt als lesbares PNG und prüfe Codeformatierung und Umbrüche vor dem Teilen.
Eine README ist als Dokument nützlich. Ein Ausschnitt kann außerdem ein Projekt in einem Release-Beitrag vorstellen. Öffne für ein echtes öffentliches Repository GitHub README zu Bild, gib die GitHub-URL ein und lade die README, bevor du sie für den Export prüfst oder bearbeitest. Für das fiktive Beispiel unten verwende direkt den Markdown-Konverter. Wähle einen eigenständig verständlichen Abschnitt.
Eine gute Projektkarte beantwortet drei Fragen: Was ist das, wie beginne ich und wo lese ich weiter? Das Beispiel nutzt das fiktive Notizprojekt Atlas Notes. Titel, Kurzbeschreibung, Startbefehle und eine knappe Funktionsliste schaffen eine klare Lesereihenfolge.
Die Befehle sind README-Demoinhalt, keine Installationsanleitung für diese Website oder ein reales Paket. Prüfe bei einem echten Repository zuerst, ob die Befehle den aktuellen Einrichtungsanweisungen entsprechen.
Kopiere den Inhalt innerhalb der äußeren Markdown-Begrenzung in den Konverter. Die innere Bash-Begrenzung gehört zur README und muss erhalten bleiben, damit die Befehle als Codeblock erscheinen.
# Atlas Notes
A small Markdown notebook for release teams.
## Quick start
```bash
npm install
npm run dev
```
- Local Markdown files
- Reviewed release notes
- Portable documentation
Das Ergebnis ist eine kompakte Projektvorstellung. Prüfe die Überschriftenhierarchie und die Unterscheidung zwischen Fließtext, Code und Funktionsliste. Verlinke die vollständige README neben dem Bild als Text. Ein PNG bietet nicht dieselben auswählbaren Befehle und Navigationsmöglichkeiten.
Wähle für dieses Text-und-Code-Beispiel PNG. Die Breite sollte beide Befehlszeilen ungebrochen lassen, ohne den Fließtext am Zielort zu klein wirken zu lassen. Prüfe zuerst die längste Zeile: Mehr Breite kann Umbrüche vermeiden, doch in einem schmalen Feed wird das Bild weiterhin skaliert.
Enthält die vollständige README Badges, mehrere Screenshots und eine lange Installationserklärung, erstelle getrennte Bilder für getrennte Aufgaben. Projektübersicht und Fehlerbehebung brauchen selten denselben Ausschnitt oder dieselbe Textmenge.
- Prüfe, ob alle Codeblock-Begrenzungen geöffnet und geschlossen sind. Eine fehlende Begrenzung kann folgenden Text als Code erscheinen lassen.
- Achte darauf, dass keine Browserbedienelemente oder unpassenden Repository-Oberflächen im Ergebnis landen. Die Karte soll den gewählten Inhalt vermitteln.
- Lade das PNG herunter und betrachte es in der geplanten Anzeigegröße, besonders Befehle und Satzzeichen.
- Beschreibe Projekt und Inhalt im Alternativtext und ergänze den Link zur ursprünglichen README im Beitrag.
Ändert sich die README, erzeuge das Bild aus der bearbeiteten Quelle erneut. So stimmen Bild und Dokumentation überein. Lade eine öffentliche GitHub-README, prüfe und exportiere sie.
Weitere Anleitungen: Markdown-Codeblöcke formatieren und Bilder für mehrere Kanäle planen.