mirror of https://github.com/Homebrew/brew.git synced 2026-08-12 22:29:27 +04:00

Files

T

Mike McQuaidandGitHub c658f23932 Apply suggestions from code review

Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>

2026-07-13 08:21:23 +01:00

_layouts

base.html: update to match main configuration

2026-06-10 09:29:09 +00:00

assets/img/docs

docs: drop advice to disable security or lower support tier

2026-06-15 16:41:01 +01:00

bin

Remove docs remote theme usage

2026-06-08 11:59:00 +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

Remove docs remote theme usage

2026-06-08 11:59:00 +01: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

docs: add mdl for Markdown linting

2021-12-02 22:58:31 -05:00

.rubocop.yml

brew style --fix --todo

2026-03-06 16:02:29 +00:00

.ruby-version

Further Portable Ruby cleanup

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

Acceptable-Casks.md

docs: drop advice to disable security or lower support tier

2026-06-15 16:41:01 +01:00

Acceptable-Formulae.md

docs: clarify upstream expectations

2026-04-26 12:39:01 +01:00

Adding-Software-to-Homebrew.md

Align cask macOS dependencies

2026-05-08 15:51:19 +01:00

AGENTS.md

Add software supply chain security docs

2026-06-11 09:51:48 +01:00

Analytics.md

Add a last_reviewed_date to docs metadata

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

Autobump.md

Change RubyDoc links

2025-10-15 17:39:14 +01:00

Bottles.md

Homebrew 4.7.0 deprecations/disables/removals

2025-11-05 14:46:12 +00:00

Brew-Bundle-and-Brewfile.md

Add source option to brew bundle uv tools

2026-07-06 09:47:17 +03:00

Brew-Livecheck.md

Change RubyDoc links

2025-10-15 17:39:14 +01:00

Brewfile

docs/Brewfile: use unversioned Ruby formula

2026-03-23 19:11:33 -07:00

BrewTestBot-For-Maintainers.md

Remove docs remote theme usage

2026-06-08 11:59:00 +01:00

BrewTestBot.md

Remove docs remote theme usage

2026-06-08 11:59:00 +01: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

docs: fix link to "C++ Standard Libraries" page

2026-04-28 21:59:04 +08:00

Cask-Cookbook.md

Add cask permission steps

2026-07-10 19:38:48 +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

Command-Not-Found.md

Update docs

2025-09-19 12:07:54 -04:00

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

Preserve cask quarantine approval

2026-07-11 16:11:35 +01: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.md

Deprecating-Disabling-and-Removing: improve cask requirements.

2026-04-08 19:10:36 +01:00

docs_rubocop_style.yml

Fix/reenable brew style docs

2024-06-13 12:31:47 +01:00

Expense-and-Reimbursement-Policy.md

Fix broken links and governance references.

2025-12-02 12:35:09 +00:00

External-Commands.md

Use HEAD ref

2026-03-24 22:31:24 +01:00

FAQ.md

Rename Homebrew security docs page

2026-06-21 13:56:57 +01:00

Formula-Cookbook.md

docs: remove references to removed setup_install_args

2026-07-10 18:59:32 -07:00

Gemfile

Remove docs remote theme usage

2026-06-08 11:59:00 +01:00

Gemfile.lock

build(deps): bump the bundler group across 2 directories with 6 updates

2026-07-10 08:09:24 +00: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: remove references to removed setup_install_args

2026-07-10 18:59:32 -07:00

Homebrew-brew-Maintainer-Guide.md

Approve stale lead maintainer PRs

2026-06-22 09:20:47 +01:00

Homebrew-Governance-Archives.md

Add a last_reviewed_date to docs metadata

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

Homebrew-Governance.md

Homebrew-Governance: bump last review date.

2026-01-18 14:14:52 +01:00

Homebrew-homebrew-cask-Maintainer-Guide.md

docs: clarify upstream expectations

2026-04-26 12:39:01 +01:00

Homebrew-homebrew-core-Maintainer-Guide.md

docs: escape braces to avoid Liquid tag handling

2026-07-09 01:05:15 -04:00

Homebrew-Leadership-Responsibilities.md

Overhaul Homebrew governance

