Project Name

Configuration

Mon, 01 Jan 0001 00:00:00 +0000

Remplacez ce petit tableau par la véritable surface de configuration publique de votre projet.

Clé	Type	Défaut	Signification
`listen`	chaîne	`127.0.0.1:8080`	Adresse du serveur local
`log_level`	chaîne	`info`	Niveau minimal des journaux
`read_only`	booléen	`false`	Désactive les opérations qui modifient l’état

Exemple

listen: 0.0.0.0:8080
log_level: debug
read_only: true

Documentez la validation et la priorité à côté des clés, pas dans un guide séparé et difficile à trouver.

Prérequis

Mon, 01 Jan 0001 00:00:00 +0000

Gardez les prérequis courts, précis et vérifiables.

Outils

Un système d’exploitation pris en charge.
Git pour récupérer les sources.
La version d’exécution requise par votre projet.

Vérifier

Donnez une commande par prérequis :

$ project --version
project 0.1.0

Remplacez cette commande fictive par la vôtre avant publication.

Prévisualiser le site

Mon, 01 Jan 0001 00:00:00 +0000

OINK Starter est un site Hugo Module. Git télécharge les sources, Go résout la version épinglée du thème et Hugo construit l’ensemble.

Prérequis

Installez Git, Go 1.27 ou plus récent et Hugo Extended 0.165.0 ou plus récent. Le mot extended doit apparaître dans hugo version.

Trois commandes

git clone https://github.com/pgsty/oink-starter.git
cd oink-starter
hugo server

Ouvrez http://localhost:1313/. Le chinois se trouve sous /zh/ et le français sous /fr/.

Réaliser votre première modification

Mon, 01 Jan 0001 00:00:00 +0000

Ce tutoriel modèle une tâche complète : préparer, modifier, vérifier et relire.

Partir d’un état connu

git status --short
git switch -c docs/first-change

Modifier une seule chose

Changez une chaîne visible ou une petite valeur de configuration. La première tâche doit rester assez ciblée pour que son résultat soit évident.

Vérifier

Exécutez le contrôle pertinent le plus petit, puis ouvrez la surface modifiée et inspectez-la vous-même.

Vue d’ensemble du projet

Mon, 01 Jan 0001 00:00:00 +0000

Remplacez cette page par l’explication la plus courte et utile de votre projet.

Le problème

Décrivez le problème avec les mots du lecteur. Évitez les détails d’implémentation tant que la valeur du projet n’est pas claire.

Le résultat

Expliquez ce qu’un utilisateur peut accomplir après avoir adopté le projet.

Astuce

Une bonne vue d’ensemble aide le lecteur à décider en moins de deux minutes s’il souhaite continuer.

Ajouter une page de documentation

Mon, 01 Jan 0001 00:00:00 +0000

Dans OINK, l’arborescence du contenu devient la barre latérale. Un nouveau fichier Markdown crée une nouvelle page.

Créer le fichier

---
title: Nouvelle capacité
description: Ce que fait cette capacité.
weight: 30
---

Expliquez la capacité ici.

Enregistrez-le sous content/docs/reference/new-capability.md.

Ajouter les traductions

Créez new-capability.zh.md et new-capability.fr.md à côté. Gardez les identifiants explicites des titres alignés entre les langues.

Architecture

Mon, 01 Jan 0001 00:00:00 +0000

Documentez les quelques composants qu’un contributeur doit comprendre avant toute modification.

Carte du système

Partie	Responsabilité
Interface	Reçoit les entrées et présente les résultats
Cœur	Applique les règles du projet
Adaptateurs	Relient les systèmes externes

Limites

Indiquez ce que le projet ne prend volontairement pas en charge. Des limites claires évitent de promettre plus que le logiciel ne fournit.

Comprendre la structure

Mon, 01 Jan 0001 00:00:00 +0000

Le modèle place chaque responsabilité dans un endroit évident.

La carte

hugo.yaml identité, langues et intégrations facultatives
data/home/ une page d’accueil compacte par langue
content/blog/ articles, conception et versions
content/docs/ l’arborescence documentaire en quatre parties
content/book/ ce tutoriel séquentiel
.github/workflows/ déploiement GitHub Pages et Cloudflare Pages

Le front matter menus.main de chaque racine crée la navigation supérieure et ses menus. L’arborescence sous Docs et Livre crée leurs barres latérales.

Installation

Mon, 01 Jan 0001 00:00:00 +0000

Présentez d’abord le chemin d’installation pris en charge le plus court.

Installer

