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 sollten, werden diese auf MDN Web Docs in einem Codeblock aufgeführt, ä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 über die richtige Einrückung, den Leerraum und die 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 Stil des Codes konsistent zu halten (und um von themenfremden Diskussionen abzulenken). Sie können unsere Konfigurationsdatei einsehen, um sich über die aktuellen Regeln zu informieren, und die Prettier-Dokumentation lesen.

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

Beim Schreiben eines Shell-Codeblocks:

• Fügen Sie am Anfang einer Shell-Anweisung kein $ oder > ein. Das verwirrt mehr, als es hilft und ist nicht nützlich, wenn man die Anweisungen kopiert.
• Kommentare beginnen mit #.
• Wählen Sie "bash", um die Sprache in Markdown anzugeben.

Die Django-Server-seitige-Entwicklung-Dokumentation zeigt eine gute Praxis für die Präsentation von Shell-Prompt-Befehlen.