README.md

Homebrew RubyDoc

Homebrew RubyDoc is an online Ruby documentation browser for Homebrew/brew.

A GitHub Action is run periodically, which deploys the site to GitHub Pages.

Usage

Open https://rubydoc.brew.sh in your web browser.

To instead run Homebrew RubyDoc locally at http://localhost:4000, run:

git clone https://github.com/Homebrew/rubydoc.brew.sh
cd rubydoc.brew.sh
bundle install
ln -s $(brew --repo) brew
bundle exec rake yard
bundle exec jekyll serve --source docs

To regenerate the RubyDoc on each request to http://localhost:8808, run:

cd `brew --repo`/Library/Homebrew
yard server --reload

License

Code is under the BSD 2-clause "Simplified" License.