mirror of
https://github.com/Homebrew/brew.git
synced 2025-07-14 16:09:03 +08:00
31d7bcc583
- At the AGM we formed an ad-hoc documentation working group. - One of our ideas was that we should have a last reviewed date for documentation, so that we can periodically implement a review mechanism (GitHub Actions posts to Slack for a regular documentation outdatedness check?) to track how old docs are and ensure they're still relevant. - This is a first step towards that goal, by adding a `last_review_date` to the metadata of all docs with a date of earlier than Homebrew's inception because everything needs reviewing so that we start from a good base!
22 lines
534 B
Markdown
22 lines
534 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 to <http://localhost:4000>, run:
|
|
|
|
```bash
|
|
cd `brew --repository`/docs
|
|
bundle install
|
|
bundle exec jekyll serve --watch
|
|
```
|