Skip to content

Commit

Permalink
Mention community-maintained themes
Browse files Browse the repository at this point in the history
  • Loading branch information
st0012 committed Oct 31, 2024
1 parent 7fb0e50 commit f2d84f3
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.rdoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit f2d84f3

Please sign in to comment.