brew/docs/README.md

22 lines
536 B
Markdown

---
last_review_date: "1970-01-01"
---
# 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, available on localhost:4000, run:
```bash
cd `brew --repository`/docs
bundle install
bundle exec jekyll serve --watch
```