Repolode
rust-lang

rust-lang/mdBook

Консольная утилита на Rust, которая собирает онлайн-книги из файлов Markdown, подобно GitBook.

Open source альтернатива:GitBook

Звёзды
22,236
Форки
1,908
Открытые issues
659
Последний коммит
20 часов назад

Что это?

mdBook превращает каталог с файлами Markdown в современную онлайн-книгу с удобной навигацией. Утилита предназначена для документации и других объёмных материалов, например руководств по программированию; на mdBook также собран собственный User Guide проекта.

Проект написан на Rust и распространяется через crates.io, поэтому его можно установить как единый исполняемый файл для командной строки. Структура книги задаётся файлом конфигурации и оглавлением, а результатом становится статический сайт, который можно разместить на любом сервере статических файлов.

Поскольку mdBook работает с обычным Markdown, материалы остаются под контролем версий, и их можно редактировать в любом текстовом редакторе. Утилита распространяется по лицензии Mozilla Public License v2.0.

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

  • 01Собирает статическую HTML-книгу из исходных файлов Markdown.
  • 02Структура книги задаётся файлом оглавления.
  • 03Устанавливается как единый исполняемый файл на Rust через crates.io.
  • 04На выходе получается статический сайт, который можно разместить на любом сервере статических файлов.

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

  • Публикация руководства пользователя по языку программирования или библиотеке.
  • Ведение внутренней инженерной документации в Git-репозитории.
  • Создание объёмного учебного пособия или конспекта курса в виде сайта с удобной навигацией.

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

  • Проект распространяется по лицензии MPL-2.0 с копилефтом на уровне файлов, поэтому изменённые исходные файлы должны оставаться под лицензией MPL-2.0.

Темы

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

Что такое mdBook?
Консольная утилита на Rust, которая собирает онлайн-книги из файлов Markdown, подобно GitBook. mdBook превращает каталог с файлами Markdown в современную онлайн-книгу с удобной навигацией. Утилита предназначена для документации и других объёмных материалов, например руководств по программированию; на mdBook также собран собственный User Guide проекта.
mdBook можно использовать бесплатно? Какая у него лицензия?
mdBook распространяется с открытым исходным кодом под лицензией MPL-2.0. Перед использованием в коммерческих продуктах проверьте условия лицензии.
mdBook всё ещё поддерживается?
Активно поддерживается. Последний коммит в mdBook — 21 окт. 2026 г..
Для чего можно использовать mdBook?
Публикация руководства пользователя по языку программирования или библиотеке. Ведение внутренней инженерной документации в Git-репозитории. Создание объёмного учебного пособия или конспекта курса в виде сайта с удобной навигацией.
Где скачать mdBook?
Исходный код и инструкции по установке — на GitHub: https://github.com/rust-lang/mdBook

Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.

Похожие проекты