Empezando
Creando un nuevo proyecto
Starlight es un tema de documentación completo construido sobre el framework Astro.
Puedes crear un nuevo proyecto de Astro + Starlight utilizando el siguiente comando:
# crear un nuevo proyecto con npm
npm create astro@latest -- --template starlight
# crear un nuevo proyecto con pnpm
pnpm create astro --template starlight
# crear un nuevo proyecto con yarn
yarn create astro --template starlight
Esto creará un nuevo directorio de proyecto con todos los archivos y configuraciones necesarios para tu sitio.
Creando contenido con Starlight
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. (Puedes agregar compatibilidad con Markdoc instalando la integración experimental de Astro Markdoc.)
Agregar páginas
Agrega nuevas páginas a tu sitio automáticamente creando archivos .md
o .mdx
en src/content/docs/
. Agrega subcarpetas para organizar tus archivos y crear segmentos de ruta múltiples.
src/content/docs/hello-world.md => tu-sitio.com/hello-world
src/content/docs/guides/faq.md => tu-sitio.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.
Desplegando tu sitio web de Starlight
Una vez que hayas creado y personalizado tu sitio web de Starlight, puedes implementarlo en un servidor web o plataforma de alojamiento de tu elección, incluyendo Netlify, Vercel, GitHub Pages y muchos más.
Aprende sobre cómo desplegar un sitio Astro 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/*
:
# actualizar Starlight con npm
npm install @astrojs/starlight@latest
# actualizar Starlight con pnpm
pnpm upgrade @astrojs/starlight --latest
# actualizar Starlight con yarn
yarn upgrade @astrojs/starlight --latest
Puedes ver una lista completa de los cambios realizados en cada versión en el registro de cambios de Starlight.