admin/brew

History

How-to-Create-and-Maintain-a-Tap: improve docs.

We don't really tell people actually how to create a tap here so let's
provide more commands and output to help them.

While we're here, also fix some bad references to `repo` that weren't
updated when they should have been and let VSCode autoformat the
Markdown.

2025-09-05 17:42:34 +01:00

assets/img/docs

…

bin

docs: improve/fix jekyll setup

2025-04-25 09:46:29 +01:00

governance

Switch to using main as the default branch

2025-06-24 11:14:57 +01:00

vale-styles/Homebrew

docs: edit various URLs

2025-08-16 23:33:38 -04:00

_config.yml

Use SVG logo in header

2024-03-31 21:46:25 +02:00

.mdl_ruleset.rb

docs: localize internal URLs

2025-05-22 12:17:52 -04:00

.mdl_style.rb

docs: brew style --fix

2024-06-13 09:55:31 +01:00

.mdlrc

…

.rubocop.yml

Fix RuboCop failures.

2025-07-14 19:12:38 +01:00

.ruby-version

Further Portable Ruby cleanup

2024-06-14 12:22:02 +01:00

Acceptable-Casks.md

docs: edit various URLs

2025-08-16 23:33:38 -04:00

Acceptable-Formulae.md

Switch to using main as the default branch

2025-06-24 11:14:57 +01:00

Adding-Software-to-Homebrew.md

Remove unused cask url do code

2025-08-23 15:02:23 -04:00

Analytics.md

Add a last_reviewed_date to docs metadata

2025-02-03 11:56:07 +00:00

Autobump.md

docs: edit various URLs

2025-08-16 23:33:38 -04:00

Bottles.md

Add a last_reviewed_date to docs metadata

2025-02-03 11:56:07 +00:00

Brew-Bundle-and-Brewfile.md

Switch to using main as the default branch

2025-06-24 11:14:57 +01:00

Brew-Livecheck.md

docs: suggestions from code review

2025-06-25 15:30:06 +02:00

Brewfile

docs: improve/fix jekyll setup

2025-04-25 09:46:29 +01: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

Remove unused cask url do code

2025-08-23 15:02:23 -04:00

Checksum_Deprecation.md

Add a last_reviewed_date to docs metadata

2025-02-03 11:56:07 +00:00

CNAME

…

Common-Issues-for-Core-Contributors.md

Switch to using main as the default branch

2025-06-24 11:14:57 +01:00

Common-Issues.md

docs: edit various URLs

2025-08-16 23:33:38 -04:00

Creating-a-Homebrew-Issue.md

docs/Tips-and-Tricks: rename from weird filename.

2025-04-25 09:46:29 +01: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

cask: replace unsigned deprecation reason with fails_gatekeeper_check

2025-08-18 18:04:57 +10:00

Deprecating-Disabling-and-Removing-Formulae.md

docs: mention signing in deprecation criteria

2025-08-06 10:29:59 -04: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

docs: edit various URLs

2025-08-16 23:33:38 -04:00

Formula-Cookbook.md

Formula-Cookbook: document stable path variables

2025-08-19 09:04:12 -04:00

Gemfile

docs: improve/fix jekyll setup

2025-04-25 09:46:29 +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: localize internal URLs

2025-05-22 12:17:52 -04:00

Homebrew-brew-Maintainer-Guide.md

docs: edit various URLs

2025-08-16 23:33:38 -04: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

Switch to using main as the default branch

2025-06-24 11:14:57 +01:00

Homebrew-homebrew-core-Maintainer-Guide.md

docs: edit various URLs

2025-08-16 23:33:38 -04:00

Homebrew-Leadership-Responsibilities.md

Switch to using main as the default branch

2025-06-24 11:14:57 +01:00

Homebrew-on-Linux.md

docs: edit various URLs

2025-08-16 23:33:38 -04: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

How-to-Create-and-Maintain-a-Tap: improve docs.

2025-09-05 17:42:34 +01:00

How-To-Open-a-Homebrew-Pull-Request.md

docs: homebrew-core's default branch is now main

2025-06-25 08:49:58 +01:00

How-To-Organize-AGM.md

docs: edit various URLs

2025-08-16 23:33:38 -04:00

index.md

docs: edit various URLs

2025-08-16 23:33:38 -04:00

Installation.md

docs: edit various URLs

2025-08-16 23:33:38 -04: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

Update Linux GCC code.

2025-04-03 12:47:21 +01: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

Remove docs saying that installing from a file is allowed

2025-09-05 10:58:33 +02:00

MCP-Server.md

remove trailing newline

2025-08-29 22:08:32 -07:00

Migrating-A-Formula-To-A-Tap.md

Review some docs

2025-02-08 14:43:49 +00:00

New-Maintainer-Checklist.md

Switch to using main as the default branch

2025-06-24 11:14:57 +01:00

Node-for-Formula-Authors.md

Switch to using main as the default branch

2025-06-24 11:14:57 +01:00

Prose-Style-Guidelines.md

docs: localize internal URLs

2025-05-22 12:17:52 -04:00

Python-for-Formula-Authors.md

docs: edit various URLs

2025-08-16 23:33:38 -04:00

Querying-Brew.md

docs: edit various URLs

2025-08-16 23:33:38 -04:00

Rakefile

docs: fix HTML Proofer in CI

2025-06-27 08:09:24 +01:00

README.md

Switch to using main as the default branch

2025-06-24 11:14:57 +01:00

Releases.md

Switch to using main as the default branch

2025-06-24 11:14:57 +01:00

Rename-A-Formula.md

Add a last_reviewed_date to docs metadata

2025-02-03 11:56:07 +00:00

Reproducible-Builds.md

docs: edit various URLs

2025-08-16 23:33:38 -04:00

robots.txt

…

Shell-Completion.md

Formula-Cookbook: document stable path variables

2025-08-19 09:04:12 -04:00

Support-Tiers.md

Support Tiers: document future macOS support

2025-08-19 08:19:28 +01:00

Taps.md

Remove the sentence referencing --force-auto-update

2025-05-04 23:49:02 -04:00

Tips-and-Tricks.md

Add docs for brew alias command

2025-07-15 13:34:49 -04:00

Troubleshooting.md

docs: edit various URLs

2025-08-16 23:33:38 -04:00

Typechecking.md

Switch to using main as the default branch

2025-06-24 11:14:57 +01: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