Richtlinien für das 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 sollen, werden diese auf den MDN Web Docs in einem Code-Block aufgelistet, ähnlich wie Code-Beispiele.

Ein solcher Block sieht folgendermaßen aus:

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

Meinungen über korrekte Einrückungen, Leerzeichen und Zeilenlängen sind schon immer umstritten. Diskussionen zu diesen Themen lenken von der Erstellung und Pflege von Inhalten ab.

Auf den MDN Web Docs verwenden wir Prettier als Code-Formatter, um den Code-Stil konsistent zu halten (und um themenfremde 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 befolgen müssen.

Beim Schreiben eines Shell-Codeblocks:

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

Die Django-Server-seitigen Entwicklungsdokumente zeigen eine gute Praxis bei der Darstellung von Shell-Prompt-Befehlen.