markdown

Markdown nach CommonMark-Spezifikation

Für wen: Doku-Autoren

So nutzt du es

Inhalt als .github/copilot-instructions.md ins Repository legen (bzw. unter .github/instructions/ für mehrere Dateien). GitHub Copilot berücksichtigt die Anweisungen dann in Chat und Code-Vorschlägen für dieses Repository.

Im Detail

Diese Instruction weist die KI an, Markdown strikt nach der CommonMark-Spezifikation zu formatieren — also korrekte Überschriften-Hierarchie, konsistente Listen, sauberes Code-Fencing und keine plattformspezifischen Sonderzeichen, die in manchen Renderern zu Darstellungsfehlern führen. Nützlich für alle, die KI-generierte Doku, READMEs oder Commit-Beschreibungen direkt weiterverwenden wollen, ohne die Formatierung manuell nachzuziehen. Der Mehrwert liegt vor allem in der Konsistenz über viele Dokumente hinweg, nicht in inhaltlicher Qualität — dafür braucht es zusätzliche Regeln wie self-explanatory-code-commenting oder projektspezifische Doku-Vorgaben.

Praxis-Tipp

Kombiniere sie mit memory-bank, wenn du langfristig gepflegte Projekt-Dokumentation in Markdown willst, die über Sessions hinweg konsistent bleibt.

Siehe auch

• memory-bank
• self-explanatory-code-commenting

Lizenz & Quelle

• Lizenz: MIT
• Quelle: github.com/github/awesome-copilot

Lade …