Serhioromano
@Serhioromano
Web Developer

Автомаическая генерация документации из markdown в статический сайт. Что использовать?

Есть проект. Все закоментирована и PHPDoc используется для генерации документации API. Но есть нужда создать что то типа книги, с разными тематическми статьями и примерами. Хотелось бы использовать что-то специализированое для этого и то что может автоматизировать процесс.

Я попробовал Jekyll, Daux.io и Read The Docs. Последний вроде понравился но я так и не смог заставить его работать у них на сервере. Все время ошбка билд импорта.

Не посоветуете хороший продукт?
  • Вопрос задан
  • 1051 просмотр
Пригласить эксперта
Ответы на вопрос 3
atomheart
@atomheart
Пишу на Python за карму и за деньги
Самостоятельно не хотите попробовать сделать? Не сложно ведь. Вот тут Что можно использовать как help для проекта в Django? я привел пример как на Django можно быстро свою wiki сваять (заточенную для просмотра).

Из решений на Python есть простая настраиваемая утилита: www.mkdocs.org
Вы ей подсовываете папку с документами, она вам генерит документацию в html.
Ответ написан
@AVKor
Pandoc пробуйте.
Ответ написан
eduardtibet
@eduardtibet
Technical Writer / Documentation Engineer
Вы сначала определитесь с форматом исходника, который будете поддерживать, а потом ищите приложение для отображения информации. Вас интересует Markdown?

Например, docs.raneto.com/what-is-raneto
Ответ написан
Комментировать
Ваш ответ на вопрос

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

Войти через центр авторизации
Похожие вопросы