Richtlinien zum Schreiben von Shell-Prompt-Codebeispielen

Eine Shell ist ein Programm, das darauf wartet, dass Sie einen Befehl eingeben und dann die Eingabetaste drücken. Um anzuzeigen, welche Befehle Sie eingeben sollten, werden diese auf MDN Web Docs in einem Codeblock aufgelistet, ähnlich wie Codebeispiele.

Ein solcher Block sieht folgendermaßen aus:

# This may take a while...
git clone https://github.com/mdn/content
cd content

Meinungen zu korrekter Einrückung, Leerzeichen und Zeilenlängen waren schon immer umstritten. Diskussionen zu diesen Themen lenken von der Erstellung und Pflege von Inhalten ab.

Auf MDN Web Docs verwenden wir Prettier als Code-Formatter, um den Code-Stil konsistent zu halten (und um ablenkende Diskussionen zu vermeiden). Sie können unsere Konfigurationsdatei einsehen, um mehr über die aktuellen Regeln zu erfahren, und die Prettier-Dokumentation lesen.

Prettier formatiert den gesamten Code und hält den Stil konsistent. Dennoch gibt es einige zusätzliche Regeln, die Sie beachten müssen.

Beim Schreiben eines Shell-Codeblocks:

• Verwenden Sie kein $ oder > am Anfang einer Shell-Anweisung. Es verwirrt mehr, als es hilft, und ist nicht nützlich beim Kopieren der Anweisungen.
• Kommentare beginnen mit #.
• Wählen Sie "bash", um die Sprache in Markdown anzugeben.

Dokumente zur Django-Server-seitigen Entwicklung zeigen eine gute Praxis der Präsentation von Shell-Prompt-Befehlen.