Variables de entorno

El tema lee las variables de entorno en el momento de la compilación desde config.ts y los componentes personalizados. Los repositorios de contenido las definen en su flujo de trabajo de GitHub Actions para personalizar cada sitio sin modificar la configuración.

Referencia de variables

Variable	Valor predeterminado	Propósito
DOCS_TITLE	Documentation	Título del sitio que se muestra en el encabezado y la pestaña del navegador
DOCS_SITE	https://f5-sales-demo.github.io	URL base canónica del sitio desplegado
DOCS_BASE	/	Ruta base de la URL (p. ej., /my-repo/ para sitios de proyecto)
DOCS_DESCRIPTION	(cadena vacía)	Descripción del sitio para metadatos y el complemento llms.txt
DOCS_HOME	https://f5-sales-demo.github.io/docs/	URL de la página de inicio enlazada desde el título del sitio
GITHUB_REPOSITORY	(cadena vacía)	Se usa para generar el enlace social de GitHub y los enlaces de edición
LLMS_OPTIONAL_LINKS	[]	Arreglo JSON de enlaces adicionales para el complemento llms.txt

Dónde se usa cada variable

DOCS_TITLE

config.ts

const title = options.title || process.env.DOCS_TITLE || 'Documentation';

Se pasa a la opción title de Starlight y al complemento starlight-llms-txt. Aparece en el encabezado del sitio y en la etiqueta HTML <title>.

DOCS_SITE

config.ts

const site = options.site || process.env.DOCS_SITE || 'https://f5-sales-demo.github.io';

Establece la propiedad site de nivel superior de Astro. Se usa para las URL canónicas, la generación del mapa del sitio y los metadatos de Open Graph.

DOCS_BASE

config.ts

const base = options.base || process.env.DOCS_BASE || '/';

Establece la propiedad base de nivel superior de Astro. Es obligatoria cuando se despliega en un subdirectorio (p. ej., https://example.com/my-repo/).

DOCS_DESCRIPTION

config.ts

const description = options.description || process.env.DOCS_DESCRIPTION || '';

Se pasa al complemento starlight-llms-txt como descripción del sitio. Se usa en el archivo llms.txt generado.

DOCS_HOME

components/SiteTitle.astro

const docsHome = process.env.DOCS_HOME || 'https://f5-sales-demo.github.io/docs/';

Lo lee el componente personalizado SiteTitle.astro. Envuelve el título del sitio en el encabezado con un enlace a esta URL, lo que permite a los usuarios regresar a una página de inicio de documentación centralizada. Es útil cuando múltiples repositorios de contenido comparten el mismo tema y se desea un enlace de “inicio” coherente en todos los sitios.

GITHUB_REPOSITORY

config.ts

const githubRepository = options.githubRepository || process.env.GITHUB_REPOSITORY || '';

Se usa para generar el icono social de GitHub en el encabezado del sitio y la URL base del enlace de edición. GitHub Actions establece esta variable automáticamente (p. ej., owner/repo).

LLMS_OPTIONAL_LINKS

config.ts

const llmsOptionalLinks = options.llmsOptionalLinks
  || (process.env.LLMS_OPTIONAL_LINKS ? JSON.parse(process.env.LLMS_OPTIONAL_LINKS) : []);

Un arreglo codificado en JSON de objetos { title, url } que se pasa al complemento starlight-llms-txt. Estos aparecen como enlaces adicionales en el archivo llms.txt generado.

Valor de ejemplo:

[{"title": "API Reference", "url": "https://api.example.com/docs"}]

Definición de variables en GitHub Actions

Los repositorios de contenido pasan estas variables a través de su flujo de trabajo:

jobs:
  docs:
    uses: f5-sales-demo/docs-control/.github/workflows/github-pages-deploy.yml@main
    with:
      docs_title: "My Project Docs"
      docs_site: "https://example.com"
      docs_base: "/my-project/"
      docs_home: "https://example.com/home/"

La variable GITHUB_REPOSITORY es proporcionada automáticamente por el ejecutor de GitHub Actions y no necesita definirse manualmente.