Creación de contenido en Markdown
Starlight admite la gama completa de la sintaxis Markdown en archivos .md
, así como el frontmatter en YAML para definir metadatos como el título y la descripción.
Por favor, asegúrate de consultar la documentación de MDX o Markdoc si estás utilizando esos formatos de archivo, ya que el soporte y el uso de Markdown pueden variar.
Estilos en línea
El texto puede estar en negrita, en cursiva, o tachado.
Puedes enlazar a otra página.
Puedes resaltar código en línea
con comillas invertidas.
Imágenes
Las imágenes en Starlight utilizan el soporte de assets optimizados incorporado en Astro.
Markdown y MDX admiten la sintaxis Markdown para mostrar imágenes, que incluye alt-text para lectores de pantalla y tecnología de asistencia.
También se admiten rutas de imágenes relativas para imágenes almacenadas localmente en tu proyecto.
Encabezados
Puedes estructurar el contenido utilizando encabezados. Los encabezados en Markdown se indican con uno o más #
al comienzo de la línea.
Cómo estructurar el contenido de la página en Starlight
Starlight está configurado para utilizar automáticamente el título de tu página como un encabezado de nivel superior y se incluirá un encabezado “Visión general” en la parte superior de la tabla de contenido de cada página. Recomendamos comenzar cada página con contenido de texto de párrafo regular y utilizar encabezados dentro de la página a partir de <h2>
en adelante:
Enlaces de anclaje automáticos para encabezados.
Al utilizar encabezados en Markdown, se generan automáticamente enlaces de anclaje para que puedas vincular directamente a ciertas secciones de tu página:
Los encabezados de nivel 2 (<h2>
) y nivel 3 (<h3>
) aparecerán automáticamente en la tabla de contenido de la página.
Apartados
Los apartados (también conocidos como “apartados” o ”contenido destacado”) son útiles para mostrar información secundaria junto al contenido principal de una página.
Starlight proporciona una sintaxis personalizada de Markdown para renderizar apartados. Los bloques de apartados se indican utilizando un par de triples dos puntos :::
para envolver tu contenido, y pueden ser de tipo note
, tip
, caution
o danger
.
Puedes anidar cualquier otro tipo de contenido Markdown dentro de un apartado, pero los apartados son más adecuados para fragmentos de contenido cortos y concisos.
Nota de apartados
Títulos personalizados para los apartados
Puedes especificar un título personalizado para el apartado utilizando corchetes cuadrados después del tipo del apartado, por ejemplo, :::tip[¿Sabías esto?]
.
Más tipos de apartados
Los apartados de caution y danger son útiles para llamar la atención del usuario sobre detalles que podrían generar problemas. Si te encuentras utilizando estos tipos de apartados con frecuencia, también puede ser una señal de que lo que estás documentando podría beneficiarse de una reestructuración o rediseño.
Citas en bloque
Esto es una cita en bloque, que se utiliza comúnmente para citar a otra persona o documento.
Las citas en bloque se indican con un
>
al inicio de cada línea.
Bloques de código
Un bloque de código se indica con un bloque de tres comillas invertidas ```
al inicio y al final. Puedes indicar el lenguaje de programación que se está utilizando después de las comillas invertidas de apertura.
Otras características comunes de Markdown
Starlight admite todas las demás sintaxis de autoría de Markdown, como listas y tablas. Puedes consultar la Guía de referencia de Markdown para obtener una descripción general rápida de todos los elementos de sintaxis de Markdown.
Configuración avanzada de Markdown y MDX
Starlight utiliza el motor de renderizado de Markdown y MDX de Astro, construido sobre remark y rehype. Puedes añadir soporte para sintaxis y comportamientos personalizados añadiendo remarkPlugins
o rehypePlugins
en tu archivo de configuración de Astro. Consulta la sección “Configuración de Markdown y MDX” en la documentación de Astro para obtener más información.