Référence
La commande hgdc-docs
Les commandes dev, build et preview, leurs options et les variables d'environnement du build.
hgdc-docs est installée avec le paquet @hgdc/docs. Elle se lance depuis le dossier de la doc, ou avec le chemin du dossier en argument.
hgdc-docs <dev|build|preview> [dossier] [--port 4321] [--host 0.0.0.0]Commandes
| Commande | Effet |
|---|---|
hgdc-docs dev | Site local, rechargé à chaque modification. Adresse par défaut : http://localhost:4321/. |
hgdc-docs build | Site statique dans dist/, avec la recherche, llms.txt, les pages Markdown et le corpus de l’assistant. C’est la commande par défaut si aucune n’est donnée. |
hgdc-docs preview | Sert le dernier build, pour vérifier avant de publier. |
Options
| Option | Commandes | Effet |
|---|---|---|
--port <numéro> | dev, preview | Change le port. |
--host <adresse> | dev, preview | Adresse d’écoute. Utilise 0.0.0.0 pour l’accès depuis un autre appareil du réseau. |
-h, --help | toutes | Affiche l’aide. |
Un docs.json invalide fait échouer dev et build avec le détail des problèmes. Voir docs.json.
Variables d’environnement
| Variable | Rôle |
|---|---|
HGDC_DOCS_SITE | Adresse publique du site, par exemple https://docs.acme.ch. Elle rend les liens de llms.txt absolus. Sans elle, Docs utilise l’adresse de production détectée sur Vercel, si elle existe. |
HGDC_DOCS_OUT | Dossier de sortie du build. Défaut : dist/ dans le dossier de la doc. |
HGDC_DOCS_API | Adresse de l’API de l’assistant. Défaut : https://docs.hgdc.ch. |
Le build sur Host reçoit l’adresse de production sans configuration de ta part.
Ce que contient dist/
Le contenu est décrit dans Fichiers publiés.
Si ça ne marche pas
HGDC_DOCS_SITE : adresse invalide: donne une adresse complète, avechttps://et sans chemin de fichier.- Le port est déjà utilisé : choisis-en un autre avec
--port. hgdc-docs: command not found: le paquet n’est pas installé dans le dossier de la doc, ou les scripts depackage.jsonne sont pas lancés depuis ce dossier. Lancenpm installpuisnpm run dev.
Cette page t'a aidé ?
Merci, c'est noté.