Couscous

Знакомьтесь, Couscous — это генератор сайтов для документации, который превращает обычные Markdown-файлы в полноценные веб-страницы с хостингом. Если у вас в репозитории уже лежат инструкции в Markdown, Couscous просто «подхватит» их и создаст чистый, адаптивный сайт. При этом вам не придется перекраивать структуру папок или мучиться с изучением сложных генераторов статических сайтов. Важный момент: инструмент заточен именно под техническую документацию, а не под создание сайтов общего профиля.

Процесс максимально простой. Вы пишете документацию в Markdown прямо в репозитории проекта, запускаете команду `couscous preview`, чтобы посмотреть, как всё выглядит локально, а затем вводите `couscous deploy` — и сайт улетает на GitHub Pages. Главная фишка Couscous в его лаконичности. В отличие от универсальных инструментов вроде Jekyll или Sculpin, он не диктует жесткую структуру директорий и работает так, как разработчики привыкли организовывать файлы рядом с кодом.

Инструмент будет очень полезен разработчикам и мейнтейнерам open-source проектов, которым нужно быстро запустить сайт с документацией и легко его поддерживать. Это идеальный вариант для команд, которые хотят хранить документацию в той же системе версионирования, что и код, и обновлять сайт автоматически при каждом изменении. На практике Couscous отлично подходит для создания API-документации, сайтов на базе README, технических гайдов и любых других материалов, которые должны быть публичными и версионируемыми.