-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #17289 from EricFromCanada/docs-index
docs: add local build instructions
- Loading branch information
Showing
3 changed files
with
90 additions
and
72 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,4 +6,5 @@ group :test do | |
| gem "html-proofer" | ||
| gem "mdl" | ||
| gem "rake" | ||
| gem "webrick" | ||
| end | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,78 +1,17 @@ | ||
| # Documentation | ||
| # Homebrew Docs | ||
|
|
||
| ## Users | ||
| These are the source files for the [Homebrew documentation site](https://docs.brew.sh/). | ||
|
|
||
| - [`brew` manual page (command documentation)](Manpage.md) | ||
| - [Homebrew Blog (news on major updates)](https://brew.sh/blog/) | ||
| - [Installation](Installation.md) | ||
| - [Troubleshooting](Troubleshooting.md) | ||
| - [FAQ (Frequently Asked Questions)](FAQ.md) | ||
| - [Common Issues](Common-Issues.md) | ||
| - [`brew` Shell Completion](Shell-Completion.md) | ||
| - [Homebrew on Linux](Homebrew-on-Linux.md) | ||
| 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. | ||
|
|
||
| - [Bottles (binary packages)](Bottles.md) | ||
| - [Taps (third-party repositories)](Taps.md) | ||
| - [Interesting Taps and Forks](Interesting-Taps-and-Forks.md) | ||
| - [Tips and Tricks](Tips-N'-Tricks.md) | ||
| - [Anonymous Analytics](Analytics.md) | ||
| ## Usage | ||
|
|
||
| - [Querying `brew`](Querying-Brew.md) | ||
| - [C++ Standard Libraries](C++-Standard-Libraries.md) | ||
| - [MD5 and SHA-1 Deprecation](Checksum_Deprecation.md) | ||
| - [Custom GCC and Cross Compilers](Custom-GCC-and-cross-compilers.md) | ||
| - [External Commands](External-Commands.md) | ||
| - [Ruby Gems, Python Eggs and Perl Modules](Gems,-Eggs-and-Perl-Modules.md) | ||
| - [Python](Homebrew-and-Python.md) | ||
| - [How to Build Software Outside Homebrew with Homebrew `keg_only` Dependencies](How-to-Build-Software-Outside-Homebrew-with-Homebrew-keg-only-Dependencies.md) | ||
| - [Xcode](Xcode.md) | ||
| Open <https://docs.brew.sh> in your web browser. | ||
|
|
||
| - [Creating a Homebrew Issue](Creating-a-Homebrew-Issue.md) | ||
| - [Updating Software in Homebrew](Updating-Software-in-Homebrew.md) | ||
| - [Adding Software to Homebrew](Adding-Software-to-Homebrew.md) | ||
| To instead generate the site locally to <http://localhost:4000>, run: | ||
|
|
||
| - [Kickstarter Supporters](Kickstarter-Supporters.md) | ||
|
|
||
| ## Contributors | ||
|
|
||
| - [How to Open a Pull Request (and get it merged)](How-To-Open-a-Homebrew-Pull-Request.md) | ||
| - [Formula Cookbook](Formula-Cookbook.md) | ||
| - [Cask Cookbook](Cask-Cookbook.md) | ||
| - [Acceptable Formulae](Acceptable-Formulae.md) | ||
| - [Acceptable Casks](Acceptable-Casks.md) | ||
| - [License Guidelines](License-Guidelines.md) | ||
| - [Formulae Versions](Versions.md) | ||
| - [Deprecating, Disabling and Removing Formulae](Deprecating-Disabling-and-Removing-Formulae.md) | ||
| - [Node for Formula Authors](Node-for-Formula-Authors.md) | ||
| - [Python for Formula Authors](Python-for-Formula-Authors.md) | ||
| - [`brew livecheck`](Brew-Livecheck.md) | ||
| - [Migrating a Formula to a Tap](Migrating-A-Formula-To-A-Tap.md) | ||
| - [Renaming a Formula](Rename-A-Formula.md) | ||
| - [Building Against Non-Homebrew Dependencies](Building-Against-Non-Homebrew-Dependencies.md) | ||
| - [How to Create and Maintain a Tap](How-to-Create-and-Maintain-a-Tap.md) | ||
| - [BrewTestBot](BrewTestBot.md) | ||
| - [Prose Style Guidelines](Prose-Style-Guidelines.md) | ||
| - [Type Checking with Sorbet](Typechecking.md) | ||
| - [Reproducible Builds](Reproducible-Builds.md) | ||
|
|
||
| - [Ruby API Documentation](https://rubydoc.brew.sh) (e.g. for `Formula` etc.) | ||
|
|
||
| ## Maintainers | ||
|
|
||
| - [New Maintainer Checklist](New-Maintainer-Checklist.md) | ||
| - [Maintainers: Avoiding Burnout](Maintainers-Avoiding-Burnout.md) | ||
|
|
||
| - [Maintainer Guidelines](Maintainer-Guidelines.md) | ||
| - [Homebrew/brew Maintainer Guide](Homebrew-brew-Maintainer-Guide.md) | ||
| - [Homebrew/homebrew-core Maintainer Guide](Homebrew-homebrew-core-Maintainer-Guide.md) | ||
| - [Homebrew/homebrew-cask Maintainer Guide](Homebrew-homebrew-cask-Maintainer-Guide.md) | ||
|
|
||
| - [BrewTestBot for Maintainers](BrewTestBot-For-Maintainers.md) | ||
| - [Common Issues for Maintainers](Common-Issues-for-Core-Contributors.md) | ||
| - [Releases](Releases.md) | ||
|
|
||
| ## Governance | ||
|
|
||
| - [Homebrew Governance](Homebrew-Governance.md) | ||
| - [Homebrew Leadership Responsibilities](Homebrew-Leadership-Responsibilities.md) | ||
| - [Homebrew Governance Archives](Homebrew-Governance-Archives.md) | ||
| ```bash | ||
| cd `brew --repository`/docs | ||
| bundle install | ||
| bundle exec jekyll serve --watch | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| # Documentation | ||
|
|
||
| ## Users | ||
|
|
||
| - [`brew` manual page (command documentation)](Manpage.md) | ||
| - [Homebrew Blog (news on major updates)](https://brew.sh/blog/) | ||
| - [Installation](Installation.md) | ||
| - [Troubleshooting](Troubleshooting.md) | ||
| - [FAQ (Frequently Asked Questions)](FAQ.md) | ||
| - [Common Issues](Common-Issues.md) | ||
| - [`brew` Shell Completion](Shell-Completion.md) | ||
| - [Homebrew on Linux](Homebrew-on-Linux.md) | ||
|
|
||
| - [Bottles (binary packages)](Bottles.md) | ||
| - [Taps (third-party repositories)](Taps.md) | ||
| - [Interesting Taps and Forks](Interesting-Taps-and-Forks.md) | ||
| - [Tips and Tricks](Tips-N'-Tricks.md) | ||
| - [Anonymous Analytics](Analytics.md) | ||
|
|
||
| - [Querying `brew`](Querying-Brew.md) | ||
| - [C++ Standard Libraries](C++-Standard-Libraries.md) | ||
| - [MD5 and SHA-1 Deprecation](Checksum_Deprecation.md) | ||
| - [Custom GCC and Cross Compilers](Custom-GCC-and-cross-compilers.md) | ||
| - [External Commands](External-Commands.md) | ||
| - [Ruby Gems, Python Eggs and Perl Modules](Gems,-Eggs-and-Perl-Modules.md) | ||
| - [Python](Homebrew-and-Python.md) | ||
| - [How to Build Software Outside Homebrew with Homebrew `keg_only` Dependencies](How-to-Build-Software-Outside-Homebrew-with-Homebrew-keg-only-Dependencies.md) | ||
| - [Xcode](Xcode.md) | ||
|
|
||
| - [Creating a Homebrew Issue](Creating-a-Homebrew-Issue.md) | ||
| - [Updating Software in Homebrew](Updating-Software-in-Homebrew.md) | ||
| - [Adding Software to Homebrew](Adding-Software-to-Homebrew.md) | ||
|
|
||
| - [Kickstarter Supporters](Kickstarter-Supporters.md) | ||
|
|
||
| ## Contributors | ||
|
|
||
| - [How to Open a Pull Request (and get it merged)](How-To-Open-a-Homebrew-Pull-Request.md) | ||
| - [Formula Cookbook](Formula-Cookbook.md) | ||
| - [Cask Cookbook](Cask-Cookbook.md) | ||
| - [Acceptable Formulae](Acceptable-Formulae.md) | ||
| - [Acceptable Casks](Acceptable-Casks.md) | ||
| - [License Guidelines](License-Guidelines.md) | ||
| - [Formulae Versions](Versions.md) | ||
| - [Deprecating, Disabling and Removing Formulae](Deprecating-Disabling-and-Removing-Formulae.md) | ||
| - [Node for Formula Authors](Node-for-Formula-Authors.md) | ||
| - [Python for Formula Authors](Python-for-Formula-Authors.md) | ||
| - [`brew livecheck`](Brew-Livecheck.md) | ||
| - [Migrating a Formula to a Tap](Migrating-A-Formula-To-A-Tap.md) | ||
| - [Renaming a Formula](Rename-A-Formula.md) | ||
| - [Building Against Non-Homebrew Dependencies](Building-Against-Non-Homebrew-Dependencies.md) | ||
| - [How to Create and Maintain a Tap](How-to-Create-and-Maintain-a-Tap.md) | ||
| - [BrewTestBot](BrewTestBot.md) | ||
| - [Prose Style Guidelines](Prose-Style-Guidelines.md) | ||
| - [Type Checking with Sorbet](Typechecking.md) | ||
| - [Reproducible Builds](Reproducible-Builds.md) | ||
|
|
||
| - [Ruby API Documentation](https://rubydoc.brew.sh) (e.g. for `Formula` etc.) | ||
|
|
||
| ## Maintainers | ||
|
|
||
| - [New Maintainer Checklist](New-Maintainer-Checklist.md) | ||
| - [Maintainers: Avoiding Burnout](Maintainers-Avoiding-Burnout.md) | ||
|
|
||
| - [Maintainer Guidelines](Maintainer-Guidelines.md) | ||
| - [Homebrew/brew Maintainer Guide](Homebrew-brew-Maintainer-Guide.md) | ||
| - [Homebrew/homebrew-core Maintainer Guide](Homebrew-homebrew-core-Maintainer-Guide.md) | ||
| - [Homebrew/homebrew-cask Maintainer Guide](Homebrew-homebrew-cask-Maintainer-Guide.md) | ||
|
|
||
| - [BrewTestBot for Maintainers](BrewTestBot-For-Maintainers.md) | ||
| - [Common Issues for Maintainers](Common-Issues-for-Core-Contributors.md) | ||
| - [Releases](Releases.md) | ||
|
|
||
| ## Governance | ||
|
|
||
| - [Homebrew Governance](Homebrew-Governance.md) | ||
| - [Homebrew Leadership Responsibilities](Homebrew-Leadership-Responsibilities.md) | ||
| - [Homebrew Governance Archives](Homebrew-Governance-Archives.md) |