Empezando

Starlight es un tema de documentación completo construido sobre el framework Astro. Esta guía te ayudará a comenzar con un nuevo proyecto. Consulta las instrucciones de configuración manual para agregar Starlight a un proyecto de Astro existente.

Inicio rápido

Crea un nuevo proyecto

Crea un nuevo proyecto de Astro + Starlight ejecutando el siguiente comando en tu terminal:

npm create astro@latest -- --template starlight

pnpm create astro --template starlight

yarn create astro --template starlight

Esto creará un nuevo directorio de proyecto con todos los archivos y configuraciones necesarios para tu sitio.

Inicia el servidor de desarrollo

Cuando trabajas localmente, el servidor de desarrollo de Astro te permite previsualizar tu trabajo y actualiza automáticamente tu navegador cuando realizas cambios.

Dentro del directorio de tu proyecto, ejecuta el siguiente comando para iniciar el servidor de desarrollo:

npm run dev

pnpm dev

yarn dev

Esto imprimirá un mensaje en tu terminal con la URL de la vista previa local. Abre esta URL para comenzar a navegar por tu sitio.

Añade contenido

Starlight está listo para que añadas nuevo contenido o ¡traigas tus archivos existentes!.

Formatos de archivo

Starlight admite la creación de contenido en Markdown y MDX sin necesidad de configuración. Puedes agregar compatibilidad con Markdoc instalando la integración experimental de Astro Markdoc.

Añade páginas

Añade nuevas páginas a tu sitio creando archivos .md o .mdx en src/content/docs/. Utiliza subcarpetas para organizar tus archivos y crear múltiples segmentos de ruta.

Por ejemplo, la siguiente estructura de archivos generará páginas en example.com/hello-world y example.com/guides/faq:

Frontmatter con seguridad de tipos

Todas las páginas de Starlight comparten un conjunto común personalizable de propiedades frontmatter para controlar cómo se muestra la página:

---
title: ¡Hola, Mundo!
description: Esta es una página en mi sitio impulsado por Starlight
---

Si olvidas algo importante, Starlight te lo hará saber.

Siguientes pasos

• Configura: Aprende acerca de las opciones comunes en “Personalizando Starlight”.
• Navega: Configura tu barra lateral siguiendo la guía “Barra Lateral de Navegación”.
• Componentes: Descubre tarjetas incorporadas, pestañas y más en la guía “Componentes”.
• Despliega: Publica tu trabajo siguiendo la guía “Despliega tu sitio” en la documentación de Astro.

Actualizando Starlight

Starlight es una integración Astro y se actualiza de la misma manera que cualquier otra integración @astrojs/*:

npm install @astrojs/starlight@latest

pnpm upgrade @astrojs/starlight --latest

yarn upgrade @astrojs/starlight --latest

Consulta el registro de cambios de Starlight para obtener una lista completa de los cambios realizados en cada versión.

Solución de problemas de Starlight

Utiliza las páginas de referencia de configuración del proyecto y configuración del frontmatter de páginas individuales para asegurarte de que tu sitio de Starlight esté configurado y funcione correctamente. Consulta las guías en la barra lateral para obtener ayuda en la adición de contenido y personalización de tu sitio de Starlight.

Si no encuentras la respuesta en la documentación, visita la documentación completa de Astro para obtener la documentación completa de Astro. Es posible que tu pregunta se responda comprendiendo cómo funciona Astro en general, debajo de este tema Starlight.

También puedes revisar cualquier problema conocido de Starlight en GitHub y obtener ayuda en el Discord de Astro de nuestra activa y amigable comunidad. ¡Publica preguntas en nuestro foro #support con la etiqueta “starlight” o visita nuestro canal dedicado #starlight para discutir el desarrollo actual y más!