Variables d'environnement

Le thème lit les variables d’environnement au moment de la compilation à partir de config.ts et des composants personnalisés. Les dépôts de contenu les définissent dans leur workflow GitHub Actions pour personnaliser chaque site sans modifier la configuration.

Référence des variables

Variable	Valeur par défaut	Utilité
DOCS_TITLE	Documentation	Titre du site affiché dans l’en-tête et l’onglet du navigateur
DOCS_SITE	https://f5-sales-demo.github.io	URL de base canonique du site déployé
DOCS_BASE	/	Chemin de base de l’URL (ex. : /my-repo/ pour les sites de projet)
DOCS_DESCRIPTION	(chaîne vide)	Description du site pour les métadonnées et le plugin llms.txt
DOCS_HOME	https://f5-sales-demo.github.io/docs/	URL de la page d’accueil liée depuis le titre du site
GITHUB_REPOSITORY	(chaîne vide)	Utilisé pour construire le lien social GitHub et les liens d’édition
LLMS_OPTIONAL_LINKS	[]	Tableau JSON de liens supplémentaires pour le plugin llms.txt

Utilisation de chaque variable

DOCS_TITLE

config.ts

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

Transmis à l’option title de Starlight et au plugin starlight-llms-txt. Apparaît dans l’en-tête du site et dans la balise HTML <title>.

DOCS_SITE

config.ts

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

Définit la propriété site de premier niveau d’Astro. Utilisé pour les URL canoniques, la génération du plan du site et les métadonnées Open Graph.

DOCS_BASE

config.ts

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

Définit la propriété base de premier niveau d’Astro. Requise lors du déploiement dans un sous-répertoire (ex. : https://example.com/my-repo/).

DOCS_DESCRIPTION

config.ts

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

Transmis au plugin starlight-llms-txt en tant que description du site. Utilisé dans le fichier llms.txt généré.

DOCS_HOME

components/SiteTitle.astro

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

Lu par le composant personnalisé SiteTitle.astro. Entoure le titre du site dans l’en-tête d’un lien vers cette URL, permettant aux utilisateurs de revenir à une page d’accueil de documentation centrale. Utile lorsque plusieurs dépôts de contenu partagent le même thème et que vous souhaitez un lien « accueil » cohérent sur tous les sites.

GITHUB_REPOSITORY

config.ts

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

Utilisé pour générer l’icône sociale GitHub dans l’en-tête du site et l’URL de base des liens d’édition. GitHub Actions définit cette variable automatiquement (ex. : owner/repo).

LLMS_OPTIONAL_LINKS

config.ts

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

Un tableau d’objets { title, url } encodé en JSON, transmis au plugin starlight-llms-txt. Ces éléments apparaissent comme liens supplémentaires dans le fichier llms.txt généré.

Exemple de valeur :

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

Définir les variables dans GitHub Actions

Les dépôts de contenu transmettent ces variables via leur workflow :

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 est fournie automatiquement par l’exécuteur GitHub Actions et n’a pas besoin d’être définie manuellement.