Новый облик документации Ruby

Опубликовал Stan Lo 23-12-2025
Перевел: ablzh

Вслед за редизайном ruby-lang.org, у нас есть еще новости в честь 30-летия Ruby: docs.ruby-lang.org получил полностью новый облик с Aliki — новым стандартным шаблоном RDoc.

Свежий взгляд на документацию Ruby

Писать на Ruby всегда было удовольствием, и теперь чтение документации Ruby может соответствовать этому опыту. Aliki привносит современный и чистый дизайн на docs.ruby-lang.org и в любой гем, который генерирует документацию с помощью RDoc версии 7.0 и выше.

Ключевые особенности

• Улучшенный поиск: ранжирование с учетом регистра, нечеткий поиск и поддержка поиска констант.
• Темная тема: учитывает настройки вашей ОС с возможностью ручного переключения.
• Трехколоночный макет: левая боковая панель для навигации, центральная часть для контента и правая боковая панель для оглавления.
• Улучшения блоков кода: кнопки копирования в блоках кода и подсветка синтаксиса C.
• Настраиваемый футер: авторы гемов могут добавлять ссылки на свой репозиторий, трекер задач и другие ресурсы.

Для авторов гемов

Если вы генерируете документацию с помощью RDoc 7.0+, ваши пользователи автоматически увидят Aliki. Вы можете настроить ссылки в футере или вернуться к теме Darkfish в вашем файле .rdoc_options.

Попробуйте сами

Посмотрите на новый дизайн в действии на docs.ruby-lang.org.

Если вы обнаружите ошибки или у вас появятся предложения, пожалуйста, откройте issue на GitHub.