Change the default theme to Aliki

Author: st0012

.rdoc_options

@@ -4,8 +4,6 @@ main_page: README.md
 autolink_excluded_words:
 - RDoc
 
-generator_name: aliki
-
 exclude:
 - AGENTS.md
 - CLAUDE.md

AGENTS.md

@@ -146,10 +146,13 @@ lib/rdoc/
 │   ├── prism_ruby.rb          # Prism-based Ruby parser
 │   └── ...
 ├── generator/                 # Documentation generators
-│   ├── darkfish.rb            # HTML generator (default theme)
+│   ├── aliki.rb               # HTML generator (default theme)
+│   ├── darkfish.rb            # HTML generator (deprecated, will be removed in v8.0)
 │   ├── markup.rb              # Markup format generator
 │   ├── ri.rb                  # RI command generator
-│   └── template/darkfish/     # ERB templates (.rhtml files)
+│   └── template/              # ERB templates (.rhtml files)
+│       ├── aliki/             # Aliki theme (default)
+│       └── darkfish/          # Darkfish theme (deprecated)
 ├── markup/                    # Markup parsing and formatting
 ├── code_object/               # AST objects for documented items
 ├── markdown/                  # Markdown parsing
@@ -196,7 +199,7 @@ exe/
 ### Pluggable System
 
 - **Parsers:** Ruby, C, Markdown, RD, Prism-based Ruby (experimental)
-- **Generators:** HTML/Darkfish, RI, POT (gettext), JSON, Markup
+- **Generators:** HTML/Aliki (default), HTML/Darkfish (deprecated), RI, POT (gettext), JSON, Markup
 
 ## Common Workflows
 

CONTRIBUTING.md

@@ -136,8 +136,8 @@ bundle exec rake coverage
 
 RDoc ships with two HTML themes:
 
-- **Aliki** - Modern theme with improved styling and navigation (will become the default)
-- **Darkfish** - Classic theme (entering maintenance mode)
+- **Aliki** (default) - Modern theme with improved styling and navigation
+- **Darkfish** (deprecated) - Classic theme, will be removed in v8.0
 
 New feature development should focus on the Aliki theme. Darkfish will continue to receive bug fixes but no new features.
 
@@ -156,12 +156,13 @@ lib/rdoc/
 │   ├── prism_ruby.rb          # Prism-based Ruby parser
 │   └── ...
 ├── generator/                 # Documentation generators
-│   ├── darkfish.rb            # HTML generator (default theme)
+│   ├── aliki.rb               # HTML generator (default theme)
+│   ├── darkfish.rb            # HTML generator (deprecated, will be removed in v8.0)
 │   ├── markup.rb              # Markup format generator
 │   ├── ri.rb                  # RI command generator
 │   └── template/              # ERB templates
-│       ├── darkfish/          # Darkfish theme (maintenance mode)
-│       └── aliki/             # Aliki theme (active development)
+│       ├── aliki/             # Aliki theme (default)
+│       └── darkfish/          # Darkfish theme (deprecated)
 ├── markup/                    # Markup parsing and formatting
 ├── code_object/               # AST objects for documented items
 ├── markdown.kpeg              # Parser source (edit this)

LEGAL.rdoc

@@ -4,6 +4,12 @@
 
 The files in this distribution are covered by the Ruby license (see LICENSE) except the features mentioned below:
 
+Aliki::
+  Aliki was written by Stan Lo and is included under the MIT license.
+
+  * lib/rdoc/generator/aliki.rb
+  * lib/rdoc/generator/template/aliki/*
+
 Darkfish::
   Darkfish was written by Michael Granger and is included under the BSD 3-Clause
   license.  Darkfish contains images from the Silk Icons set by Mark James.

README.md

@@ -48,7 +48,7 @@ require 'rdoc/rdoc'
 
 options = RDoc::Options.new
 options.files = ['a.rb', 'b.rb']
-options.setup_generator 'darkfish'
+options.setup_generator 'aliki'
 # see RDoc::Options
 
 rdoc = RDoc::RDoc.new
@@ -90,7 +90,24 @@ To determine how well your project is documented run `rdoc -C lib` to get a docu
 
 ## Theme Options
 
-There are a few community-maintained themes for RDoc:
+RDoc ships with two built-in themes:
+
+- **Aliki** (default) - A modern, clean theme with improved navigation and search
+- **Darkfish** (deprecated) - The classic theme, will be removed in v8.0
+
+To use the Darkfish theme instead of the default Aliki theme:
+
+```shell
+rdoc --format darkfish
+```
+
+Or in your `.rdoc_options` file:
+
+```yaml
+generator_name: darkfish
+```
+
+There are also a few community-maintained themes for RDoc:
 
 - [rorvswild-theme-rdoc](https://github.com/BaseSecrete/rorvswild-theme-rdoc)
 - [hanna](https://github.com/jeremyevans/hanna) (a fork maintained by [Jeremy Evans](https://github.com/jeremyevans))

lib/rdoc/options.rb

@@ -411,7 +411,7 @@ def init_ivars # :nodoc:
     @files = nil
     @force_output = false
     @force_update = true
-    @generator_name = "darkfish"
+    @generator_name = "aliki"
     @generators = RDoc::RDoc::GENERATORS
     @generator_options = []
     @hyperlink_all = false

lib/rdoc/rubygems_hook.rb

@@ -118,7 +118,7 @@ def delete_legacy_args(args)
   end
 
   ##
-  # Generates documentation using the named +generator+ ("darkfish" or "ri")
+  # Generates documentation using the named +generator+ ("aliki" or "ri")
   # and following the given +options+.
   #
   # Documentation will be generated into +destination+
@@ -190,7 +190,7 @@ def generate
 
     Dir.chdir @spec.full_gem_path do
       # RDoc::Options#finish must be called before parse_files.
-      # RDoc::Options#finish is also called after ri/darkfish generator setup.
+      # RDoc::Options#finish is also called after ri/aliki generator setup.
       # We need to dup the options to avoid modifying it after finish is called.
       parse_options = options.dup
       parse_options.finish
@@ -202,7 +202,7 @@ def generate
     document 'ri',       options, @ri_dir if
       @generate_ri   and (@force or not File.exist? @ri_dir)
 
-    document 'darkfish', options, @rdoc_dir if
+    document 'aliki', options, @rdoc_dir if
       @generate_rdoc and (@force or not File.exist? @rdoc_dir)
   end