git clone https://github.com/OWNER/PROJECT.git
cd PROJECT
./project start

Confirmer le résultat

Indiquez précisément à quoi ressemble la réussite : une URL à ouvrir, un message à voir ou une commande qui renvoie zéro.

Important

Remplacez tous les éléments en majuscules avant de publier votre documentation.

Référence des commandes

Mon, 01 Jan 0001 00:00:00 +0000

`project start`

Démarre le service local.

project start [--config FILE] [--listen ADDRESS]

`project check`

Valide la configuration sans démarrer le service. Le code de sortie 0 signifie valide ; tout autre code interdit le déploiement.

project check [--config FILE]

Remplacez ces exemples par les commandes issues de l’aide réelle de votre CLI.

Personnaliser le modèle

Mon, 01 Jan 0001 00:00:00 +0000

La plupart des projets n’exigent que du contenu et deux modifications de configuration.

Modifier l’identité une seule fois

En haut de hugo.yaml, remplacez Project Name et https://example.org/. L’ancre YAML du titre propage le nom aux trois langues.

Ne remplacez assets/icons/logo.svg et static/favicon.svg que lorsque vous disposez d’une véritable identité visuelle.

Remplacer l’accueil

Modifiez data/home/en.yaml, zh.yaml et fr.yaml. La liste sections fixe l’ordre ; les blocs nommés fournissent le texte.

Publier le site

Mon, 01 Jan 0001 00:00:00 +0000

Le dossier public/ généré est un site statique. Le dépôt fournit deux chemins de déploiement indépendants.

GitHub Pages

Dans les paramètres du dépôt, choisissez Pages → Source → GitHub Actions. Un envoi sur main exécute .github/workflows/github-pages.yaml et calcule automatiquement le bon sous-chemin du dépôt.

Cloudflare Pages

Créez un projet Pages en Direct Upload, puis ajoutez CLOUDFLARE_ACCOUNT_ID et CLOUDFLARE_API_TOKEN comme secrets. Définissez la variable CLOUDFLARE_PAGES_ENABLED à true pour les déploiements automatiques. Le nom du projet reprend celui du dépôt, sauf surcharge par CLOUDFLARE_PROJECT_NAME.

Bienvenue sur le blog du projet

Thu, 15 Jan 2026 00:00:00 +0000

La rubrique Articles accueille les actualités, explications et récits qui ne relèvent pas de la documentation de référence.

Que publier ici

Écrivez pour les personnes qui cherchent le contexte : pourquoi le projet existe, ce que l’équipe a appris et la suite prévue.

Remplacer cette page

Conservez le front matter, modifiez le titre et la date, puis rédigez votre premier article.

Un petit modèle de contenu capable de grandir

Sat, 10 Jan 2026 00:00:00 +0000

Ce modèle donne à chaque type de texte une place évidente. La séparation rend la navigation prévisible sans imposer trop tôt une taxonomie complexe.

Trois modes de lecture

Le blog explique les changements dans le temps.
La documentation répond à des questions précises.
Le livre enseigne un parcours ordonné.

Ajouter de la structure au bon moment

Commencez avec les sections fournies. Ajoutez une branche seulement lorsque les lecteurs ont besoin d’un parcours distinct.

Project 0.1.0

Thu, 01 Jan 2026 00:00:00 +0000

La version 0.1.0 établit la première base publique et utilisable du projet.

Points forts

Un parcours d’installation documenté.
Une surface publique petite et stable.
Un endroit clair pour signaler les problèmes.

Mise à niveau

Il s’agit de la première version : aucune migration n’est nécessaire.

Project Name

Configuration

Exemple

Prérequis

Outils

Vérifier

Prévisualiser le site

Prérequis

Trois commandes

Réaliser votre première modification

Partir d’un état connu

Modifier une seule chose

Vérifier

Vue d’ensemble du projet

Le problème

Le résultat

Ajouter une page de documentation

Créer le fichier

Ajouter les traductions

Architecture

Carte du système

Limites

Comprendre la structure

La carte

La navigation suit le contenu

Installation

Installer

Confirmer le résultat

Référence des commandes

project start

project check

Personnaliser le modèle

Modifier l’identité une seule fois

Remplacer l’accueil

Publier le site

GitHub Pages

Cloudflare Pages

Bienvenue sur le blog du projet

Que publier ici

Remplacer cette page

Un petit modèle de contenu capable de grandir

Trois modes de lecture

Ajouter de la structure au bon moment

Project 0.1.0

Points forts

Mise à niveau

`project start`

`project check`