MikeRogers0 / Yard-Docs

Combine Yard & puma-dev to read ruby gem docs offline

Yard Docs

This combines Yard & puma-dev, so you can read ruby gem documentation offline in your browser.

I wrote this as part of a blog post about yard & thought it might help someone else out.

Setup

Before you start, you will need to have puma-dev setup on your local machine. Next run:

./bin/setup

This will run bundle, build the documentation and link the directory in puma dev.

Now whenever you visit yard-docs.test, it'll return the documentation for all your locally installed gems.

Future Development

I made this to scratch my own itch, so I'd love to hear if it helps anyone else. If anyone is interested I'd love to find a way to add some quick lookup that integrates nicely with Firefox.