Ajouter un lien Modifier sur GitHub
Le lien Modifier sur GitHub apparaît en bas de chaque page de votre site Docsbook et ouvre le fichier source de cette page dans l'éditeur GitHub. Un lecteur qui repère une faute de frappe peut la corriger et ouvrir une demande de tirage sans rien savoir sur Docsbook.
Vous cherchez autre chose ? Cette page couvre le lien de modification visible par le lecteur. Pour connecter un compte GitHub, ou pour déplacer un projet hébergé par Docsbook dans un dépôt que vous possédez, ouvrez le sélecteur de projet dans l'en-tête du chat AI et utilisez Dépôt connecté — voir Démarrage rapide.
Ce que font les deux paramètres#
| Paramètre | Ce qu'il fait |
|---|---|
| Afficher "Modifier sur GitHub" | Ajoute le lien de modification en bas de chaque page |
| URL de base de modification GitHub | Le chemin de base à partir duquel le lien est construit |
Activer le lien d'édition#
- Ouvrez votre site de documentation tout en étant connecté.
- Ouvrez Float Widget → Design → onglet Contenu.
- Activez Afficher "Modifier sur GitHub".
- Définissez l'URL de base pour l'édition GitHub — voir la section suivante.
- Cliquez sur Enregistrer.
Définir l'URL de base d'édition GitHub#
L'URL de base d'édition indique à Docsbook où envoyer un lecteur qui clique sur le lien. Docsbook y ajoute le chemin de la page actuelle.
https://github.com/YOUR_USERNAME/YOUR_REPO/edit/YOUR_BRANCH/YOUR_DOCS_FOLDERSélectionnez la ligne qui correspond à l'emplacement de votre markdown :
| Dépôt | Emplacement des docs | URL de base d'édition |
|---|---|---|
myname/my-repo |
Racine du dépôt | https://github.com/myname/my-repo/edit/main |
myname/my-repo |
Dossier /docs |
https://github.com/myname/my-repo/edit/main/docs |
myname/my-repo |
Branche master |
https://github.com/myname/my-repo/edit/master |
Laissez le champ vide et Docsbook construira le lien à partir du dépôt que vous avez connecté.
Quand l'activer#
Pour un projet open-source, le lien d'édition est le chemin de contribution le moins coûteux que vous puissiez offrir : un lecteur corrige un mauvais drapeau ou un numéro de version obsolète dans le navigateur, et vous recevez une demande de tirage au lieu d'un problème.
Pour la documentation de l'équipe interne, cela permet à quiconque dans l'équipe de proposer un changement de formulation sans apprendre l'interface Docsbook — ils modifient le fichier sur GitHub et le site suit.
Le lien d'édition n'appelle aucun modèle d'IA, donc il ne puise pas dans le solde de votre projet.
Étapes suivantes#
- Options de contenu — les autres bascules sur le même onglet Design.
- Gérez votre site de documentation — comment une modification sur GitHub atteint votre site en direct.
Chaque nouveau projet commence avec un solde de 1 $, et le lien de modification ne le dépense pas.