La réponse courte : utiliser un commentaire HTML
Placez la note entre `<!--` et `-->`. Un moteur acceptant le HTML brut ne l’affiche pas dans le rendu.
Cette technique ne rend pas la note privée : toute personne ayant accès au fichier ou au dépôt peut la lire.
# Rapport
<!-- Vérifier ce chiffre avant publication. -->
Le projet avance.Rapport
Le projet avance.Une note masquée reste dans le fichier
Utilisez les commentaires pour des rappels éditoriaux sans risque, comme vérifier une date ou remplacer une capture. N’y placez jamais mot de passe, jeton, adresse privée ou donnée client.
- Acceptable : vérifier ce lien avant le lancement
- Acceptable : remplacer l’image par la version finale
- Interdit : secrets, données personnelles ou informations confidentielles
GitHub et Obsidian n’utilisent pas exactement les mêmes règles
GitHub masque les commentaires HTML dans le rendu du README tout en les laissant dans la source. Obsidian accepte aussi `%% commentaire %%`, mais cette syntaxe lui est propre et peut apparaître ailleurs.
| Besoin | Syntaxe | Limite |
|---|---|---|
| Note HTML courante | <!-- note --> | Dépend du HTML brut |
| Note Obsidian | %% note %% | Non portable |
| Information privée | Ne pas l’inclure | Masquer n’est pas protéger |
CommonMark autorise du HTML brut, pas un commentaire Markdown
CommonMark ne définit pas une syntaxe de commentaire propre à Markdown. La forme `<!-- note -->` fonctionne parce qu’elle appartient au HTML brut reconnu par de nombreux moteurs Markdown.
Un moteur peut néanmoins filtrer le HTML, le supprimer à l’export ou le traiter différemment selon son mode de sécurité. Testez toujours la destination réelle.
Dans un bloc de code, les signes restent visibles
Entre trois accents graves, `<!-- -->` fait partie de l’exemple. Le libellé html placé après les trois accents graves d’ouverture ne change que la coloration syntaxique.
Éviter les commentaires imbriqués
N’insérez pas un second `<!-- ... -->` à l’intérieur d’un commentaire HTML. La première fermeture peut mettre fin au commentaire plus tôt que prévu et laisser apparaître le reste du texte.
Pour désactiver temporairement un long passage, préférez le déplacer dans une branche, un brouillon ou un historique de version plutôt que de construire un bloc fragile.
Commentaires et export HTML
Un aperçu peut masquer une note alors que le HTML exporté la conserve dans son code source. À l’inverse, un convertisseur sécurisé peut la supprimer complètement.
Si la distinction compte pour votre publication, inspectez à la fois l’aperçu visible et le fichier exporté. Ne déduisez jamais la confidentialité d’un simple écran vide.
Choisir une solution plus adaptée au travail d’équipe
Pour une décision, une demande de validation ou une discussion durable, utilisez les commentaires de la plateforme, une issue ou une revue de code. Un commentaire HTML n’a ni auteur fiable, ni notification, ni état de résolution.
Contrôler avant publication
- Identifier la destinationGitHub, Obsidian, CMS et export HTML peuvent traiter les commentaires différemment.
- N’écrire que du contenu publiableSupposez que toute personne ayant le fichier peut lire la note.
- Ouvrir source, aperçu et exportChaque étape peut conserver ou retirer le commentaire.
- Supprimer les notes résoluesÉvitez d’accumuler des instructions devenues inutiles.
Outils associés
Questions fréquentes
Quelle est la syntaxe d’un commentaire Markdown ?
Il n’existe pas de marqueur universel. Utilisez `<!-- commentaire -->` lorsque le HTML brut est accepté.
Un commentaire est-il privé ?
Non. Il reste lisible dans la source et l’historique.
Que signifie %% commentaire %% ?
C’est une extension Obsidian non portable.
Puis-je y placer un mot de passe ?
Non. Supprimez toute information qui doit réellement rester secrète.
GitHub affiche-t-il les commentaires HTML ?
Le rendu les masque, mais ils restent visibles dans la source du fichier et son historique.
Les commentaires survivent-ils à un export HTML ?
Cela dépend du moteur et de ses règles de nettoyage. Inspectez le code exporté au lieu de vous fier uniquement à l’aperçu.
Peut-on imbriquer des commentaires HTML ?
Évitez-le. La première séquence de fermeture peut interrompre le commentaire et exposer la suite.