shen/brew
1
0
Fork 0
mirror of https://github.com/Homebrew/brew.git synced 2024-11-25 16:33:34 +08:00
Code Issues Actions 11 Packages Projects Releases Wiki Activity

docs: add webrick gem, generation info

Browse Source
This commit is contained in:
Eric Knibbe 2024-05-13 14:13:07 -04:00
parent 7fa82cccf3
commit e1f8b622ff
No known key found for this signature in database
GPG Key ID: 179D9CDDDB814168
2 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/Gemfile
View File

@ -6,4 +6,5 @@ group :test do
gem "html-proofer"
gem "mdl"
gem "rake"
gem "webrick"
end

17
docs/README.md Normal file
View File

@ -0,0 +1,17 @@
# Homebrew Docs
These are the source files for the [Homebrew documentation site](https://docs.brew.sh/).
A [GitHub Action](https://github.com/Homebrew/brew/blob/master/.github/workflows/docs.yml) is run to validate each change before the site is deployed to GitHub Pages.
## Usage
Open <https://docs.brew.sh> in your web browser.
To instead generate the site locally to <http://localhost:4000>, run:
```bash
cd `brew --repository`/docs
bundle install
bundle exec jekyll serve --watch
```