@spaceatmoon

Как правильно разместить документацию на библиотеку?

У меня есть библиотека и она располагается в одном репозитории, рядом с ней лежит документация в md файлах. Хочу сделать сайт с примерами и документацией. Это другой, приватный репозиторий. Вот здесь я не очень понимаю как правильно разрулить этот момент.

Есть мысль, просто сделать по крону запрос на гайд и если есть новые, то выкачивать файлы и конвертить их в html страницы. Что думаете?
  • Вопрос задан
  • 101 просмотр
Решения вопроса 1
vabka
@vabka
Токсичный шарпист
просто сделать по крону запрос на гайд

В github есть actions, при помощи которых ты можешь на каждый коммит обновлять документацию.
то выкачивать файлы и конвертить их в html страницы.

Для этого уже есть готовые инструменты, для разных языков: doxygen, gitbook, docfx итд.
Вероятно, для вашего языка уже есть готовый генератор html на основе комментариев в коде.
Ответ написан
Пригласить эксперта
Ваш ответ на вопрос

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

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