Wikis

Chaque dépôt peut héberger un wiki : une collection distincte de pages Markdown pour une documentation qui vit à côté du code sans s’y mélanger.

Activer le wiki

Ouvrez le dépôt et sélectionnez Paramètres.
Sous Fonctionnalités, activez Wiki.
Un onglet Wiki apparaît dans la navigation du dépôt.

Créer et modifier des pages

Sélectionnez l’onglet Wiki.
Si le wiki ne contient pas encore de page, sélectionnez Create the First Page. Sinon, sélectionnez New Page.
Saisissez un titre de page. Le titre devient l’URL de la page ; choisissez donc quelque chose de clair et de stable.
Rédigez le contenu en Markdown, puis sélectionnez Save Page.

La première page que vous créez devient l’Accueil du wiki, c’est-à-dire la page sur laquelle les visiteurs arrivent par défaut. Pour mettre à jour une page existante, ouvrez-la et sélectionnez Modifier. Chaque enregistrement ajoute une nouvelle entrée à l’historique des révisions de la page.

Organiser le wiki

Deux pages nommées de façon spécifique contrôlent la navigation dans l’ensemble du wiki :

_Sidebar : une barre latérale personnalisée affichée sur chaque page. Ajoutez-y des liens vers vos pages les plus importantes.
_Footer : un pied de page affiché en bas de chaque page.

Créez l’une ou l’autre depuis New Page en utilisant exactement le nom indiqué ci-dessus. Créez des liens entre les pages du wiki avec le Markdown standard, en référençant le slug de la page :

See the [Setup Guide](setup-guide) for installation steps.

Utilisez dès le départ des titres de page descriptifs : le titre devient l’URL, et renommer une page plus tard casse tous les liens existants vers celle-ci.

Modifier le wiki en local

Le wiki est lui-même un dépôt Git, disponible à l’URL .wiki.git de votre dépôt. Clonez-le, modifiez les fichiers Markdown dans votre éditeur, puis poussez les modifications.

git clone https://git.example.plaidcloud.com/you/my-repo.wiki.git
cd my-repo.wiki
# edit or add .md files
git add .
git commit -m "Expand the setup guide"
git push

Le même jeton d’accès personnel que celui utilisé pour le dépôt principal fonctionne ici. Chaque fichier Markdown devient une page du wiki ; le nom du fichier (sans l’extension .md) est le slug de la page.