Генератор MkDocs & Material

Общие сведения

Python MkDocs - это быстрый, простой и великолепный генератор статических сайтов, предназначенный для создания проектной документации. Исходные файлы документации пишутся на Markdown и настраивается с помощью одного файла конфигурации YAML. Он прост в использовании и может быть расширен сторонними темами, плагинами и расширениями Markdown.

Больше, чем темой для MkDocs является Material для MkDocs, который уже включает полезные расширения для Markdown и предоставляет хорошую документацию по установке, настройке создаваемого сайта и публикации его на GitHub.

Установка с pip

pip - это система управления пакетами для Python

Перед установкой Material для MkDocs требуется установить Python.

pip install mkdocs-material

Установка Material для MkDocs выполнится с совместимыми версиями всех зависимостей: MkDocs, Markdown, Pygments и Python Markdown Extensions. Material для MkDocs всегда стремится поддерживать последние версии, поэтому нет необходимости устанавливать эти пакеты отдельно.

Установка с Docker

Официальный образ Docker : squidfunk/mkdocs-material - отличный способ начать работу за несколько минут.

В составе образа версии 7.3 подключаются

• Python >= 3.9.2
• mkdocs >= 1.2.2
• markdown >= 3.2, Markdown: Syntax
• Pygments >= 2.4
• pymdown-extensions >= 9.0, документация
• mkdocs-material-extensions >= 1.0
• mkdocs-material 7.3

Подробнее здесь (и как добавить плагины в образ Docker?)