Skip to content

Commit 9cf066d

Browse files
Ignore brew symlink
1 parent 73ab67b commit 9cf066d

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[Homebrew RubyDoc](https://rubydoc.brew.sh) is an online Ruby documentation browser for [Homebrew/brew](https://github.com/Homebrew/brew).
44

5-
A [GitHub Action](https://github.com/Homebrew/rubydoc.brew.sh/blob/main/.github/workflows/scheduled.yml) is run periodically, which deploys the site to GitHub Pages.
5+
A [GitHub Action](https://github.com/Homebrew/rubydoc.brew.sh/blob/main/.github/workflows/scheduled.yml) is run periodically which generates documentation using [YARD](https://yardoc.org/) and deploys the site to GitHub Pages.
66

77
## Usage
88

@@ -22,7 +22,7 @@ bundle exec jekyll serve
2222
To regenerate the RubyDoc on each request to <http://localhost:8808>, run:
2323

2424
```bash
25-
cd `brew --repo`/Library/Homebrew
25+
cd $(brew --repo)/Library/Homebrew
2626
yard server --reload
2727
```
2828

_config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ include:
22
- _index.html
33

44
exclude:
5+
- brew
56
- CNAME
67
- Gemfile*
78
- LICENSE.txt

0 commit comments

Comments
 (0)