Chapitre 22Référence

Référence

Variables, commandes, options, tokens, attributs, codes d'erreur, glossaire. Ce qu'on vient chercher sans vouloir relire un chapitre.

5 min de lecture11 sectionsChapitre 22 / 22

Variables d'environnement

Toutes documentées dans .env.example, le seul fichier d'environnement versionné. En local : .dev.vars. En production : la configuration de l'hébergeur, en secrets d'exécution. Jamais le dépôt.

Variable	Obligatoire	Rôle
`EDITOR_KEY_HASH`	oui	Empreinte argon2id de la clé du site. Sans elle, aucune édition possible — c'est l'état par défaut.
`SESSION_SECRET`	oui	Signature des cookies de session. 32 caractères minimum. La remplacer ferme toutes les sessions.
`EDITOR_NAME`	recommandé	Nom d'auteur des publications. Défaut : « Éditeur du site ».
`EDITOR_EMAIL`	recommandé	Adresse d'auteur des publications.
`GIT_PROVIDER`	oui	`github` ou `gitlab` (non implémenté). Défaut : `github`.
`GIT_REPO`	oui	`propriétaire/dépôt` chez GitHub ; `groupe/projet` ou identifiant numérique chez GitLab.
`GIT_BRANCH`	oui	Branche des publications. Défaut : `main`.
`GIT_TOKEN`	oui	Jeton d'écriture du compte machine. Portée restreinte au seul dépôt.
`GIT_API_BASE`	non	Autre racine d'API : instance auto-hébergée, ou faux service local (`http://127.0.0.1:8787`).
`RATE_LIMIT`	en production	Liaison clé-valeur, pas une variable texte. Sans elle, le comptage retombe en mémoire.

Commandes

Commande	Où	Rôle
`npm create inline@latest <dossier>`	partout	Crée un site. Options : `--nom`, `--courriel`, `--langue`.
`npm run dev`	site, dépôt	Serveur Astro seul — mise en page, sans l'édition.
`npm run build`	site, dépôt	Build de production. Échoue si le contenu est invalide.
`npm run serve:functions`	site, dépôt	Site + fonctions sur `http://127.0.0.1:8788`. C'est ici qu'on édite.
`npm run mock:git`	site, dépôt	Faux dépôt Git local sur `:8787`. Port : `MOCK_PORT`.
`npm run check`	site, dépôt	HTML brut, parité des langues, journaux, secrets.
`npm test`	dépôt	Toute la suite, build compris.
`npm run create:site`	dépôt	Accès d'un site. Options : `--nom`, `--depot`, `--branche`, `--auteur`, `--courriel`, `--ecrire`.
`npm run make:key`	site, dépôt	Une clé et son empreinte — la rotation. Livrée avec le site depuis `create-inline` 1.1.0.
`npm run bootstrap`	dépôt	Amorçage. Options : `--html`, `--page`, `--langue`, `--essai`, `--sortie`.
`npm run test:scaffold`	dépôt	Site créé de zéro, installé, construit, contrôlé.
`npm run test:pack`	dépôt	Idem, depuis les archives d'une publication.
`npm run pack:core` / `pack:cli`	dépôt	Fabrique les archives.
`npm run release:core` / `release:cli`	dépôt	Publie sur le registre.

Options de l'intégration

js js

inline({
  locales: ['fr', 'en'],                    // obligatoire — la référence en premier
  support: { email: 'contact@agence.fr' },  // affichée au client sur /admin et /aide
  theme: 'src/styles/theme.css',            // défaut
  pages: { admin: true, help: true },       // false pour fournir la vôtre
})

inline({
  locales: ['fr', 'en'],                    // obligatoire — la référence en premier
  support: { email: 'contact@agence.fr' },  // affichée au client sur /admin et /aide
  theme: 'src/styles/theme.css',            // défaut
  pages: { admin: true, help: true },       // false pour fournir la vôtre
})

Tokens de style

Clé	Valeurs	Classe produite	Variable attendue
`size`	`xs sm base lg xl 2xl 3xl`	`.cms-size-*`	`--size-*`
`weight`	`thin light regular medium semibold bold`	`.cms-weight-*`	`--weight-*`
`italic`	`true false`	`.cms-italic`	—
`align`	`left center right`	`.cms-align-*`	—
`color`	`primary secondary muted accent inverse`	`.cms-color-*`	`--color-*`

Types de champs

text text

text      { type, value, style }                                titres, labels, paragraphes simples
richtext  { type, value }                                       emphase, liens, listes — 7 balises
image     { type, kind:'image', src, alt, width, height }        fichier de src/media
video     { type, kind:'video', provider, videoId, title }       YouTube ou Vimeo, jamais de fichier

