|
1 | | -# Documentation |
| 1 | +# Homebrew Docs |
2 | 2 |
|
3 | | -## Users |
| 3 | +These are the source files for the [Homebrew documentation site](https://docs.brew.sh/). |
4 | 4 |
|
5 | | -- [`brew` manual page (command documentation)](Manpage.md) |
6 | | -- [Homebrew Blog (news on major updates)](https://brew.sh/blog/) |
7 | | -- [Installation](Installation.md) |
8 | | -- [Troubleshooting](Troubleshooting.md) |
9 | | -- [FAQ (Frequently Asked Questions)](FAQ.md) |
10 | | -- [Common Issues](Common-Issues.md) |
11 | | -- [`brew` Shell Completion](Shell-Completion.md) |
12 | | -- [Homebrew on Linux](Homebrew-on-Linux.md) |
| 5 | +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. |
13 | 6 |
|
14 | | -- [Bottles (binary packages)](Bottles.md) |
15 | | -- [Taps (third-party repositories)](Taps.md) |
16 | | -- [Interesting Taps and Forks](Interesting-Taps-and-Forks.md) |
17 | | -- [Tips and Tricks](Tips-N'-Tricks.md) |
18 | | -- [Anonymous Analytics](Analytics.md) |
| 7 | +## Usage |
19 | 8 |
|
20 | | -- [Querying `brew`](Querying-Brew.md) |
21 | | -- [C++ Standard Libraries](C++-Standard-Libraries.md) |
22 | | -- [MD5 and SHA-1 Deprecation](Checksum_Deprecation.md) |
23 | | -- [Custom GCC and Cross Compilers](Custom-GCC-and-cross-compilers.md) |
24 | | -- [External Commands](External-Commands.md) |
25 | | -- [Ruby Gems, Python Eggs and Perl Modules](Gems,-Eggs-and-Perl-Modules.md) |
26 | | -- [Python](Homebrew-and-Python.md) |
27 | | -- [How to Build Software Outside Homebrew with Homebrew `keg_only` Dependencies](How-to-Build-Software-Outside-Homebrew-with-Homebrew-keg-only-Dependencies.md) |
28 | | -- [Xcode](Xcode.md) |
| 9 | +Open <https://docs.brew.sh> in your web browser. |
29 | 10 |
|
30 | | -- [Creating a Homebrew Issue](Creating-a-Homebrew-Issue.md) |
31 | | -- [Updating Software in Homebrew](Updating-Software-in-Homebrew.md) |
32 | | -- [Adding Software to Homebrew](Adding-Software-to-Homebrew.md) |
| 11 | +To instead generate the site locally to <http://localhost:4000>, run: |
33 | 12 |
|
34 | | -- [Kickstarter Supporters](Kickstarter-Supporters.md) |
35 | | - |
36 | | -## Contributors |
37 | | - |
38 | | -- [How to Open a Pull Request (and get it merged)](How-To-Open-a-Homebrew-Pull-Request.md) |
39 | | -- [Formula Cookbook](Formula-Cookbook.md) |
40 | | -- [Cask Cookbook](Cask-Cookbook.md) |
41 | | -- [Acceptable Formulae](Acceptable-Formulae.md) |
42 | | -- [Acceptable Casks](Acceptable-Casks.md) |
43 | | -- [License Guidelines](License-Guidelines.md) |
44 | | -- [Formulae Versions](Versions.md) |
45 | | -- [Deprecating, Disabling and Removing Formulae](Deprecating-Disabling-and-Removing-Formulae.md) |
46 | | -- [Node for Formula Authors](Node-for-Formula-Authors.md) |
47 | | -- [Python for Formula Authors](Python-for-Formula-Authors.md) |
48 | | -- [`brew livecheck`](Brew-Livecheck.md) |
49 | | -- [Migrating a Formula to a Tap](Migrating-A-Formula-To-A-Tap.md) |
50 | | -- [Renaming a Formula](Rename-A-Formula.md) |
51 | | -- [Building Against Non-Homebrew Dependencies](Building-Against-Non-Homebrew-Dependencies.md) |
52 | | -- [How to Create and Maintain a Tap](How-to-Create-and-Maintain-a-Tap.md) |
53 | | -- [BrewTestBot](BrewTestBot.md) |
54 | | -- [Prose Style Guidelines](Prose-Style-Guidelines.md) |
55 | | -- [Type Checking with Sorbet](Typechecking.md) |
56 | | -- [Reproducible Builds](Reproducible-Builds.md) |
57 | | - |
58 | | -- [Ruby API Documentation](https://rubydoc.brew.sh) (e.g. for `Formula` etc.) |
59 | | - |
60 | | -## Maintainers |
61 | | - |
62 | | -- [New Maintainer Checklist](New-Maintainer-Checklist.md) |
63 | | -- [Maintainers: Avoiding Burnout](Maintainers-Avoiding-Burnout.md) |
64 | | - |
65 | | -- [Maintainer Guidelines](Maintainer-Guidelines.md) |
66 | | -- [Homebrew/brew Maintainer Guide](Homebrew-brew-Maintainer-Guide.md) |
67 | | -- [Homebrew/homebrew-core Maintainer Guide](Homebrew-homebrew-core-Maintainer-Guide.md) |
68 | | -- [Homebrew/homebrew-cask Maintainer Guide](Homebrew-homebrew-cask-Maintainer-Guide.md) |
69 | | - |
70 | | -- [BrewTestBot for Maintainers](BrewTestBot-For-Maintainers.md) |
71 | | -- [Common Issues for Maintainers](Common-Issues-for-Core-Contributors.md) |
72 | | -- [Releases](Releases.md) |
73 | | - |
74 | | -## Governance |
75 | | - |
76 | | -- [Homebrew Governance](Homebrew-Governance.md) |
77 | | -- [Homebrew Leadership Responsibilities](Homebrew-Leadership-Responsibilities.md) |
78 | | -- [Homebrew Governance Archives](Homebrew-Governance-Archives.md) |
| 13 | +```bash |
| 14 | +cd `brew --repository`/docs |
| 15 | +bundle install |
| 16 | +bundle exec jekyll serve --watch |
| 17 | +``` |
0 commit comments