1 min read

Gem Documentation

Read gem documentation locally
Gem Documentation
Photo by Patrick Tomasso / Unsplash

Read your gem documentation locally with yard.

Firstly, add a couple of gems to your system:

gem install webrick 
gem install yard

Generate the rdoc documentation for all gems. This step is really quick but you'll need to redo this step if you add more gems, via Bundler for example.

gem rdoc --all --no-ri

Then you need to fire up your yard server:

yard server --gems

Then you can point your brower at localhost:8808 and walk through the docs locally.