Guía de estilo
Puedes escribir contenido con la sintaxis de Markdown de GitHub.
Usamos un archivo .prettierrc para aplicar estilos estándar con el formateador
de código "Prettier". Si usas VS Code, puedes instalar Prettier desde
https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode
Asegúrate de formatear tu trabajo antes de abrir una PR.
Sintaxis de Markdown
Sirve como página de ejemplo para dar estilo a sitios de Docusaurus basados en Markdown.
Encabezados
H1 - Crea la mejor documentación
H2 - Crea la mejor documentación
H3 - Crea la mejor documentación
H4 - Crea la mejor documentación
H5 - Crea la mejor documentación
H6 - Crea la mejor documentación
Énfasis
El énfasis, también llamado cursiva, con asteriscos o guiones bajos.
El énfasis fuerte, también llamado negrita, con asteriscos o guiones bajos.
Énfasis combinado con asteriscos y guiones bajos.
El tachado usa dos virgulillas. Tacha esto.
Listas
- Primer elemento de la lista ordenada
- Otro elemento
- Sublista sin orden.
- Los números reales no importan, solo que sea un número
- Sublista ordenada
- Y otro elemento.
- La lista sin orden puede usar asteriscos
- O guiones
- O signos más
Enlaces
Soy un enlace en línea con título
Puedes usar números para definir enlaces de referencia
O déjalo vacío y usa el propio texto del enlace.
Las URL, con o sin corchetes angulares, se convierten automáticamente en enlaces. http://www.example.com/ o <http://www.example.com/> y a veces example.com (pero no en GitHub, por ejemplo).
Algo de texto para mostrar que los enlaces de referencia pueden ir más adelante.
Imágenes
Este es nuestro logo (pasa el cursor por encima para ver el texto del título):
En línea:
De referencia:
Puedes usar imágenes de cualquier carpeta indicando la ruta al archivo. La ruta debe ser relativa al archivo Markdown.
Tamaño y estilo de las imágenes
Puedes cambiar el tamaño de las imágenes con HTML en línea.
GIF
Los GIF son útiles para mostrar secuencias cortas de acciones del usuario.
Hay muchas herramientas que te ayudan a crear GIF:
Si usas un "punto de cursor" animado y una "animación al mostrar o hacer clic", el código hexadecimal que usamos es #B53F48.
Código
var s = 'JavaScript syntax highlighting';
alert(s);
s = "Python syntax highlighting"
print(s)
No language indicated, so no syntax highlighting.
But let's throw in a <b>tag</b>.
function highlightMe() {
console.log('This line can be highlighted!');
}
Tablas
Puedes usar dos puntos para alinear las columnas.
| Las tablas | son | geniales |
|---|---|---|
| la col 3 está | alineada a la derecha | $1600 |
| la col 2 está | centrada | $12 |
| las rayas de cebra | quedan bien | $1 |
Debe haber al menos 3 guiones separando cada celda del encabezado. Las barras verticales exteriores (|) son opcionales, y no hace falta que el Markdown sin procesar quede bien alineado. También puedes usar Markdown en línea.
| Markdown | menos | bonito |
|---|---|---|
| Aún | renders | bien |
| 1 | 2 | 3 |
Bloques de cita
Los bloques de cita son muy útiles en el correo electrónico para imitar el texto de respuesta. Esta línea forma parte de la misma cita.
Corte de cita.
Esta es una línea muy larga que se seguirá citando correctamente cuando se ajuste. Vaya, sigamos escribiendo para asegurarnos de que sea lo bastante larga como para que se ajuste en todas las pantallas. Ah, y puedes poner Markdown en un bloque de cita.
HTML en línea
- Lista de definiciones
- Es algo que la gente usa a veces.
- Markdown en HTML
- No funciona muy bien. Usa etiquetas HTML.
Saltos de línea
Esta es una línea para empezar.
Esta línea está separada de la anterior por dos saltos de línea, así que será un párrafo aparte.
Esta línea también es un párrafo aparte, pero... Esta línea está separada solo por un salto de línea, así que es una línea aparte en el mismo párrafo.
Avisos
Esto es una nota
Esto es un consejo
Esto es importante
Esto es una precaución
Esto es una advertencia