From f2d84f3024861aa2692c07d34642660cf00ed5d5 Mon Sep 17 00:00:00 2001
From: Stan Lo <stan.lo@shopify.com>
Date: Thu, 31 Oct 2024 13:04:19 +0000
Subject: [PATCH] Mention community-maintained themes

---
 README.rdoc | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/README.rdoc b/README.rdoc
index 5a698edc88..68be7b0b1b 100644
--- a/README.rdoc
+++ b/README.rdoc
@@ -110,6 +110,33 @@ To determine how well your project is documented run <tt>rdoc -C lib</tt> to
 get a documentation coverage report.  <tt>rdoc -C1 lib</tt> includes parameter
 names in the documentation coverage report.
 
+== Theme Options
+
+There are 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])
+
+To use a theme:
+
+- Add the theme to your Gemfile:
+
+    # Use require: false or put it in an appropriate group so it's not loaded by default
+    gem 'theme-gem-name', require: false
+
+- Configure \RDoc to use the theme by either:
+
+  - Setting the +--format+ option in your +.rdoc_options+ file:
+
+      --format=theme-name
+
+  - Setting the +generator+ option in your RDoc::Task:
+
+      RDoc::Task.new do |rdoc|
+        rdoc.generator = 'theme-name'
+      end
+
+
 == Bugs
 
 See CONTRIBUTING@Bugs for information on filing a bug report.  It's OK to file