{"id":682,"date":"2018-08-18T17:04:14","date_gmt":"2018-08-18T16:04:14","guid":{"rendered":"http:\/\/louis.hatier.me\/blog\/?p=682"},"modified":"2018-08-22T08:22:24","modified_gmt":"2018-08-22T07:22:24","slug":"mkdocs-generateur-de-documentation","status":"publish","type":"post","link":"https:\/\/louis.hatier.me\/blog\/mkdocs-generateur-de-documentation\/","title":{"rendered":"MkDocs : g\u00e9n\u00e9rateur de documentation"},"content":{"rendered":"<p><a href=\"http:\/\/louis.hatier.me\/blog\/wp-content\/uploads\/2018\/08\/logo-mkdocs.png\" data-rel=\"lightbox-gallery-Ealxm51d\" data-rl_title=\"\" data-rl_caption=\"\" title=\"\"><img loading=\"lazy\" decoding=\"async\" class=\"size-full wp-image-683 alignleft\" src=\"http:\/\/louis.hatier.me\/blog\/wp-content\/uploads\/2018\/08\/logo-mkdocs.png\" alt=\"Logo MkDocs\" width=\"347\" height=\"115\" srcset=\"https:\/\/louis.hatier.me\/blog\/wp-content\/uploads\/2018\/08\/logo-mkdocs.png 347w, https:\/\/louis.hatier.me\/blog\/wp-content\/uploads\/2018\/08\/logo-mkdocs-300x99.png 300w\" sizes=\"auto, (max-width: 347px) 100vw, 347px\" \/><\/a><a href=\"http:\/\/www.mkdocs.org\/\" target=\"_blank\" rel=\"noopener\">MkDocs<\/a> est un outil de g\u00e9n\u00e9ration de documentation statique.<\/p>\n<p>Les pages sont r\u00e9dig\u00e9es au format <a href=\"https:\/\/fr.wikipedia.org\/wiki\/Markdown\" target=\"_blank\" rel=\"noopener\">Markdown<\/a>, et la configuration au format YAML.<\/p>\n<p>La phase de cr\u00e9ation des pages peut se faire en mode <em>live<\/em>, et la g\u00e9n\u00e9ration se build tr\u00e8s rapidement en une ligne de commande.<\/p>\n<p>La documentation g\u00e9n\u00e9r\u00e9e poss\u00e8de un menu, une barre de recherche, et plusieurs th\u00e8mes disponibles.<\/p>\n<p><!--more--><\/p>\n<h2>Installation<\/h2>\n<pre><code class=\"no-highlight\">sudo apt install mkdocs\r\n<\/code><\/pre>\n<h2>Initialisation d\u2019une documentation<\/h2>\n<pre><code class=\"no-highlight\">mkdocs new my-app\r\n<\/code><\/pre>\n<h2>Visualisation de la documentation en mode live<\/h2>\n<pre><code class=\"no-highlight\">mkdocs serve\r\n<\/code><\/pre>\n<p>Exemple simple de configuration du fichier <code>mkdocs.yml<\/code><\/p>\n<pre><code class=\"yaml\">site_name: MyApp\r\npages:\r\n    - Home: index.md\r\n    - About: about.md\r\ntheme: readthedocs\r\n<\/code><\/pre>\n<p>G\u00e9n\u00e9ration de la doc au format HTML<\/p>\n<pre><code class=\"no-highlight\">mkdocs build\r\n<\/code><\/pre>\n<h2>R\u00e9sultat<br \/>\n<a href=\"http:\/\/louis.hatier.me\/blog\/wp-content\/uploads\/2018\/08\/mkdocs-exemple.png\" data-rel=\"lightbox-gallery-Ealxm51d\" data-rl_title=\"\" data-rl_caption=\"\" title=\"\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-684\" src=\"http:\/\/louis.hatier.me\/blog\/wp-content\/uploads\/2018\/08\/mkdocs-exemple.png\" alt=\"MkDocs exemple\" width=\"561\" height=\"344\" srcset=\"https:\/\/louis.hatier.me\/blog\/wp-content\/uploads\/2018\/08\/mkdocs-exemple.png 1110w, https:\/\/louis.hatier.me\/blog\/wp-content\/uploads\/2018\/08\/mkdocs-exemple-300x184.png 300w, https:\/\/louis.hatier.me\/blog\/wp-content\/uploads\/2018\/08\/mkdocs-exemple-768x471.png 768w, https:\/\/louis.hatier.me\/blog\/wp-content\/uploads\/2018\/08\/mkdocs-exemple-1024x628.png 1024w\" sizes=\"auto, (max-width: 561px) 100vw, 561px\" \/><\/a><\/h2>\n<p>D\u2019autres th\u00e8mes sont disponibles sur le repository GitHub <a href=\"https:\/\/github.com\/mkdocs\/mkdocs\/wiki\/MkDocs-Themes\" target=\"_blank\" rel=\"noopener\">MkDocs-Themes<\/a><\/p>\n<p>Exemple avec une configuration plus pouss\u00e9e<\/p>\n<pre><code class=\"yaml\">site_name: MyApp\r\ncopyright: 'Copyright \u00a9 2017 - 2018 Louis'\r\npages:\r\n    - Accueil: index.md\r\n    - About: about.md\r\ntheme:\r\n    language: fr\r\n    name: material\r\n    palette:\r\n        primary: indigo\r\n        accent: indigo\r\nmarkdown_extensions:\r\n    - admonition\r\n    - footnotes\r\n    - codehilite:\r\n        guess_lang: false\r\n    - toc:\r\n        permalink: true\r\n<\/code><\/pre>\n<p><a href=\"http:\/\/louis.hatier.me\/blog\/wp-content\/uploads\/2018\/08\/mkdocs-exemple-custom.png\" data-rel=\"lightbox-gallery-Ealxm51d\" data-rl_title=\"\" data-rl_caption=\"\" title=\"\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-685\" src=\"http:\/\/louis.hatier.me\/blog\/wp-content\/uploads\/2018\/08\/mkdocs-exemple-custom.png\" alt=\"MkDocs exemple custom\" width=\"535\" height=\"353\" srcset=\"https:\/\/louis.hatier.me\/blog\/wp-content\/uploads\/2018\/08\/mkdocs-exemple-custom.png 1370w, https:\/\/louis.hatier.me\/blog\/wp-content\/uploads\/2018\/08\/mkdocs-exemple-custom-300x198.png 300w, https:\/\/louis.hatier.me\/blog\/wp-content\/uploads\/2018\/08\/mkdocs-exemple-custom-768x506.png 768w, https:\/\/louis.hatier.me\/blog\/wp-content\/uploads\/2018\/08\/mkdocs-exemple-custom-1024x675.png 1024w\" sizes=\"auto, (max-width: 535px) 100vw, 535px\" \/><\/a><\/p>\n<div style=\"padding-bottom:20px; padding-top:10px;\" class=\"hupso-share-buttons\"><!-- Hupso Share Buttons - https:\/\/www.hupso.com\/share\/ --><a class=\"hupso_counters\" href=\"https:\/\/www.hupso.com\/share\/\"><img decoding=\"async\" src=\"https:\/\/static.hupso.com\/share\/buttons\/dot.png\" style=\"border:0px; padding-top:2px; float:left;\" alt=\"Share Button\"\/><\/a><script type=\"text\/javascript\">var hupso_services_c=new Array(\"twitter\",\"facebook_like\",\"pinterest\",\"email\",\"linkedin\");var hupso_counters_lang = \"en_US\";var hupso_image_folder_url = \"\";var hupso_url_c=\"\";var hupso_title_c=\"MkDocs%20%3A%20g%C3%A9n%C3%A9rateur%20de%20documentation\";<\/script><script type=\"text\/javascript\" src=\"https:\/\/static.hupso.com\/share\/js\/counters.js\"><\/script><!-- Hupso Share Buttons --><\/div>","protected":false},"excerpt":{"rendered":"<p>MkDocs est un outil de g\u00e9n\u00e9ration de documentation statique. Les pages sont r\u00e9dig\u00e9es au format Markdown, et la configuration au format YAML. La phase de cr\u00e9ation des pages peut se faire en mode live, et la g\u00e9n\u00e9ration se build tr\u00e8s rapidement en une ligne de commande. La documentation g\u00e9n\u00e9r\u00e9e poss\u00e8de un menu, une barre de [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[8],"tags":[74,63],"class_list":["post-682","post","type-post","status-publish","format-standard","hentry","category-outils","tag-mkdocs","tag-open-source"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v24.9 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>MkDocs : g\u00e9n\u00e9rateur de documentation - Melting Poutre<\/title>\n<meta name=\"description\" content=\"Pr\u00e9sentation de MkDocs, un utilitaire de g\u00e9n\u00e9ration de documentation statique\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/louis.hatier.me\/blog\/mkdocs-generateur-de-documentation\/\" \/>\n<meta property=\"og:locale\" content=\"fr_FR\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"MkDocs : g\u00e9n\u00e9rateur de documentation - Melting Poutre\" \/>\n<meta property=\"og:description\" content=\"Pr\u00e9sentation de MkDocs, un utilitaire de g\u00e9n\u00e9ration de documentation statique\" \/>\n<meta property=\"og:url\" content=\"https:\/\/louis.hatier.me\/blog\/mkdocs-generateur-de-documentation\/\" \/>\n<meta property=\"og:site_name\" content=\"Melting Poutre\" \/>\n<meta property=\"article:published_time\" content=\"2018-08-18T16:04:14+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2018-08-22T07:22:24+00:00\" \/>\n<meta property=\"og:image\" content=\"http:\/\/louis.hatier.me\/blog\/wp-content\/uploads\/2018\/08\/logo-mkdocs.png\" \/>\n<meta name=\"author\" content=\"Louis Hatier\" \/>\n<meta name=\"twitter:label1\" content=\"\u00c9crit par\" \/>\n\t<meta name=\"twitter:data1\" content=\"Louis Hatier\" \/>\n\t<meta name=\"twitter:label2\" content=\"Dur\u00e9e de lecture estim\u00e9e\" \/>\n\t<meta name=\"twitter:data2\" content=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/louis.hatier.me\/blog\/mkdocs-generateur-de-documentation\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/louis.hatier.me\/blog\/mkdocs-generateur-de-documentation\/\"},\"author\":{\"name\":\"Louis Hatier\",\"@id\":\"https:\/\/louis.hatier.me\/blog\/#\/schema\/person\/2f200d0368def135b452e65491c4dd11\"},\"headline\":\"MkDocs : g\u00e9n\u00e9rateur de documentation\",\"datePublished\":\"2018-08-18T16:04:14+00:00\",\"dateModified\":\"2018-08-22T07:22:24+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/louis.hatier.me\/blog\/mkdocs-generateur-de-documentation\/\"},\"wordCount\":126,\"commentCount\":2,\"publisher\":{\"@id\":\"https:\/\/louis.hatier.me\/blog\/#\/schema\/person\/2f200d0368def135b452e65491c4dd11\"},\"image\":{\"@id\":\"https:\/\/louis.hatier.me\/blog\/mkdocs-generateur-de-documentation\/#primaryimage\"},\"thumbnailUrl\":\"http:\/\/louis.hatier.me\/blog\/wp-content\/uploads\/2018\/08\/logo-mkdocs.png\",\"keywords\":[\"MkDocs\",\"Open source\"],\"articleSection\":[\"Outils\"],\"inLanguage\":\"fr-FR\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/louis.hatier.me\/blog\/mkdocs-generateur-de-documentation\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/louis.hatier.me\/blog\/mkdocs-generateur-de-documentation\/\",\"url\":\"https:\/\/louis.hatier.me\/blog\/mkdocs-generateur-de-documentation\/\",\"name\":\"MkDocs : g\u00e9n\u00e9rateur de documentation - Melting Poutre\",\"isPartOf\":{\"@id\":\"https:\/\/louis.hatier.me\/blog\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/louis.hatier.me\/blog\/mkdocs-generateur-de-documentation\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/louis.hatier.me\/blog\/mkdocs-generateur-de-documentation\/#primaryimage\"},\"thumbnailUrl\":\"http:\/\/louis.hatier.me\/blog\/wp-content\/uploads\/2018\/08\/logo-mkdocs.png\",\"datePublished\":\"2018-08-18T16:04:14+00:00\",\"dateModified\":\"2018-08-22T07:22:24+00:00\",\"description\":\"Pr\u00e9sentation de MkDocs, un utilitaire de g\u00e9n\u00e9ration de documentation statique\",\"inLanguage\":\"fr-FR\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/louis.hatier.me\/blog\/mkdocs-generateur-de-documentation\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"fr-FR\",\"@id\":\"https:\/\/louis.hatier.me\/blog\/mkdocs-generateur-de-documentation\/#primaryimage\",\"url\":\"http:\/\/louis.hatier.me\/blog\/wp-content\/uploads\/2018\/08\/logo-mkdocs.png\",\"contentUrl\":\"http:\/\/louis.hatier.me\/blog\/wp-content\/uploads\/2018\/08\/logo-mkdocs.png\"},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/louis.hatier.me\/blog\/#website\",\"url\":\"https:\/\/louis.hatier.me\/blog\/\",\"name\":\"Melting Poutre\",\"description\":\"Du web et d&#039;autres choses\",\"publisher\":{\"@id\":\"https:\/\/louis.hatier.me\/blog\/#\/schema\/person\/2f200d0368def135b452e65491c4dd11\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/louis.hatier.me\/blog\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"fr-FR\"},{\"@type\":[\"Person\",\"Organization\"],\"@id\":\"https:\/\/louis.hatier.me\/blog\/#\/schema\/person\/2f200d0368def135b452e65491c4dd11\",\"name\":\"Louis Hatier\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"fr-FR\",\"@id\":\"https:\/\/louis.hatier.me\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/cd8d107ede5a4ec340326655e74a00ca62b02e41a02442f961c36f085aa89942?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/cd8d107ede5a4ec340326655e74a00ca62b02e41a02442f961c36f085aa89942?s=96&d=mm&r=g\",\"caption\":\"Louis Hatier\"},\"logo\":{\"@id\":\"https:\/\/louis.hatier.me\/blog\/#\/schema\/person\/image\/\"},\"sameAs\":[\"https:\/\/louis.hatier.me\",\"https:\/\/www.linkedin.com\/in\/louishatier\/\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"MkDocs : g\u00e9n\u00e9rateur de documentation - Melting Poutre","description":"Pr\u00e9sentation de MkDocs, un utilitaire de g\u00e9n\u00e9ration de documentation statique","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/louis.hatier.me\/blog\/mkdocs-generateur-de-documentation\/","og_locale":"fr_FR","og_type":"article","og_title":"MkDocs : g\u00e9n\u00e9rateur de documentation - Melting Poutre","og_description":"Pr\u00e9sentation de MkDocs, un utilitaire de g\u00e9n\u00e9ration de documentation statique","og_url":"https:\/\/louis.hatier.me\/blog\/mkdocs-generateur-de-documentation\/","og_site_name":"Melting Poutre","article_published_time":"2018-08-18T16:04:14+00:00","article_modified_time":"2018-08-22T07:22:24+00:00","og_image":[{"url":"http:\/\/louis.hatier.me\/blog\/wp-content\/uploads\/2018\/08\/logo-mkdocs.png","type":"","width":"","height":""}],"author":"Louis Hatier","twitter_misc":{"\u00c9crit par":"Louis Hatier","Dur\u00e9e de lecture estim\u00e9e":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/louis.hatier.me\/blog\/mkdocs-generateur-de-documentation\/#article","isPartOf":{"@id":"https:\/\/louis.hatier.me\/blog\/mkdocs-generateur-de-documentation\/"},"author":{"name":"Louis Hatier","@id":"https:\/\/louis.hatier.me\/blog\/#\/schema\/person\/2f200d0368def135b452e65491c4dd11"},"headline":"MkDocs : g\u00e9n\u00e9rateur de documentation","datePublished":"2018-08-18T16:04:14+00:00","dateModified":"2018-08-22T07:22:24+00:00","mainEntityOfPage":{"@id":"https:\/\/louis.hatier.me\/blog\/mkdocs-generateur-de-documentation\/"},"wordCount":126,"commentCount":2,"publisher":{"@id":"https:\/\/louis.hatier.me\/blog\/#\/schema\/person\/2f200d0368def135b452e65491c4dd11"},"image":{"@id":"https:\/\/louis.hatier.me\/blog\/mkdocs-generateur-de-documentation\/#primaryimage"},"thumbnailUrl":"http:\/\/louis.hatier.me\/blog\/wp-content\/uploads\/2018\/08\/logo-mkdocs.png","keywords":["MkDocs","Open source"],"articleSection":["Outils"],"inLanguage":"fr-FR","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/louis.hatier.me\/blog\/mkdocs-generateur-de-documentation\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/louis.hatier.me\/blog\/mkdocs-generateur-de-documentation\/","url":"https:\/\/louis.hatier.me\/blog\/mkdocs-generateur-de-documentation\/","name":"MkDocs : g\u00e9n\u00e9rateur de documentation - Melting Poutre","isPartOf":{"@id":"https:\/\/louis.hatier.me\/blog\/#website"},"primaryImageOfPage":{"@id":"https:\/\/louis.hatier.me\/blog\/mkdocs-generateur-de-documentation\/#primaryimage"},"image":{"@id":"https:\/\/louis.hatier.me\/blog\/mkdocs-generateur-de-documentation\/#primaryimage"},"thumbnailUrl":"http:\/\/louis.hatier.me\/blog\/wp-content\/uploads\/2018\/08\/logo-mkdocs.png","datePublished":"2018-08-18T16:04:14+00:00","dateModified":"2018-08-22T07:22:24+00:00","description":"Pr\u00e9sentation de MkDocs, un utilitaire de g\u00e9n\u00e9ration de documentation statique","inLanguage":"fr-FR","potentialAction":[{"@type":"ReadAction","target":["https:\/\/louis.hatier.me\/blog\/mkdocs-generateur-de-documentation\/"]}]},{"@type":"ImageObject","inLanguage":"fr-FR","@id":"https:\/\/louis.hatier.me\/blog\/mkdocs-generateur-de-documentation\/#primaryimage","url":"http:\/\/louis.hatier.me\/blog\/wp-content\/uploads\/2018\/08\/logo-mkdocs.png","contentUrl":"http:\/\/louis.hatier.me\/blog\/wp-content\/uploads\/2018\/08\/logo-mkdocs.png"},{"@type":"WebSite","@id":"https:\/\/louis.hatier.me\/blog\/#website","url":"https:\/\/louis.hatier.me\/blog\/","name":"Melting Poutre","description":"Du web et d&#039;autres choses","publisher":{"@id":"https:\/\/louis.hatier.me\/blog\/#\/schema\/person\/2f200d0368def135b452e65491c4dd11"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/louis.hatier.me\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"fr-FR"},{"@type":["Person","Organization"],"@id":"https:\/\/louis.hatier.me\/blog\/#\/schema\/person\/2f200d0368def135b452e65491c4dd11","name":"Louis Hatier","image":{"@type":"ImageObject","inLanguage":"fr-FR","@id":"https:\/\/louis.hatier.me\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/cd8d107ede5a4ec340326655e74a00ca62b02e41a02442f961c36f085aa89942?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/cd8d107ede5a4ec340326655e74a00ca62b02e41a02442f961c36f085aa89942?s=96&d=mm&r=g","caption":"Louis Hatier"},"logo":{"@id":"https:\/\/louis.hatier.me\/blog\/#\/schema\/person\/image\/"},"sameAs":["https:\/\/louis.hatier.me","https:\/\/www.linkedin.com\/in\/louishatier\/"]}]}},"_links":{"self":[{"href":"https:\/\/louis.hatier.me\/blog\/wp-json\/wp\/v2\/posts\/682","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/louis.hatier.me\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/louis.hatier.me\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/louis.hatier.me\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/louis.hatier.me\/blog\/wp-json\/wp\/v2\/comments?post=682"}],"version-history":[{"count":2,"href":"https:\/\/louis.hatier.me\/blog\/wp-json\/wp\/v2\/posts\/682\/revisions"}],"predecessor-version":[{"id":709,"href":"https:\/\/louis.hatier.me\/blog\/wp-json\/wp\/v2\/posts\/682\/revisions\/709"}],"wp:attachment":[{"href":"https:\/\/louis.hatier.me\/blog\/wp-json\/wp\/v2\/media?parent=682"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/louis.hatier.me\/blog\/wp-json\/wp\/v2\/categories?post=682"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/louis.hatier.me\/blog\/wp-json\/wp\/v2\/tags?post=682"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}