9 documents tagués avec "Guides"

Le Markdown n'est pas un langage de programmation, mais un langage de balisage léger qui permet de structurer des documents de texte, pour un usage web, sans écrire le moindre élément HTML. Il favorise la lisibilité et la sémantique, chaque balise Markdown sert à organiser l'information plutôt que de définir son style.

Le Markdown prend en charge les métadonnées comme le ferait une page HTML, dans un encadré nommé « Front Matter » qui peut se traduire par Page de garde. Ces métadonnées sont rangées en haut de la page Markdown, dans un format nommé YAML (équivalent à du JSON avec une syntaxe simplifiée).

Nous avons vu, dans un précédent guide, qu'il était possible de créer des liens en Markdown. Nous allons maintenant voir plus en détail comment fonctionnent les liens internes, leurs ancres et le types de liens qui existent.

Le MDN est une documentation des technologies utilisées sur le web, par les développeur·euse·s de site et applications. Pour présenter les différents aspects d'une technologie, nous utilisons des blocs de code qui prennent diverses formes selon le besoin.

Pour permettre aux lecteur·ice·s d'expérimenter ce que la documentation présente, nous créons des exemples qui sont rendus interactifs grâce aux macros, mais surtout aux blocs de codes.

Pour rendre des éléments dans la documentation, tels que des liens vers des ressources, des bannières prédéfinies, des exemples, des badges et des barres de navigation ; nous utilisons un élément de code personnalisé nomme « macro ». Elles sont formées par l'ouverture et la fermeture d'accolades doubles {{ avec le nom de la macro et ses paramètres avant la fermeture }}.

Maintenant que votre environnement de travail est installé, vous pouvez commencer à effectuer des actions pour contribuer au MDN. Avant tout, pensez à lire les Règles d'écritures et les Règles de conduite avant de contribuer.

Ce guide vous présent la méthode de contribution au MDN par le biais de modification des pages Markdown en utilisant l'interface de Github. Les dépôts sont bifurqués pour permettre à chacun de faire des modifications sans impacter le dépôt principal avec des actions potentiellement dangereuses.

Pour pouvoir contribuer au MDN pleinement, en utilisant un environnement de développement local adapté à votre besoin, nous allons vous présenter les différents éléménts et étapes nécessaires pour préparer votre future contribution.