Aller au contenu

Tape un mot pour chercher dans les pages.

↑↓ Choisir↵ OuvrirÉchap Fermer

Référence

Ce que le build écrit dans dist/, ce qui est publié et ce qui ne l'est pas, et les adresses que lisent les agents et la console.

Le build écrit un site statique. Chaque fichier ci-dessous est servi à la racine de la doc, ou sous son base s’il est déclaré.

Contenu de dist/

Fichier ou dossierContenu
index.html, <page>/index.htmlLes pages du site.
<page>.mdChaque page en Markdown. Par exemple /guides/publier/ a sa version à /guides/publier.md.
llms.txtL’index de la doc au format llmstxt.org : une ligne par page, avec sa description, rangée par onglet et par groupe.
.well-known/llms.txtLe même fichier, à l’adresse conventionnelle.
llms-full.txtToute la doc en un seul fichier Markdown.
pagefind/L’index de la recherche du site.
_hgdc/corpus.jsonLe contenu publié, lu par la console pour indexer l’assistant.

Chaque page annonce sa version Markdown dans son <head>, avec rel="alternate" et le type text/markdown.

Ce qui est publié

  • Les pages MDX et .md du dossier de la doc.
  • Les médias des dossiers d’images : images/, img/, logo/, assets/ et static/.
  • Tout le contenu de public/, servi à la racine.
  • Le logo et le favicon déclarés dans docs.json, même hors de ces dossiers.

Ce qui n’est pas publié

  • Les fichiers dont le nom commence par _.
  • Les dossiers node_modules, dist, .git, .github, .vercel et .hgdc-docs, ainsi que tous les dossiers cachés.
  • Les médias rangés hors d’un dossier d’images ou de public/, sauf le logo et le favicon déclarés.

Le dossier .hgdc-docs/ contient le cache du build. Ne le publie pas et ajoute-le à ton .gitignore.

Ce que lit la console

La console relit /_hgdc/corpus.json sur l’adresse du site, toutes les quinze minutes et à chaque synchronisation demandée. Ce fichier doit être accessible sans authentification. Voir Synchroniser et vérifier l’index.

Ce que lisent les agents

  • llms.txt et llms-full.txt pour découvrir la doc.
  • Les pages .md pour lire une page sans son habillage.
  • Le serveur MCP pour chercher, sans passer par le site.

Le contenu de llms.txt et de llms-full.txt suit la navigation : la version par défaut passe en premier, les autres versions sont rangées dans une section Optional.