ВойтиСоздать аккаунт
ВойтиСоздать аккаунт

mkdocs

Из публичных источников

MkDocs — открытый генератор статических сайтов (CLI-инструмент) для создания документации проектов из файлов Markdown с настройкой через один YAML-файл.

CLI-инструментКатегория: Инструменты разработчика · ДокументированиеOpen sourceданные проверены 15 окт. 2026 г.
СравнитьВ коллекцию

Обзор

Документация проектов часто разбросана по вики, README и отдельным страницам, которые трудно поддерживать в актуальном состоянии. MkDocs решает эту задачу: он превращает исходные файлы в формате Markdown в статический HTML-сайт документации, настраиваемый одним YAML-файлом. MkDocs можно расширять сторонними темами, плагинами и расширениями Markdown, а также использовать встроенные темы. Результат — обычные статические файлы, которые можно опубликовать везде, где возможна раздача статики. MkDocs ориентирован на разработчиков и технических писателей, которые хотят вести документацию вместе с кодом. Инструмент написан на Python, распространяется под лицензией BSD-2-Clause и работает из командной строки.
  • documentation
  • knowledge-base
  • markdown
  • mkdocs
  • python
  • static-site-generator

Установка

Команды только показываются, маркетплейс их не выполняет. Сверяйтесь с официальной документацией.
  • Официальный сайтИз публичных источниковиз метаданных каталога
    www.mkdocs.org/ ↗
  • Реестр пакетов языкаpythonИз публичных источниковиз манифеста пакета — публикация в реестре не проверена
    pipx install mkdocs

    Не проверено: перед установкой убедитесь, что пакет в реестре принадлежит этому проекту.

    pypi.org/project/mkdocs/ ↗
  • Сборка из исходниковИз публичных источниковиз метаданных каталога

    Сборка из исходников: проверенного рецепта сборки нет — следуйте инструкциям репозитория.

    github.com/mkdocs/mkdocs ↗

Совместимость

«Неизвестно» значит, что доказательств не найдено, а не что продукт несовместим.
ПлатформаСтатусАрхитектураДоказательствоУверенность
WindowsНеизвестно———
macOSНеизвестно———
LinuxНеизвестно———
Container (OCI)Неизвестно———
Web browserСовместимо—Заявлено в карточке—
PythonСовместимо—манифест пакета: pyproject.toml name0.60

Релизы

проверено 29 окт. 2026 г.
v1.6.1Последний30 авг. 2024 г.Официальный источник ↗

Файлы версии 1.6.1

К релизу не приложены файлы.

История релизов

Профиль качества

алгоритм quality-v1.0 · оценено 15 окт. 2026 г.
Оценка качества73
Оценка риска0
Уверенность 1.00
Оценка качества и оценка риска — разные показатели. Высокое качество не гарантирует безопасность.

Составляющие оценки

Поддержка · 206
last activity 360 days ago
Документация · 1515
README 3117 chars, description present
Готовность к использованию · 156
install instructions: no; releases: yes
Метаданные · 1010
4/4 of description, homepage, license, topics
Релизы · 106
10 release(s), latest 776 days ago
Точность категории · 1010
classifier confidence 1
Популярность · 1010
22501 stars (log-dampened, 10k = max)
Ясность лицензии · 55
SPDX BSD-2-Clause
Сообщество · 55
issues enabled, 2657 forks

Лицензия

BSD-2-Clause
Лицензия известнапо данным хостинга репозитория

Это статус политики каталога, а не юридическое заключение.

Источники

github.com/mkdocs/mkdocsОсновной★ 22 501 звёздактивность 20 окт. 2025 г.Основной репозиторий · Уверенность 1.00

Отзывы

Войдите, чтобы написать отзыв

Отзывов пока нет.

Альтернативы

mkdocs-materialПохожий
Material for MkDocs — открытая тема и фреймворк для MkDocs, который превращает Markdown-файлы в быстрый, адаптивный и поисковый статический сайт документации.MIT · Инструменты разработчика
docsifyПохожий
Docsify — открытый генератор документационных сайтов из Markdown-файлов без этапа сборки, инструмент для разработчиков в категории Developer Tools.MIT · Инструменты разработчика
vitepressПохожий
VitePress — открытый генератор статических сайтов на Vue и Vite для быстрой сборки документации из Markdown.MIT · Инструменты разработчика
docusaurusПохожий
Docusaurus — открытый CLI и фреймворк на базе React для создания, публикации и поддержки документационных сайтов программных проектов.MIT · Инструменты разработчика
OCRmyPDFПохожий
OCRmyPDF — открытый инструмент командной строки, который добавляет текстовый слой OCR в сканированные PDF-файлы и делает их доступными для поиска.MPL-2.0 · Инструменты разработчика
reflexПохожий
🕸️ Веб-приложения на чистом Python 🐍Apache-2.0 · Инструменты разработчика

README

Из mkdocs/mkdocs · лицензия BSD-2-Clause · загружено 29 окт. 2026 г.

MkDocs

Project documentation with Markdown

[PyPI Version] [Build Status] [Coverage Status]

MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. It is designed to be easy to use and can be extended with third-party themes, plugins, and Markdown extensions.

Please see the Documentation for an introductory tutorial and a full user guide.

Features

  • Build static HTML files from Markdown files.
  • Use Plugins and Markdown Extensions to enhance MkDocs.
  • Use the built-in themes, third party themes or create your own.
  • Publish your documentation anywhere that static files can be served.
  • Much more!

Support

If you need help with MkDocs, do not hesitate to get in contact with us!

  • For questions and high-level discussions, use Discussions on GitHub.
    • For small questions, a good alternative is the Chat room on Gitter/Matrix.
  • To report a bug or make a feature request, open an Issue on GitHub.

Please note that we may only provide support for problems/questions regarding core features of MkDocs. Any questions or bug reports about features of third-party themes, plugins, extensions or similar should be made to their respective projects.
But, such questions are not banned from the chat room.

Make sure to stick around to answer some questions as well!

Links

Contributing to MkDocs

The MkDocs project welcomes, and depends on, contributions from developers and users in the open source community. Please see the Contributing Guide for information on how you can help.

Code of Conduct

Everyone interacting in the MkDocs project's codebases, issue trackers, and discussion forums is expected to follow the PyPA Code of Conduct.

License

BSD-2-Clause

Открыть репозиторий ↗