Skills Guide

Guide Markdown GitHub (GFM)

VérifiéSûr

Rédiger, modifier ou réviser du Markdown GitHub (GFM) pour README, issues, PRs et docs, avec références de syntaxe et checklist de revue.

Télécharger et utiliser
Spar Skills Guide Bot
DocumentationDébutant
21/09/2026
Claude Code
#markdown#gfm#readme#docs#writing

Recommandé pour

Claude CodeDocumentation automatiqueSEO & contenuRédacteur / marketeur

Synthèse automatique

Ce skill guide la rédaction et la relecture de Markdown GitHub-flavored (README, issues, pull requests, docs) en appliquant les conventions de structure, de liens, d'alertes et de blocs de code de GitHub.

Points forts

  • Couvre les éléments GFM spécifiques à GitHub : alertes `> [!NOTE]`, listes de tâches, notes de bas de page et pastilles de couleur
  • Fournit une checklist de revue concrète (hiérarchie des titres, langue des blocs de code, chemins relatifs, textes alternatifs)
  • Distingue trois modes de travail explicites : fichier, audit « review » et rédaction à partir d'un sujet
  • Rappelle les détails souvent oubliés comme les ancres de section et l'absence d'espaces en fin de ligne

Limites

  • Ne valide ni ne rend le Markdown : aucune vérification automatique du rendu ou des liens
  • Les règles restent des conventions de style, sans configuration de linter ni intégration CI
  • Suppose un contexte GitHub ; les spécificités d'autres plateformes Markdown ne sont pas traitées
Quand l'utiliser

À utiliser lorsqu'on rédige ou relit un README, une documentation ou un commentaire de PR destiné à GitHub et qu'on veut respecter les conventions GFM.

Quand l'éviter

À éviter pour du Markdown destiné à un autre moteur de rendu (MDX, AsciiDoc, docs statiques avec extensions propres) où les règles GitHub ne s'appliquent pas.

Analyse de sécurité

Sûr
Score qualité88/100

The skill only provides guidance for writing and reviewing GitHub-flavored Markdown. It declares no tools and contains no instructions to execute commands, access networks, or handle sensitive data.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

Audit a docs folder
/gfm review docs/
Write a README
/gfm README.md — write a README for this repo with install steps, usage examples, and a task list of known limitations
Draft API docs
/gfm API documentation — draft GFM docs for our REST endpoints with code blocks and a WARNING alert about rate limits

name: gfm description: Use when writing or reviewing GitHub-flavored Markdown (README, issues, PRs, docs) argument-hint: "[file | topic | review]"

GitHub-Flavored Markdown

Arguments

$ARGUMENTS

Instructions

Parse arguments to determine task:

  • File path → Write/edit markdown file
  • "review" → Audit existing markdown for GFM best practices
  • Topic/description → Draft markdown content

Writing Guidelines

Structure:

  • Use heading hierarchy (# through ######)—GitHub auto-generates TOC for 2+ headings
  • Prefer ATX headings (#) over Setext (===)
  • One blank line before headings

Text styling: | Style | Syntax | |-------|--------| | Bold | **text** | | Italic | _text_ | | Bold+italic | ***text*** | | Strikethrough | ~~text~~ | | Code | `code` | | Subscript | <sub>x</sub> | | Superscript | <sup>2</sup> |

Code blocks:

```language
code here
```

Lists:

  • Unordered: use - consistently
  • Ordered: 1., 2., etc.
  • Task lists: - [ ] incomplete, - [x] complete
  • Nest by aligning under parent text

Links:

  • Inline: [text](url)
  • Section anchors: [text](#heading-name) (lowercase, hyphens, no punctuation)
  • Relative paths for repo files: docs/CONTRIBUTING.md

Images: ![alt text](url) — always include alt text

Alerts (callouts):

> [!NOTE]
> Useful information

> [!TIP]
> Helpful advice

> [!IMPORTANT]
> Essential info

> [!WARNING]
> Urgent attention

> [!CAUTION]
> Risk warning

Footnotes:

Text with footnote[^1].

[^1]: Footnote content.

Color swatches: `#FF5733`, `rgb(255,87,51)`, `hsl(11,100%,60%)`

Review Checklist

When reviewing markdown:

  • [ ] Heading hierarchy is logical (no skipped levels)
  • [ ] Code blocks specify language for syntax highlighting
  • [ ] Links use relative paths for repo files
  • [ ] Images have meaningful alt text
  • [ ] Task lists use proper syntax
  • [ ] Alerts use correct > [!TYPE] format
  • [ ] No trailing whitespace except intentional line breaks
  • [ ] Tables are properly aligned

Examples

/gfm README.md                → Edit/create README
/gfm review docs/             → Audit markdown files in docs/
/gfm API documentation        → Draft API docs content
/gfm changelog entry          → Write changelog in GFM style

Du fichier au premier essai

Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.

Consulter la source et ses fichiers annexes

Ce téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.

1. Télécharger le fichier

Télécharger SKILL.md

Depuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/github-flavored-markdown-guide-muar2zfa/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.

Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.

mkdir -p '.skill-downloads/github-flavored-markdown-guide-muar2zfa' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/github-flavored-markdown-guide-muar2zfa/download' --output '.skill-downloads/github-flavored-markdown-guide-muar2zfa/SKILL.md.part' && mv '.skill-downloads/github-flavored-markdown-guide-muar2zfa/SKILL.md.part' '.skill-downloads/github-flavored-markdown-guide-muar2zfa/SKILL.md'

2. Vérifier les prérequis

Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.

Aucune section de prérequis reconnue dans ce fichier. Cela ne signifie pas qu’il est autonome : les bibliothèques, outils et accès peuvent être cités ailleurs dans le contenu ou dans le dépôt source.

Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.

3. Charger la skill

Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.

Claude Code
test -f '.skill-downloads/github-flavored-markdown-guide-muar2zfa/SKILL.md' && test -s '.skill-downloads/github-flavored-markdown-guide-muar2zfa/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/gfm' && cp -R '.skill-downloads/github-flavored-markdown-guide-muar2zfa' '.claude/skills/gfm'

OpenSkills

OpenSkills doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.

Installation officielle d’OpenSkills
openskills install './.skill-downloads/github-flavored-markdown-guide-muar2zfa'

openskills read 'github-flavored-markdown-guide-muar2zfa'

La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.

Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.

openskills sync

Mode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.

4. Faire un premier essai

Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :

Lis .skill-downloads/github-flavored-markdown-guide-muar2zfa/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.

Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.

Skills similaires

Rédaction de docs Supabase

Documentation

Rédigez, éditez et révisez le contenu de la documentation Supabase : guides, tutoriels, références et partiels. Suivez les guides de style et les règles de validation MDX/TOML.

Claude CodeintermediateSûr 108,544
Skills Guide Bot

Créer un enregistrement de décision d'architecture

Documentation

Créer un nouveau ADR avec numérotation séquentielle, l'enregistrer dans le graphe AgentDB et le lier aux ADR associés.

Claude CodeintermediateSûr 69,659
Skills Guide Bot

Mise à jour de plan avec recherche approfondie

Documentation

Met à jour un document de plan en lançant des sous-agents en parallèle pour analyser un sujet sur tous les passes du compilateur, puis consolide les résultats.

Claude CodeadvancedSûr 248,015
Skills Guide Bot