Richtlinien für das Schreiben von Shell-Prompt-Codebeispielen

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

Ein solcher Block sieht so aus:

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

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

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

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

Beim Schreiben eines Shell-Codeblocks:

• Fügen Sie kein $ oder > zu Beginn einer Shell-Anweisung hinzu. Dies verwirrt mehr, als es hilft, und ist beim Kopieren der Anweisungen nicht nützlich.
• Kommentare beginnen mit #.
• Wählen Sie "bash", um die Sprache im Markdown anzugeben.

Die Django Server-Side-Entwicklungsdokumentation zeigt eine gute Praxis der Präsentation von Shell-Prompt-Befehlen.