Введение

Mddoc — это инструмент с открытым исходным кодом для преобразования документов Markdown в HTML. Он разработан на PHP и поддерживает версии PHP >= 5.4. Сгенерированный HTML можно разместить непосредственно на веб-сайте, он поддерживает полнотекстовый поиск и настраиваемые HTML-шаблоны.

Mdoc поддерживает генерацию как из командной строки, так и через Git Webhook. Его можно использовать не только для локального создания и последующей загрузки, но и для автоматической генерации и развёртывания через webhook, что делает его очень простым в использовании.

Mdoc совместим с форматом, который используется в редакторе GitBook Editor, поэтому его можно назвать отличным выбором для тех, кто хочет использовать Gitbook, но не может установить среду Node.

На самом деле, я разработал mdoc потому, что использовал виртуальный хостинг, на котором нельзя было установить Node. Реализовать автоматическую генерацию через webhook было сложно, поэтому я написал этот инструмент на PHP.

Конкретный результат, который вы сейчас видите перед собой, был создан с помощью mdoc! (https://doc.yurunsoft.com/mddoc)

Github: https://github.com/Yurunsoft/mddoc Gitee: https://gitee.com/yurunsoft/mdoc composer: yurunsoft/mdoc

Генерация из командной строки

1. Сначала скачайте проект с помощью git.
2. Выполните команду composer update, чтобы установить необходимые зависимости.
3. Выполните php build.php -markdownPath "путь к документу Markdown" -htmlPath "путь для генерации HTML".

Внимание! Каталог для генерации будет очищен от всех файлов перед созданием новых. Будьте осторожны при выборе каталога!