squidfunk/mkdocs-material

Что это?

Ключевые возможности

• 01Пишите документацию в Markdown без необходимости использовать HTML, CSS или JavaScript.
• 02Адаптивный макет подстраивается под экраны компьютеров, планшетов и телефонов.
• 03Встроенные поиск и навигация для сгенерированных статических сайтов.
• 04Настраивайте цвета, шрифты, значки, логотип и язык через конфигурацию.
• 05Поддерживается более 60 языков интерфейса.

Сценарии использования

• Создание сайта документации для open source-библиотеки или инструмента.
• Публикация внутренних документов о продуктах или разработке в компании.
• Создание многоязычного сайта документации с единым оформлением.

Быстрый старт

1. 1

   Установите Material for MkDocs с помощью pip

   pip install mkdocs-material
2. 2

   Добавьте тему в mkdocs.yml

   theme: name: material

Что важно знать

• !Требуются Python и набор инструментов MkDocs, поэтому это подходит только для сайтов с документацией.

Темы

Частые вопросы

Что такое mkdocs-material?

Тема Material Design для MkDocs, которая превращает Markdown-файлы в адаптивный статический сайт документации с поиском. Material for MkDocs — тема для MkDocs, генератора статических сайтов с документацией проектов в формате Markdown. Она преобразует исходные Markdown-файлы в оформленный сайт с навигацией, поиском и макетами, адаптирующимися к экранам компьютеров, планшетов и телефонов. Тему можно установить как пакет pip и включить, добавив несколько строк в mkdocs.yml.

mkdocs-material можно использовать бесплатно? Какая у него лицензия?

mkdocs-material распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.

mkdocs-material всё ещё поддерживается?

Активно поддерживается. Последний коммит в mkdocs-material — 17 окт. 2026 г..

Для чего можно использовать mkdocs-material?

Создание сайта документации для open source-библиотеки или инструмента. Публикация внутренних документов о продуктах или разработке в компании. Создание многоязычного сайта документации с единым оформлением.

Как установить mkdocs-material?

Установите Material for MkDocs с помощью pip: pip install mkdocs-material Добавьте тему в mkdocs.yml: theme: name: material

Где скачать mkdocs-material?

Исходный код и инструкции по установке — на GitHub: https://github.com/squidfunk/mkdocs-material