⚠️ Traduction non officielle - Cette documentation est une traduction communautaire non officielle de Docker.

Conventions des fichiers sources

Table des matières

Nom de fichier

Lorsque vous créez un nouveau fichier .md pour un nouveau contenu, assurez-vous que :

  • Les noms de fichiers sont aussi courts que possible
  • Essayez de limiter le nom de fichier à un ou deux mots
  • Utilisez un tiret pour séparer les mots. Par exemple :
    • add-seats.md et remove-seats.md.
    • multiplatform-images préféré à multi-platform-images.

Front matter

Le front matter d'une page donnée se trouve dans une section en haut du fichier Markdown qui commence et se termine par trois tirets. Il inclut du contenu YAML. Les clés suivantes sont supportées. Le titre, la description et les mots-clés sont requis.

Clé Requis Description
title oui Le titre de la page. Il est ajouté à la sortie HTML comme un en-tête de niveau <h1>.
description oui Une phrase qui décrit le contenu de la page. Elle est ajoutée aux métadonnées HTML. Elle n'est pas rendue sur la page.
keywords oui Une liste de mots-clés séparés par des virgules. Ils sont ajoutés aux métadonnées HTML.
aliases non Une liste YAML de pages qui doivent rediriger vers la page actuelle. Au moment de la construction, chaque page listée ici est créée comme un stub HTML contenant une redirection 302 vers cette page.
notoc non Soit true soit false. Si true, aucune table des matières intra-page n'est générée pour la sortie HTML de cette page. Par défaut false. Approprié pour certaines pages d'accueil qui n'ont pas d'en-têtes intra-page.
toc_min non Ignoré si notoc est défini sur true. Le niveau d'en-tête minimum inclus dans la table des matières intra-page. Par défaut 2, pour afficher les en-têtes <h2> comme minimum.
toc_max non Ignoré si notoc est défini sur false. Le niveau d'en-tête maximum inclus dans la table des matières intra-page. Par défaut 3, pour afficher les en-têtes <h3>. Définir sur la même valeur que toc_min pour afficher seulement le niveau toc_min d'en-têtes.
sitemap non Exclure la page de l'indexation par les moteurs de recherche. Quand défini sur false, la page est exclue de sitemap.xml, et un en-tête <meta name="robots" content="noindex"/> est ajouté à la page.
sidebar.reverse non Ce paramètre pour les pages de section change l'ordre de tri des pages dans cette section. Les pages qui apparaîtraient normalement en haut, par poids ou par titre, apparaîtront plutôt près du bas, et vice versa.
sidebar.goto non Définir ceci pour changer l'URL vers laquelle la barre latérale doit pointer pour cette entrée. Voir entrées de barre latérale sans page.
sidebar.badge non Définir ceci pour ajouter un badge à l'entrée de la barre latérale pour cette page. Cette option de paramètre consiste en deux champs : badge.text et badge.color.

Voici un exemple de métadonnées de page valides (mais artificielles). L'ordre des éléments de métadonnées dans le front matter n'est pas important.

---
description: Instructions pour installer Docker Engine sur Ubuntu
keywords: exigences, apt, installation, ubuntu, installer, désinstaller, mise à niveau, mise à jour
title: Installer Docker Engine sur Ubuntu
aliases:
- /ee/docker-ee/ubuntu/
- /engine/installation/linux/docker-ce/ubuntu/
- /engine/installation/linux/docker-ee/ubuntu/
- /engine/installation/linux/ubuntu/
- /engine/installation/linux/ubuntulinux/
- /engine/installation/ubuntulinux/
- /install/linux/docker-ce/ubuntu/
- /install/linux/docker-ee/ubuntu/
- /install/linux/ubuntu/
- /installation/ubuntulinux/
toc_max: 4
---

Corps

Le corps de la page (à l'exception des mots-clés) commence après le front matter.

Longueur du texte

Diviser les longues lignes (de préférence jusqu'à 80 caractères) peut faciliter la fourniture de commentaires sur de petits blocs de texte.

Entrées de barre latérale sans page

Si vous voulez ajouter une entrée à la barre latérale, mais que vous voulez que le lien pointe ailleurs, vous pouvez utiliser le paramètre sidebar.goto. Ceci est utile en combinaison avec build.render défini sur always, qui crée une entrée sans page dans la barre latérale qui lie vers une autre page.

---
title: Lien de barre latérale factice
build:
  render: never
sidebar:
  goto: /some/other/page/
weight: 30
---