Pautas para escribir ejemplos de código de consola de shell

Las siguientes pautas cubren cómo escribir ejemplos de código de consola de shell para MDN Web Docs.

Qué es un "shell"

Un shell es un programa que espera a que escribas un comando y luego presiones la tecla de retorno. Para indicar qué comandos debe escribir, el contenido de MDN Web Docs los enumera en un bloque de código, similar a los ejemplos de código.

Tal bloque se ve así:

bash

# Esto puede tardar un rato...
git clone https://github.com/mdn/content
cd content

Pautas generales para ejemplos de código de consola de shell

Elegir un formato

Las opiniones sobre la indentación correcta, los espacios en blanco y la longitud de las líneas siempre han sido controvertidas. Las discusiones sobre estos temas son una distracción de la creación y el mantenimiento del contenido.

En MDN Web Docs, usamos Prettier como formateador de código para mantener la consistencia del estilo del código (y para evitar discusiones fuera del tema). Puede consultar nuestro archivo de configuración para conocer las reglas actuales y leer la documentación de Prettier.

Prettier formatea todo el código y mantiene el estilo consistente. Sin embargo, hay algunas reglas adicionales que debe seguir.

Escribir bloques de código de shell

Al escribir un bloque de código de shell:

  • No incluya un $ o > al comienzo de una instrucción de shell. Confunde más de lo que ayuda y no es útil a la hora de copiar las instrucciones.
  • Los comentarios comienzan con #.
  • Elija "bash" para indicar el idioma en markdown.

Véase también

Documentos de desarrollo del lado del servidor de Django muestran una presentación de buenas prácticas de los comandos de la consola de shell.