Skip to content

Commit 4f2cf5e

Browse files
authored
Merge pull request #3737 from st0012/announce-aliki
Add announcement for Ruby's new documentation theme
2 parents 8229513 + 7f43958 commit 4f2cf5e

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
layout: news_post
3+
title: "A New Look for Ruby's Documentation"
4+
author: "Stan Lo"
5+
translator:
6+
date: 2025-12-23 00:00:00 +0000
7+
lang: en
8+
---
9+
10+
Following the [ruby-lang.org redesign](https://www.ruby-lang.org/en/news/2025/12/22/redesign-site-identity/), we have more news to celebrate Ruby's 30th anniversary: [docs.ruby-lang.org][ruby-doc] has a completely new look with Aliki—[RDoc](https://github.com/ruby/rdoc)'s new default theme.
11+
12+
## A Fresh Look for Ruby Documentation
13+
14+
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][ruby-doc] and any gem that generates documentation with RDoc v7.0+.
15+
16+
## Key Features
17+
18+
- **Improved search**: Case-aware ranking, fuzzy matching, and support for searching constants
19+
- **Dark mode**: Respects your OS preference with a manual toggle
20+
- **Three-column layout**: Left sidebar for navigation, center for content, right sidebar for table of contents
21+
- **Code block improvements**: Copy buttons on code blocks and C syntax highlighting
22+
- **Customizable footer**: Gem maintainers can add links to their repository, issue tracker, and other resources
23+
24+
## For Gem Authors
25+
26+
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.
27+
28+
## Try It Out
29+
30+
See the new look in action at [docs.ruby-lang.org][ruby-doc].
31+
32+
If you find issues or have suggestions, please [open an issue](https://github.com/ruby/rdoc/issues) on GitHub.
33+
34+
[ruby-doc]: https://docs.ruby-lang.org/en/master/

0 commit comments

Comments
 (0)