https://lead-devops.blackdevhub.online/en/tags/tools/Recent content in Tools on Lead DevOpsHugoen-USTue, 01 Sep 2026 00:00:00 +0000https://lead-devops.blackdevhub.online/en/posts/mkdocs-quick-start/Tue, 01 Sep 2026 00:00:00 +0000https://lead-devops.blackdevhub.online/en/posts/mkdocs-quick-start/<p>Documentation in a repository ages faster than anyone reads it: README links lead nowhere, sections are scattered across <code>docs/</code>, <code>wiki/</code>, and Confluence, and site search doesn&rsquo;t work. MkDocs solves this predictably — it takes a folder of <code>.md</code> files and builds a static site. One config, one command for the deploy, familiar Markdown.</p> <h2 id="what-is-mkdocs">What is MkDocs </h2> <p>MkDocs is a static site generator for documentation written in Python. Input: a directory of Markdown files and a YAML config. Output: a ready <code>site/</code> directory with HTML, served by any web server or hosted on GitHub Pages, GitLab Pages, S3. MkDocs core handles rendering; the theme defines look and features. The de-facto standard is <a href="https://squidfunk.github.io/mkdocs-material/">Material for MkDocs</a>.</p>