MkDocs
MkDocs est un outil développé dans Python pour générer des sites de documentation statiques basés sur des fichiers Markdown.
Aperçu
MkDocs est un outil très populaire avec une énorme communauté. Il a plusieurs thèmes pour créer des sites Web; plusieurs plugins pour étendre les fonctionnalités de base du programme et une documentation facile à comprendre.
MkDocs est un projet open source développé en Python.
L'application utilise le processeur Markdown Python-Markdown fournissant un très bon support pour éléments de syntaxe de base, cependant, la compatibilité avec les éléments de syntaxe étendue laisse un peu à désirer.
Il est à noter que, comme MkDocs utilise Python-Markdown, il est possible d'activer des extensions supplémentaires pour changer le comportement de l'analyseur, cliquez ici pour voir une liste d'extensions disponibles et compatibles avec Python-Markdown.
Vous pouvez trouver plus d'informations sur le site officiel de MkDocs https://www.mkdocs.org/.
Utilisation de Admonitions dans MkDocs
L'extension Admonitions vous permet d'afficher des messages stylisés aux utilisateurs sur votre page sur des sites Web créés avec MkDocs.
Pour plus d'informations et d'exemples, consultez cette page dans GitHub.
Prise en charge de Markdown à MkDocs
Le Tableau 1.1 présente les éléments Markdown compatibles avec MkDocs.
| Élément | Soutien | Informations |
|---|---|---|
| Titres | Ouais | |
| Les paragraphes | Ouais | |
| Sauts de ligne | Ouais | |
| Gras | Ouais | |
| Italique | Ouais | |
| Blockquote | Ouais | |
| Listes ordonnées | Ouais | |
| Listes non ordonnées | Ouais | |
| Code | Ouais | |
| Lignes horizontales | Ouais | |
| Links | Ouais | |
| Images | Ouais | |
| les tables | Ouais | |
| Blocs de code clôturés | Ouais | Il est possible de mettre en évidence la syntaxe du contenu du bloc. |
| Notes de bas de page | Non | |
| Identifiant du titre | Non | |
| Listes de définitions | Non | |
| Barré | Non | |
| Listes de tâches | Non | |
| Emoji (copier et coller) | Ouais | Il n'est pas pris en charge par défaut, mais vous pouvez activer une extension pour utiliser cet élément Markdown. |
| Emoji (codes d'accès) | Ouais | MkDocs ne prend pas en charge les codes emoticons par défaut, mais vous pouvez installer une extension pour formater le contenu à l'aide de cet élément Markdown. |
| URL automatique Link | Ouais | |
| Désactiver URL automatique link | Ouais | |
| HTML | Ouais |