text      { type, value, style }                                titres, labels, paragraphes simples
richtext  { type, value }                                       emphase, liens, listes — 7 balises
image     { type, kind:'image', src, alt, width, height }        fichier de src/media
video     { type, kind:'video', provider, videoId, title }       YouTube ou Vimeo, jamais de fichier

Attributs posés dans le HTML

Attribut	Valeur
`data-cms`	Chemin du champ, ex. `blocks.hero.title`
`data-cms-type`	`text` · `richtext` · `media`
`data-cms-kind`	`image` · `video`
`data-cms-untranslated`	`true` si le champ vient de la langue de référence
`data-cms-list`	`collections.{nom}`
`data-cms-item`	Identifiant de l'item
`data-cms-template`	Nom de la liste dont c'est le modèle
`data-cms-blank`	JSON d'un item vierge
`data-cms-file`	Fichier de contenu de la page (sur `body`)
`data-cms-locale` · `data-cms-page`	Langue et page en cours (sur `body`)
`data-cms-locales`	Langues du site : code, adresse, libellé (sur `body`)

Règles de nommage

Objet	Forme	Exemple
Fichier de page	minuscules, chiffres, traits d'union	`nos-services.json`
Chemin d'écriture	`src/content/pages/{langue}/{page}.json`	`src/content/pages/fr/home.json`
Fichier média	`[a-z0-9]+(-[a-z0-9]+)*.(jpg\|png\|webp)`	`fournil-au-petit-matin.webp`
Identifiant d'item	une lettre, un tiret, 3 chiffres minimum	`t-001`
Code de langue	deux lettres minuscules	`fr`
Message de publication	une ligne, 120 caractères	`content(fr): home — hero.title`

Codes d'erreur

Code interne	HTTP	Signification
`bad_request`	400	Corps ou chemin invalide.
`unauthorized`	401 / 502	Session absente (401) ou dépôt refusant l'accès (502).
`method_not_allowed`	405	Méthode non prévue sur cette route.
`not_found`	404 / 502	Fichier ou dépôt introuvable.
`conflict`	409	Version périmée : quelqu'un a publié entre-temps.
`too_large`	413	Plafond de taille dépassé.
`unsupported_format`	415	Format d'image non reconnu ou dimensions hors bornes.
`invalid_content`	422	Schéma, média, identifiants ou balisage refusés.
—	429	Débit dépassé. En-tête `retry-after`.
`unavailable`	502	Le dépôt n'a pas répondu.

Ports

`4321`	`npm run dev`	Astro seul
`8788`	`npm run serve:functions`	Site + fonctions
`8787`	`npm run mock:git`	Faux dépôt Git

Glossaire

Terme	Ce que c'est	Ce que le client lit
Overlay	L'interface d'édition superposée à la page.	—
Clé de site	Le secret partagé, haché en argon2id.	« votre clé »
Témoin d'édition	Cookie sans secret qui déclenche le chargement de l'overlay.	—
Verrou optimiste	Comparaison de version avant écriture.	« quelqu'un a publié entre-temps »
Version	Empreinte opaque de l'état d'un fichier (SHA du blob chez GitHub).	—
Publication	Un commit, puis une reconstruction du site.	« Publier »
Brouillon	Modifications enregistrées dans le navigateur.	« modifications non publiées »
Token de style	Une valeur d'enum du schéma.	un bouton de la barre
Amorçage	Extraction du contenu d'une page HTML annotée.	—

Où lire le code

Question	Fichier
Quelle est la forme du contenu ?	`inline-core/src/schema.ts`
Quelles variantes de style existent ?	`inline-core/src/style-tokens.ts`
Qui a le droit d'écrire ?	`inline-core/src/server/auth.ts`
Quels plafonds, quels chemins, quels budgets ?	`inline-core/src/server/guard.ts`
Comment on parle au dépôt ?	`inline-core/src/server/git-provider.ts`, `github.ts`
Que fait la publication, dans l'ordre ?	`inline-core/src/server/routes/save.ts`
Comment l'overlay relie DOM et JSON ?	`inline-core/src/editor/index.ts`
Qu'est-ce qui est posé dans la page ?	`inline-core/astro/index.ts`
Comment une adresse de vidéo est lue ?	`inline-core/src/video.ts`
Comment le repli de traduction marche ?	`inline-core/src/translate.ts`

Variables d'environnement#

Commandes#

Options de l'intégration#

Tokens de style#

Types de champs#

Attributs posés dans le HTML#

Règles de nommage#

Codes d'erreur#

Ports#

Glossaire#

Où lire le code#