This project is a fork of the Homebrew.git project. If you have that one
already cloned locally, you can use
git clone --reference /path/to/your/Homebrew.git/incarnation mirror_URLto save bandwidth during cloning.
| description | An online Ruby documentation browser for Homebrew/brew |
| homepage URL | https://rubydoc.brew.sh/ |
| repository URL | https://github.com/Homebrew/rubydoc.brew.sh.git |
| owner | root@yurikoles.com |
| last change | Tue, 4 Feb 2025 08:45:08 +0000 (4 09:45 +0100) |
| last refresh | Fri, 7 Feb 2025 22:54:06 +0000 (7 23:54 +0100) |
| mirror URL | git://repo.or.cz/Homebrew/rubydoc.brew.sh.git |
| https://repo.or.cz/Homebrew/rubydoc.brew.sh.git | |
| ssh://git@repo.or.cz/Homebrew/rubydoc.brew.sh.git | |
| bundle info | rubydoc.brew.sh.git downloadable bundles |
| content tags |
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.
| 3 days ago | master | logtree |