Что это такое?
mdBook — это утилита для командной строки, которая превращает папку с Markdown-файлами в современную онлайн-книгу — статический сайт, который можно разместить где угодно. Что-то вроде Gitbook, только написано на Rust.
mdBook — это утилита для командной строки, которая превращает папку с Markdown-файлами в современную онлайн-книгу — статический сайт, который можно разместить где угодно. Что-то вроде Gitbook, только написано на Rust.Это хостинговый сервис вроде Gitbook или библиотека, которую я подключаю к своему коду?Ни то, ни другое — это отдельный open-source инструмент для командной строки, написанный на Rust. Вы запускаете его локально на своих Markdown-исходниках, и он собирает книгу; никакой хостинговый сервис при этом не используется.
Ни то, ни другое — это отдельный open-source инструмент для командной строки, написанный на Rust. Вы запускаете его локально на своих Markdown-исходниках, и он собирает книгу; никакой хостинговый сервис при этом не используется.Как его установить и создать первую книгу?Установите его с crates.io через менеджер пакетов Rust: cargo install mdbook. Дальше User Guide познакомит вас с возможностями, использованием и тем, как устроить структуру книги.
Установите его с crates.io через менеджер пакетов Rust: cargo install mdbook. Дальше User Guide познакомит вас с возможностями, использованием и тем, как устроить структуру книги.Нужно ли знать Rust или иметь какой-то особый набор инструментов, чтобы пользоваться им?Нет — вы пишете обычный Markdown, а сайт собирает mdBook. Нужен только установленный Rust-тулчейн, чтобы cargo мог скачать и собрать сам mdBook.
Нет — вы пишете обычный Markdown, а сайт собирает mdBook. Нужен только установленный Rust-тулчейн, чтобы cargo мог скачать и собрать сам mdBook.На каких платформах он работает?Это кроссплатформенный CLI-инструмент на Rust, который работает на Windows, macOS и Linux, а создаваемые книги — это обычные веб-страницы, которые открываются в любом браузере.
Это кроссплатформенный CLI-инструмент на Rust, который работает на Windows, macOS и Linux, а создаваемые книги — это обычные веб-страницы, которые открываются в любом браузере.Что я могу делать с этим инструментом и с собранными книгами с точки зрения лицензии?Весь код распространяется под Mozilla Public License v2.0 — можно свободно использовать, в том числе в коммерческих целях, при условии, что изменения в самом mdBook вы делите под той же лицензией.
Весь код распространяется под Mozilla Public License v2.0 — можно свободно использовать, в том числе в коммерческих целях, при условии, что изменения в самом mdBook вы делите под той же лицензией.Можно посмотреть, как выглядит результат, ничего не устанавливая?Да — официальный User Guide сам собран с помощью mdBook и заодно служит живым примером того, как выглядит готовая книга.
Да — официальный User Guide сам собран с помощью mdBook и заодно служит живым примером того, как выглядит готовая книга.Насколько проект зрелый и популярный?Это давно развивающийся проект в официальной организации rust-lang на GitHub, созданный в 2015 году, с более чем 22 000 звёзд. Релизы публикуются на crates.io, для разработки есть Contribution Guide.
Это давно развивающийся проект в официальной организации rust-lang на GitHub, созданный в 2015 году, с более чем 22 000 звёзд. Релизы публикуются на crates.io, для разработки есть Contribution Guide.What are similar projects?jsdoc, docusaurus, docz, quarkdown, vibex, buildawesome, mkdocs, fumadocs
jsdoc, docusaurus, docz, quarkdown, vibex, buildawesome, mkdocs, fumadocsWhich topics is it in?technical-documentation, publishing, documentation-generator, docs, documentation-tool, writing, static-site-generator, book, documentation, developers, html, markdown
technical-documentation, publishing, documentation-generator, docs, documentation-tool, writing, static-site-generator, book, documentation, developers, html, markdown