À propos de Visionneuse Markdown
Le visualiseur Markdown de Zyff ouvre un fichier .md (ou tout autre contenu que vous collez) et l'affiche comme le ferait GitHub : titres, tableaux, listes de tâches, notes de bas de page, coloration syntaxique et HTML intégré, avec une table des matières construite à partir des titres du document. Le rendu s'effectue sur les serveurs de Zyff et non côté client, un choix autant pour des raisons de sécurité que d'architecture. Markdown transmet volontairement le HTML brut ; par conséquent, un document provenant d'un dépôt, d'un client ou d'un utilisateur inconnu est, par définition, considéré comme non fiable. Chaque balise affichée ici provient soit du moteur de rendu lui-même, soit a passé avec succès une liste blanche côté serveur qui supprime les scripts, les gestionnaires d'événements, les iframes et les styles en ligne. Votre fichier est traité en mémoire et n'est jamais stocké. Aucune inscription n'est requise, aucun filigrane n'est apposé et le nombre de documents que vous pouvez ouvrir est illimité.
Comment ouvrir et visualiser un fichier Markdown
Ouvrez ou collez le document
Cliquez sur « Ouvrir un fichier » et sélectionnez un fichier .md, .markdown ou .txt, puis faites-le glisser dans l’un des volets ou sélectionnez l’onglet Markdown et collez-le. Le fichier est téléchargé et décodé sur le serveur ; ainsi, s’il n’est pas encodé en UTF-8, un message d’erreur s’affiche au lieu de points d’interrogation.
Lisez-le en aperçu ou modifiez-le en mode fractionné.
L'aperçu affiche le document rendu seul. La fonction « Fractionner » place le code source à côté et le réaffiche au fur et à mesure de la saisie, ce qui est pratique pour corriger un tableau qui ne s'affiche pas. Markdown affiche uniquement le code source.
Vérifiez le goût si quelque chose vous semble anormal.
Ouvrez les options et vérifiez que GitHub Flavored Markdown est activé : les tableaux, les listes de tâches, le texte barré et les notes de bas de page sont des extensions GFM, et non une partie intégrante de Markdown ; un moteur de rendu qui ne les utilise pas affichera votre tableau sous forme de caractères pipe.
Navigation par table
Tout document comportant plusieurs titres génère une table des matières construite à partir de ces titres, chacun renvoyant vers son propre lien. Ces liens respectent le format des slugs de GitHub ; par conséquent, une table des matières déjà présente dans votre fichier README est également compatible.
Exportez ce dont vous avez besoin
Copiez le code HTML généré, téléchargez un fichier .html autonome qui s'ouvre partout avec ses styles déjà intégrés, enregistrez à nouveau le Markdown ou utilisez l'outil d'impression pour générer un PDF. L'impression concerne uniquement le document, et non la page qui l'entoure.
Ce que fait Visionneuse Markdown
Markdown compatible GitHub, y compris les notes de bas de page
Tableaux avec alignement des colonnes, listes de tâches, texte barré, liens automatiques vers les URL brutes, notes de bas de page et les avertissements [!NOTE] et [!WARNING] de GitHub : autant d’extensions indispensables à un fichier README digne de ce nom, et que les outils de rendu CommonMark stricts ne prennent pas en charge.
Le code HTML intégré est rendu, et non supprimé, grâce à une liste blanche.
Les badges, les blocs <details>, les balises <img align="right"> et <picture> s'affichent comme sur GitHub. Les scripts, les gestionnaires d'événements, les iframes, les formulaires, les styles en ligne et les attributs inconnus sont supprimés côté serveur, quel que soit le contenu du document.
Coloration syntaxique pour les langues que vous collez réellement
JavaScript, TypeScript, Python, Go, Rust, Java, C et C++, C#, PHP, Ruby, SQL, JSON, YAML, TOML, HTML, CSS, shell, Dockerfile, GraphQL, les différences unifiées et Markdown lui-même, résolus à partir de la chaîne d'informations de la barrière et de ses alias communs.
Une table des matières avec des ancres compatibles avec GitHub
Construite à partir des mêmes titres que ceux générés par le moteur de rendu, une entrée ne peut jamais pointer vers une ancre absente de la page. Les titres répétés reçoivent le suffixe -1, -2 utilisé par GitHub, ce qui permet à une table des matières manuscrite de rester fonctionnelle.
Pages liminaires reconnues, non imprimées
Un bloc YAML ou TOML en haut du fichier est extrait et affiché sous forme de champs plutôt que d'être rendu comme un élément isolé --- et une suite de lignes clé: valeur — ce qui est la façon dont une page Hugo ou Jekyll apparaît dans un visualiseur qui ne la reconnaît pas.
Statistiques du document issues de la même analyse
Le nombre de mots, le temps de lecture, les titres, les liens, les images, les blocs de code, les tableaux et les tâches effectuées sont comptabilisés lors du rendu. Les blocs de code et les éléments préliminaires sont exclus du décompte des mots ; le temps de lecture correspond donc à ce que vous auriez réellement lu.
Mode CommonMark, pour découvrir pourquoi
Désactivez le Markdown aromatisé GitHub pour que le document s'affiche en CommonMark strict. C'est le moyen le plus rapide de vérifier si le tableau qui ne s'affiche pas sur npm est un tableau GFM sur un moteur de rendu qui ne les prend pas en charge.
At a glance
| Fichiers acceptés | .md, .markdown, .mdown, .mkd, .mkdn, .mdx, .txt — jusqu'à 2 Mo |
|---|---|
| Limite du document | 500 000 caractères ou 60 000 lignes, limite imposée par le serveur |
| Saveurs | Markdown aromatisé GitHub (par défaut) ou CommonMark strict |
| HTML intégré | Affiché via une liste blanche côté serveur, ou affiché sous forme de texte littéral |
| Langues mises en évidence | Résolu à partir de la chaîne d'informations de la barrière de code et de ses alias courants |
| Limite de mise en évidence | Les blocs de plus de 40 000 caractères s'affichent en caractères monospaces. |
| Sommaire | Jusqu'à 500 titres, avec des ancres compatibles GitHub |
| Vitesse de lecture | 225 mots par minute par défaut ; 180 ou 300 mots par minute également disponibles |
| Exportations | Copiez le code HTML, le fichier .html autonome, le fichier .md original et imprimez-le au format PDF. |
| Stockage | Aucun — le document est conservé en mémoire uniquement pour la demande. |
Frequently asked questions
Comment ouvrir un fichier .md ?
Ouvrez-le dans n'importe quel lecteur Markdown, y compris celui-ci : cliquez sur « Ouvrir le fichier » ou faites glisser l'extension .md sur la page. Un fichier .md étant un fichier texte brut, vous pourrez également l'ouvrir avec un éditeur de texte, mais vous verrez la syntaxe et non la mise en forme. Aucune installation n'est requise et le fichier n'est jamais enregistré.
Pourquoi mon tableau Markdown ne s'affiche-t-il pas ?
Le problème survient presque toujours parce que le moteur de rendu ne prend pas en charge le Markdown GitHub, ou parce que la ligne de délimitation est manquante ou mal formée. Les tableaux étant une extension GFM et non une composante native du Markdown, npm, certains générateurs de documentation et les moteurs de rendu CommonMark stricts affichent les barres verticales comme du texte brut. C'est la ligne de tirets sous l'en-tête qui définit un tableau ; sans elle, les barres verticales apparaissent comme de simples barres verticales.
Pourquoi mes sauts de ligne ont-ils disparu ?
En Markdown standard, un simple saut de ligne à l'intérieur d'un paragraphe est interprété comme un espace, et non comme un retour à la ligne. Terminer la ligne par deux espaces, ou par une barre oblique inverse, force un retour à la ligne ; vous pouvez aussi activer l'option « Les retours à la ligne deviennent <br> » ici, ce qui correspond au comportement des zones de commentaires et des applications de messagerie instantanée. C'est la surprise la plus fréquente pour quiconque découvre le Markdown dans un outil de suivi des problèmes.
Ce visualiseur exécute-t-il le code HTML contenu dans mon Markdown ?
Le rendu est effectué via une liste blanche, et aucun élément ne peut s'exécuter. Les scripts, gestionnaires d'événements, iframes, objets, formulaires, styles en ligne et attributs inconnus sont supprimés côté serveur avant même que le code HTML n'atteigne votre navigateur, et les liens vers les URL javascript: ou data: sont ignorés. Vous pouvez également désactiver complètement le rendu HTML, ce qui affiche le balisage sous forme de texte brut.
Mon fichier est-il téléchargé quelque part ?
Le document est envoyé aux serveurs de Zyff pour être rendu et n'est jamais enregistré sur le disque, ni consigné dans les journaux, ni mis en cache. Il reste en mémoire pendant la durée d'une requête. Le rendu côté serveur permet à une seule liste blanche auditée de garantir la sécurité du résultat, plutôt qu'à une copie de cette logique d'être présente dans chaque navigateur.
Puis-je convertir du Markdown en HTML avec ceci ?
Oui. L'option « Copier le HTML » vous donne le fragment rendu, tandis que l'option « Télécharger le HTML » vous donne un fichier complet et autonome avec ses styles déjà intégrés ; il s'ouvre donc correctement sur une machine qui n'a jamais utilisé Zyff . Les deux proviennent du même rendu que celui que vous consultez.
Prend-il en charge les diagrammes Mermaid ou les formules mathématiques LaTeX ?
Non. Un bloc « sirène » ou « math » s’affiche comme un bloc de code surligné montrant son code source, ce qu’il est. Ces deux éléments nécessitent un moteur de rendu côté client, et cet outil n’en exécute volontairement aucun : sa sécurité repose entièrement sur le fait que le navigateur reçoit du code HTML finalisé et nettoyé, et n’exécute rien.
Peut-il ouvrir un fichier .mdx ?
Oui, le Markdown s'affiche correctement, mais les composants JSX apparaissent sous forme de texte au lieu d'être exécutés ; le visualiseur le signale dans une note lorsqu'il rencontre une instruction d'importation. Un visualiseur ne devrait pas exécuter de composants provenant d'un fichier tiers.
Pourquoi mes liens d'en-tête fonctionnent-ils sur GitHub mais pas ailleurs ?
Comme les identifiants des ancres ne sont pas standardisés, deux moteurs de rendu peuvent générer des identifiants différents pour un même titre. Ce visualiseur utilise l'algorithme de GitHub (minuscules, ponctuation supprimée, espaces remplacés par des tirets, avec un suffixe -1 ou -2 sur les occurrences répétées), ce qui permet à une table des matières conçue pour GitHub de fonctionner correctement.
Existe-t-il une limite à la taille des fichiers ?
2 Mo pour un fichier téléchargé et 500 000 caractères ou 60 000 lignes pour le document lui-même. Il s'agit d'un document très volumineux ; la spécification CommonMark en Markdown est inférieure à 300 000 caractères. Au-delà, consultez les sections une par une.