Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
antoinem authored and alexisbernard committed Oct 14, 2024
1 parent c6fd922 commit 5a58724
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,27 @@
# RorVsWild theme for RDoc
# RoRvsWild theme for RDoc

[RDoc](https://github.com/ruby/rdoc) theme based on [RoRvsWild](https://www.rorvswild.com/) colors.
More than colors, it modifies the layout, navigation, typography and overall look and feel.

![RoRvsWild theme RDoc Light](https://cdn.rorvswild.com/assets/blog/2024/rdoc_new-ad5d5ed01e18b11607278cdf97899209dfac8a752b2f0413e83b859b90f48009.png)

![RoRvsWild theme RDoc Dark](https://cdn.rorvswild.com/assets/blog/2024/rdoc_new_dark-06b332002ea3c7df9aafd2a5081fd901d0ca02450b4a002fda08acb4395b29e6.png)

## Usage

If you want to use this theme in your documentation:
```
# Install the gem
gem install rorvswild_theme_rdoc
rdoc --root path/source/code --template=rorvswild
# Generate the documentation
rdoc --root path/to/source/code --template=rorvswild
```

## Development

Call the custom `rdoc.rb` script which automatically loads RorVsWild'd theme.
Call the custom `rdoc.rb` script which automatically loads RoRvsWild's theme.

```
./rdoc.rb --root path/source/code --template rorvswild
./rdoc.rb --root path/to/source/code --template rorvswild
```

0 comments on commit 5a58724

Please sign in to comment.