Докстанция
Просто добавьте свой репозиторий, настройте параметры — и ваша документация будет автоматически обновляться. Больше никаких ручных деплоев и обновлений. Пример репозитория с документацией и пример самой документация на example.docs.beer
Быстрая регистрация и настройка
Достаточно пары кликов, чтобы начать. Добавьте репозиторий и ключ, никаких сложных конфигов!
Работает на Hugo
Ваша документация строится на проверенном генераторе Hugo в формате блога.
Бесплатно и без скрытых платежей
Пока сервис полностью бесплатный — пользуйтесь без ограничений.
Как настраивать
Документация может лежать в любой папке в репозитории. Сейчас сервис docs.beer может работать только с hugo и только когда тема лежит в папке themes в вашем сайте. В этом примере вся документация, которая должна быть сбилжена и опубликована, лежит в папке /docs.
Какие настройки указаны в сервисе:
- Репозиторий - это url вашего репозитория для клонирования, например git@gitflic.ru:kovardin/docs-beer-example.git
- Ключ - приватный ssh ключ для клонирования
- Путь к папке с документацией - нужно указать, где лежит ваша документация в репозитории, например /docs
- Домен - по этому домену будет доступна ваша документация, например example
