https://lead-devops.blackdevhub.online/tags/tools/Recent content in Tools on Lead DevOpsHugoru-RUTue, 01 Sep 2026 00:00:00 +0000https://lead-devops.blackdevhub.online/posts/mkdocs-quick-start/Tue, 01 Sep 2026 00:00:00 +0000https://lead-devops.blackdevhub.online/posts/mkdocs-quick-start/<p>Документация в репозитории устаревает быстрее, чем её читают: ссылки в README ведут в никуда, разделы разбросаны по <code>docs/</code>, <code>wiki/</code> и confluence, а поиск по сайту не работает. MkDocs решает это предсказуемо — берёт папку с <code>.md</code> файлами и собирает статический сайт. Один конфиг, одна команда для прода, привычный Markdown.</p> <h2 id="что-такое-mkdocs">Что такое MkDocs </h2> <p>MkDocs — статический генератор сайта документации на Python. На входе: каталог с Markdown-файлами и YAML-конфиг. На выходе: готовый <code>site/</code> с HTML, который отдаётся любым веб-сервером или хостится на GitHub Pages, GitLab Pages, S3. Сам MkDocs ядро рендеринга, а внешний вид и фичи задаёт тема. Стандарт де-факто — <a href="https://squidfunk.github.io/mkdocs-material/">Material for MkDocs</a>.</p>