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

Question

[spaceatmoon]

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

Есть мысль, просто сделать по крону запрос на гайд и если есть новые, то выкачивать файлы и конвертить их в html страницы. Что думаете?

Answer 1

[Василий Банников]

просто сделать по крону запрос на гайд

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

то выкачивать файлы и конвертить их в html страницы.

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

Comments

[spaceatmoon]

Мне не нужна документация на исходный код, мне нужно только взять md файлы с проекта. Вот спрашиваю как это организовать правильно. Библиотека на c#, думаю взять этот инструмент markdig

[Василий Банников]

spaceatmoon,

Библиотека на c#

берите тогда docfx - он как раз собирает md-файлы.
https://dotnet.github.io/docfx/
+ Есть в нём отдельный раздел для API Documentation
Имхо, это лучше чем голые html страницы.

[spaceatmoon]

Василий Банников, попробую, спасибо.

[spaceatmoon]

Такс, пришлось конечно немного повозится. Привереда ещё тот насчёт путей, но всё получилось. Выглядит довольно сносно.