A New Look for Ruby's Documentation
Following the ruby-lang.org redesign , we have more news to celebrate Ruby’s 30th anniversary: docs.ruby-lang.org has a completely new look with Aliki— RDoc ’s new default theme. A Fresh Look for Ruby Documentation Ruby has always been a joy to write, and now reading Ruby documentation can match that experience. Aliki brings a modern, clean design to docs.ruby-lang.org and any gem that generates documentation with RDoc v7.0+. Key Features Improved search : Case-aware ranking, fuzzy matching, and support for searching constants Dark mode : Respects your OS preference with a manual toggle Three-column layout : Left sidebar for navigation, center for content, right sidebar for table of contents Code block improvements : Copy buttons on code blocks and C syntax highlighting Customizable footer : Gem maintainers can add links to their repository, issue tracker, and other resources For Gem Authors If you generate documentation with RDoc 7.0+, your users will see Aliki automatically. You can customize footer links or switch back to the Darkfish theme in your .rdoc_options file. Try It Out See the new look in action at docs.ruby-lang.org . If you find issues or have suggestions, please open an issue on GitHub. Posted by Stan Lo on 23 Dec 2025
In celebration of Ruby's 30th anniversary, the Ruby community has unveiled a significant update to its documentation platform, docs.ruby-lang.org. Following the recent redesign of ruby-lang.org, the team has introduced Aliki, the new default theme for RDoc, bringing a modern and refreshing look to Ruby's documentation. This update not only marks a new chapter in Ruby's history but also enhances the user experience for developers and enthusiasts alike.
Aliki's design was crafted with the goal of making Ruby documentation as enjoyable to read as it has always been to write. The new theme offers a clean, modern aesthetic that aligns with contemporary web design trends while maintaining the clarity and functionality that Ruby developers have come to expect. This update is not limited to the official Ruby documentation; any gem that generates documentation using RDoc version 7.0 and above will also benefit from Aliki's features.
One of the key improvements introduced by Aliki is the enhanced search functionality. The new search system offers case-aware ranking, ensuring that searches are more accurate and relevant. Additionally, fuzzy matching has been implemented, allowing users to find documentation even when they are not sure of the exact term. This feature is particularly useful for discovering constants, which can be challenging to locate using traditional search methods.
Another significant addition is the support for dark mode. Aliki respects the user's operating system preferences, automatically adjusting the theme to dark mode if it is enabled on their system. For those who prefer a manual toggle, a simple switch has been provided to easily switch between light and dark modes. This feature not only improves readability for users who prefer dark interfaces but also reduces eye strain during prolonged use.
The three-column layout is another key feature of Aliki. The left sidebar serves as a navigation tool, providing easy access to essential information. The center column houses the main content, ensuring that the documentation remains easy to read and understand. The right sidebar includes a table of contents, making it simple for users to navigate through the documentation without losing their place.
Code blocks have also been significantly improved in Aliki. Each code block now includes a "Copy" button, making it straightforward for users to copy code snippets directly into their own projects. Furthermore, the theme supports C syntax highlighting, which enhances readability and makes it easier for developers to understand the code examples provided in the documentation.
For gem authors, Aliki offers a customizable footer. Gem maintainers can add links to their repository, issue tracker, and other relevant resources, providing users with a one-stop-shop for accessing additional information about the gem. Additionally, gem authors can customize the footer links or even revert to the Darkfish theme by modifying their .rdoc_options file.
The new Aliki theme is automatically applied to any documentation generated with RDoc version 7.0 and above. This means that developers can enjoy the updated design without needing to make any changes to their existing workflows. For those who wish to explore the new look for themselves, they can visit docs.ruby-lang.org and experience the refreshed documentation firsthand.
The Ruby community encourages users to report any issues or provide suggestions related to the new theme on GitHub. By involving the community in the development process, the team aims to create a documentation platform that meets the needs and preferences of Ruby developers worldwide.
In conclusion, the introduction of Aliki represents a significant milestone in Ruby's documentation history. By offering a modern, user-friendly design and enhanced functionality, the new theme not only celebrates Ruby's 30th anniversary but also sets a new standard for documentation in the Ruby ecosystem. With continuous improvements and community input, Aliki is poised to become the go-to resource for Ruby developers, ensuring that they have access to the information they need to succeed.