2025-12-01 11:28:18 -08:00

Homebrew-on-Linux.md

Clarify Linux build tools installation instructions

2026-07-02 13:40:25 -07:00

Homebrew-Security-and-Supply-Chain.md

Apply suggestions from code review

2026-07-13 08:21:23 +01:00

How-to-Build-Software-Outside-Homebrew-with-Homebrew-keg-only-Dependencies.md

Support CPS metadata dirs

2026-05-13 16:31:32 +01:00

How-to-Create-and-Maintain-a-Tap.md

Secure tap bottle publishing

2026-06-19 17:23:15 +01:00

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

Add Responsible AI Usage documentation

2026-06-11 09:23:57 +01:00

How-To-Organise-the-AGM.md

Fix broken links and governance references.

2025-12-02 12:35:09 +00:00

index.md

Rename Homebrew security docs page

2026-06-21 13:56:57 +01:00

index.mdl_style.rb

docs: improve docs.

2026-06-08 20:35:04 +01:00

Installation.md

Preserve cask quarantine approval

2026-07-11 16:11:35 +01:00

Interesting-Taps-and-Forks.md

Rename Homebrew security docs page

2026-06-21 13:56:57 +01: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

Migrate to Ubuntu 24.04

2026-05-09 08:58:42 -04:00

Maintainer-Guidelines.md

Approve stale lead maintainer PRs

2026-06-22 09:20:47 +01:00

Maintainer-Stipends-and-Grants.md

Fix broken links and governance references.

2025-12-02 12:35:09 +00:00

Maintainers-Avoiding-Burnout.md

Review some docs

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

Manpage.md

Regenerate man page and completions for new switch

2026-07-12 21:01:07 +01:00

MCP-Server.md

docs: document developer update channel and MCP tools

2026-04-10 15:54:13 +01:00

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

Review some docs

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

New-Maintainer-Checklist.md

Add Responsible AI Usage documentation

2026-06-11 09:23:57 +01:00

Node-for-Formula-Authors.md

docs: recommend using libexec.glob for symlinking

2025-12-24 20:57:08 +09:00

Prose-Style-Guidelines.md

docs: localize internal URLs

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

Python-for-Formula-Authors.md

docs: remove references to removed setup_install_args

2026-07-10 18:59:32 -07:00

Querying-Brew.md

docs: edit various URLs

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

Rakefile

docs/Rakefile: ignore PyPi.

2026-06-11 09:49:09 +01:00

README.md

docs: improve docs.

2026-06-08 20:35:04 +01:00

Releases.md

docs: consolidate deprecation policy

2026-04-08 14:22:37 +01:00

Rename-A-Formula.md

Update docs/Rename-A-Formula.md

2025-11-13 20:34:00 -05:00

Reproducible-Builds.md

docs: edit various URLs

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

Responsible-AI-Usage.md

Add Responsible AI Usage documentation

2026-06-11 09:23:57 +01:00

robots.txt

docs: Add sitemap.xml, robots.txt.

2017-07-02 15:09:26 +01:00

Shell-Completion.md

Formula-Cookbook: document stable path variables

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

Support-Tiers.md

Migrate to Ubuntu 24.04

2026-05-09 08:58:42 -04:00

Tap-Trust.md

Apply suggestion from @bevanjkay

2026-07-04 13:02:01 +01:00

Taps.md

docs/Taps: fix capitalization of "Homebrew"

2026-04-28 22:07:26 +08:00

Tips-and-Tricks.md

Add brew exec formulae environments

2026-05-14 08:49:50 +01:00

Troubleshooting.md

docs: edit various URLs

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

Typechecking.md

Remove RuboCop TODO suppressions

2026-05-22 14:40:12 +01:00

Updating-Software-in-Homebrew.md

Review some docs

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

Versions.md

Support pinning casks

2026-05-15 16:33:37 +01:00

Working-with-Homebrew-as-an-Upstream-Project.md

docs: clarify upstream expectations

2026-04-26 12:39:01 +01: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
2026-06-08

Homebrew Documentation

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 http://localhost:4000, run:

cd $(brew --repository)/docs
brew bundle --install exec -- bundle install
bin/jekyll serve