mkdocs

MKDocs

Documentation du projet avec Markdown

MkDocs est un générateur de site statique rapide , simple et carrément magnifique , destiné à la création de documentation de projet. Les fichiers sources de la documentation sont écrits en Markdown et configurés avec un seul fichier de configuration YAML. Il est conçu pour être facile à utiliser et peut être étendu avec des thèmes, plugins et extensions Markdown tiers.

Veuillez consulter la documentation pour un didacticiel d'introduction et un guide de l'utilisateur complet.

Caractéristiques

• Créez des fichiers HTML statiques à partir de fichiers Markdown.
• Utilisez des plugins et des extensions Markdown pour améliorer MkDocs.
• Utilisez les thèmes intégrés, les thèmes tiers ou créez les vôtres.
• Publiez votre documentation partout où des fichiers statiques peuvent être servis.
• Bien plus encore !

Soutien

Si vous avez besoin d'aide avec MkDocs, n'hésitez pas à nous contacter !

• Pour les questions et les discussions de haut niveau, utilisez Discussions sur GitHub.
  • Pour les petites questions, une bonne alternative est le Chat room sur Gitter/Matrix.
• Pour signaler un bug ou faire une demande de fonctionnalité, ouvrez un problème sur GitHub.

Veuillez noter que nous pouvons uniquement fournir une assistance pour les problèmes/questions concernant les fonctionnalités principales de MkDocs. Toute question ou rapport de bug concernant les fonctionnalités de thèmes, plugins, extensions ou similaires tiers doit être adressé à leurs projets respectifs.
Mais ces questions ne sont pas interdites dans le salon de discussion.

Assurez-vous également de rester dans les parages pour répondre à quelques questions !

Links

• Documentation officielle
• Dernières notes de version
• Catalogue de plugins, thèmes et recettes tiers

Contribuer à MkDocs

Le projet MkDocs accueille et dépend des contributions des développeurs et des utilisateurs de la communauté open source. Veuillez consulter le Guide de contribution pour savoir comment vous pouvez aider.

Code de conduite

Toute personne interagissant dans les bases de code, les outils de suivi des problèmes et les forums de discussion du projet MkDocs doit suivre le code de conduite PyPA.

Licence

Clause BSD-2