danielfrg/mkdocs-jupyter

Что это?

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

• 01Добавляет файлы .ipynb и .py в формате Jupytext прямо в навигацию MkDocs.
• 02При необходимости выполняет ноутбуки перед преобразованием; для отдельных файлов выполнение можно отключить.
• 03Позволяет скрывать ввод кода и приглашения глобально или в ячейках с заданными тегами.
• 04Поддерживает темы Jupyter, ipywidgets и отображение математических формул с помощью MathJax.
• 05Добавляет ссылку для скачивания исходного файла ноутбука и кэширует результаты преобразования.

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

• Публикация руководств по Data Science с запускаемым кодом и видимыми результатами на сайте документации.
• Создание документации API или библиотек с исполняемыми примерами.
• Подготовка технических статей или учебных материалов в формате ноутбуков на MkDocs.

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

1. 1

   Установите плагин из PyPI

   pip install mkdocs-jupyter
2. 2

   Добавьте плагин в plugins в mkdocs.yml и перечислите свои ноутбуки или файлы .py в nav

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

• !Работает только как плагин для MkDocs, поэтому у вас должен быть готовый сайт на MkDocs.

В подборках

Темы

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

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

Плагин для MkDocs, который преобразует Jupyter Notebook и файлы Jupytext .py в страницы документации с возможностью выполнения кода и настройки оформления темы. mkdocs-jupyter позволяет добавлять Jupyter Notebook прямо в навигацию сайта на MkDocs, чтобы размещать руководства и аналитические материалы рядом с обычными Markdown-страницами. Плагин принимает файлы .ipynb и Python-скрипты в формате Jupytext, оформляя их так же, как стандартный вывод Jupyter Notebook; также поддерживаются темы Jupyter и ipywidgets.

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

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

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

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

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

Публикация руководств по Data Science с запускаемым кодом и видимыми результатами на сайте документации. Создание документации API или библиотек с исполняемыми примерами. Подготовка технических статей или учебных материалов в формате ноутбуков на MkDocs.

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

Установите плагин из PyPI: pip install mkdocs-jupyter Добавьте плагин в plugins в mkdocs.yml и перечислите свои ноутбуки или файлы .py в nav

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

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