mirrors/brew
1
0
Fork 0
mirror of https://github.com/Homebrew/brew.git synced 2025-07-14 16:09:03 +08:00
Code Issues Packages Projects Releases Wiki Activity
brew/docs
History
Mike McQuaid dea26d02b7
Import documentation for brew bundle 
This was in the (soon to be archived) Homebrew/homebrew-bundle
repository's `README`. There's some good content here that doesn't
cleanly fit into the `brew` manpage so let's move it here.

While we're here, let's de-emphasize `whalebrew` as it's not
widely used and add commented-out deprecation warnings for its future
deprecation.
2025-03-19 10:53:00 +00:00
..
assets/img/docs
Delete ancient 'managing PRs' flowchart
2024-02-05 01:47:55 +01:00
governance
docs/governance/2021-agm-minutes.md: fix broken link
2025-02-13 10:56:14 +11:00
vale-styles/Homebrew
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
_config.yml
Use SVG logo in header
2024-03-31 21:46:25 +02:00
.mdl_ruleset.rb
docs: brew style --fix
2024-06-13 09:55:31 +01:00
.mdl_style.rb
docs: brew style --fix
2024-06-13 09:55:31 +01:00
.mdlrc
docs: add mdl for Markdown linting
2021-12-02 22:58:31 -05:00
.rubocop.yml
rubocop: Use Sorbet/StrictSigil as it's better than comments
2024-08-12 15:24:27 +01:00
.ruby-version
Further Portable Ruby cleanup
2024-06-14 12:22:02 +01:00
Acceptable-Casks.md
docs: prefer /opt/homebrew in examples
2025-02-03 15:30:03 +01:00
Acceptable-Formulae.md
docs: prefer /opt/homebrew in examples
2025-02-03 15:30:03 +01:00
Adding-Software-to-Homebrew.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
Analytics.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
Bottles.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
Brew-Bundle-and-Brewfile.md
Import documentation for brew bundle
2025-03-19 10:53:00 +00:00
Brew-Livecheck.md
livecheck: restrict POST hashes to symbol keys
2025-02-21 21:54:46 -05:00
BrewTestBot-For-Maintainers.md
fixup! Update docs/BrewTestBot-For-Maintainers.md
2025-02-03 17:42:50 +01:00
BrewTestBot.md
Review some docs
2025-02-08 14:43:49 +00:00
Building-Against-Non-Homebrew-Dependencies.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
C++-Standard-Libraries.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
Cask-Cookbook.md
docs: prefer /opt/homebrew in examples
2025-02-03 15:30:03 +01:00
Checksum_Deprecation.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
CNAME
Cleanup documentation site
2017-01-04 10:53:21 +00:00
Common-Issues-for-Core-Contributors.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
Common-Issues.md
docs/Common-Issues: fix style.
2025-03-18 08:43:51 +00:00
Creating-a-Homebrew-Issue.md
Review some docs
2025-02-08 14:43:49 +00:00
Custom-GCC-and-cross-compilers.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
Deprecating-Disabling-and-Removing-Casks.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
Deprecating-Disabling-and-Removing-Formulae.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
docs_rubocop_style.yml
Fix/reenable brew style docs
2024-06-13 12:31:47 +01:00
External-Commands.md
Cleanup and fix homebrew-services migration
2025-03-13 15:22:01 +00:00
FAQ.md
Review some docs
2025-02-08 14:43:49 +00:00
Formula-Cookbook.md
Migrate Homebrew/bundle to Homebrew/brew
2025-03-19 06:47:01 +00:00
Gemfile
docs: brew style --fix
2024-06-13 09:55:31 +01:00
Gems,-Eggs-and-Perl-Modules.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
Homebrew-and-Java.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
Homebrew-and-Python.md
docs: prefer /opt/homebrew in examples
2025-02-03 15:30:03 +01:00
Homebrew-brew-Maintainer-Guide.md
Review some docs
2025-02-08 14:43:49 +00:00
Homebrew-Governance-Archives.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
Homebrew-Governance.md
docs/Homebrew-Governance.md: fix broken link
2025-02-13 10:56:13 +11:00
Homebrew-homebrew-cask-Maintainer-Guide.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
Homebrew-homebrew-core-Maintainer-Guide.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
Homebrew-Leadership-Responsibilities.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
Homebrew-on-Linux.md
Merge pull request #19200 from Homebrew/docs-last-reviewed-date
2025-02-03 13:33:52 +00:00
How-to-Build-Software-Outside-Homebrew-with-Homebrew-keg-only-Dependencies.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
How-to-Create-and-Maintain-a-Tap.md
Import brew alias and brew unalias commands
2025-02-07 14:31:50 +00:00
How-To-Open-a-Homebrew-Pull-Request.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
How-To-Organize-AGM.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
index.md
Import documentation for brew bundle
2025-03-19 10:53:00 +00:00
Installation.md
Fix typo in Installation.md
2025-03-14 13:25:21 -05:00
Interesting-Taps-and-Forks.md
Review some docs
2025-02-08 14:43:49 +00:00
Kickstarter-Supporters.md
Review some docs
2025-02-08 14:43:49 +00:00
License-Guidelines.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
Linux-CI.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
Maintainer-Guidelines.md
Review some docs
2025-02-08 14:43:49 +00:00
Maintainers-Avoiding-Burnout.md
Review some docs
2025-02-08 14:43:49 +00:00
Manpage.md
Update manpage and completions.
2025-03-19 07:11:41 +00:00
Migrating-A-Formula-To-A-Tap.md
Review some docs
2025-02-08 14:43:49 +00:00
New-Maintainer-Checklist.md
Review some docs
2025-02-08 14:43:49 +00:00
Node-for-Formula-Authors.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
Prose-Style-Guidelines.md
Review some docs
2025-02-08 14:43:49 +00:00
Python-for-Formula-Authors.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
Querying-Brew.md
Review some docs
2025-02-08 14:43:49 +00:00
Rakefile
Enforce that all docs have last_review_date frontmatter
2025-02-08 00:14:10 +00:00
README.md
Unlink localhost:4000 - it doesn't need to be a link
2025-02-03 13:23:20 +00:00
Releases.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
Rename-A-Formula.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
Reproducible-Builds.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
robots.txt
docs: Add sitemap.xml, robots.txt.
2017-07-02 15:09:26 +01:00
Shell-Completion.md
Add PowerShell (pwsh) completion support
2025-03-02 18:17:38 -08:00
Taps.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
Tips-N'-Tricks.md
Recommend abbreviated multi-platform loader
2025-02-19 11:58:07 -05:00
Troubleshooting.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
Typechecking.md
Review some docs
2025-02-08 14:43:49 +00:00
Updating-Software-in-Homebrew.md
Review some docs
2025-02-08 14:43:49 +00:00
Versions.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00
Xcode.md
Add a last_reviewed_date to docs metadata
2025-02-03 11:56:07 +00:00

README.md

last_review_date
last_review_date
1970-01-01

Homebrew Docs

These are the source files for the Homebrew documentation site.

A GitHub Action 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:

cd `brew --repository`/docs
bundle install
bundle exec jekyll serve --watch