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

Files

T

hyuraku 51c13f17a3 docs/Cask-Cookbook: fix links to renamed casks

The `r` and `wireshark` casks were renamed to `r-app` and
`wireshark-app` in Homebrew/homebrew-cask d20f5f8baba
("Differentiate lesser used casks from formulae"), so the
`on_<system>` example links in this section now 404.

2026-07-27 18:24:04 +09: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

Update package manager slogan

2026-07-26 19:48:28 +01:00

vale-styles/Homebrew

docs: enforce sentence-case headings and codify prose conventions

2026-07-20 13:29:18 -07:00

_config.yml

Update package manager slogan

2026-07-26 19:48:28 +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: implementlists for readability

2026-07-23 10:20:25 +10:00

Acceptable-Formulae.md

docs: implementlists for readability

2026-07-23 10:20:25 +10:00

Adding-Software-to-Homebrew.md

docs/Adding-Software-to-Homebrew: pass the package type to brew style

2026-07-20 10:01:34 -07:00

AGENTS.md

docs: enforce sentence-case headings and codify prose conventions

2026-07-20 13:29:18 -07:00

Analytics.md

Sample only user-set env config in analytics

2026-07-24 19:40:08 +01:00

Autobump.md

Change RubyDoc links

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

Bottles.md

docs: update formula authoring and toolchain references

2026-07-20 09:50:52 -07:00

Brew-Bundle-and-Brewfile.md

docs: update command and integration references

2026-07-18 23:34:31 -07:00

Brew-Livecheck.md

docs: update formula authoring and toolchain references

2026-07-20 09:50:52 -07:00

Brewfile

docs/Brewfile: use unversioned Ruby formula

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

BrewTestBot-For-Maintainers.md

docs: update maintainer operations guides

2026-07-20 11:47:25 -07:00

BrewTestBot.md

docs: update maintainer operations guides

2026-07-20 11:47:25 -07:00

Building-Against-Non-Homebrew-Dependencies.md

docs: update formula authoring and toolchain references

2026-07-20 09:50:52 -07:00

C++-Standard-Libraries.md

docs: update formula authoring and toolchain references

2026-07-20 09:50:52 -07:00

Cask-Cookbook.md

docs/Cask-Cookbook: fix links to renamed casks

2026-07-27 18:24:04 +09:00

Checksum-Requirements.md

docs/Checksum-Requirements: cover casks in the shared requirement

2026-07-18 23:40:26 -07:00

CNAME

Cleanup documentation site

2017-01-04 10:53:21 +00:00

Command-Not-Found.md

docs: update command and integration references

2026-07-18 23:34:31 -07:00

Common-Issues-for-Maintainers.md

docs: update maintainer operations guides

2026-07-20 11:47:25 -07:00

Common-Issues.md

docs: address review comments on troubleshooting pages

2026-07-19 09:00:21 -07: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

docs: update formula authoring and toolchain references

2026-07-20 09:50:52 -07:00

Deprecating-Disabling-and-Removing.md

DeprecateDisable: add formula unreachable reason

2026-07-21 21:37:34 -04:00

docs_rubocop_style.yml

Fix/reenable brew style docs

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

Expense-and-Reimbursement-Policy.md

docs: implementlists for readability

2026-07-23 10:20:25 +10:00

External-Commands.md

docs: update command and integration references

2026-07-18 23:34:31 -07:00

FAQ.md

docs: update FAQ and troubleshooting pages

2026-07-18 23:26:37 -07:00

Formula-Cookbook.md

Merge pull request #23200 from Homebrew/install-step-13-gzipped-executables

2026-07-27 01:00:20 +00: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 15 updates

2026-07-24 13:51:50 -07:00

Homebrew-brew-Maintainer-Guide.md

docs: update maintainer operations guides

2026-07-20 11:47:25 -07:00

Homebrew-Governance-Archives.md

docs: restyle governance and maintainer process pages

2026-07-18 23:34:31 -07:00

Homebrew-Governance.md

docs: implementlists for readability

2026-07-23 10:20:25 +10:00

Homebrew-homebrew-cask-Maintainer-Guide.md

docs: update maintainer operations guides

2026-07-20 11:47:25 -07:00

Homebrew-homebrew-core-Maintainer-Guide.md

docs: implementlists for readability

2026-07-23 10:20:25 +10:00

Homebrew-Leadership-Responsibilities.md

docs: restyle governance and maintainer process pages

2026-07-18 23:34:31 -07:00

Homebrew-on-Linux.md

docs: address review comments on platform pages

2026-07-19 09:01:13 -07:00

Homebrew-Security-and-Supply-Chain.md

docs: update tap trust and supply-chain documentation

2026-07-18 23:26:45 -07:00

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

docs: implementlists for readability

2026-07-23 10:20:25 +10:00

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

docs: update tap trust and supply-chain documentation

2026-07-18 23:26:45 -07:00

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

docs/How-To-Open-a-Homebrew-Pull-Request: avoid core for brew changes

2026-07-20 11:07:08 -07:00

How-To-Organise-the-AGM.md

docs: restyle governance and maintainer process pages

2026-07-18 23:34:31 -07:00

index.md

docs: enforce sentence-case headings and codify prose conventions

2026-07-20 13:29:18 -07:00

index.mdl_style.rb

docs: improve docs.

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

Installation.md

docs: update installation, platform support and shell completion pages

2026-07-18 23:26:37 -07: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

Language-Runtimes-and-Packages.md

docs: implementlists for readability

2026-07-23 10:20:25 +10:00

Language-Specific-Formulae.md

docs: implementlists for readability

2026-07-23 10:20:25 +10:00

Licence-Guidelines.md

docs: rename checksum and licence reference pages

2026-07-18 23:20:51 -07:00

Linux-CI.md

Migrate to Ubuntu 24.04

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

Maintainer-Guidelines.md

Update package manager slogan

2026-07-26 19:48:28 +01:00

Maintainer-Stipends-and-Grants.md

docs/Maintainer-Stipends-and-Grants: clarify hardware contribution cap

2026-07-19 09:02:08 -07:00

Maintainers-Avoiding-Burnout.md

docs: update maintainer operations guides

2026-07-20 11:47:25 -07:00

Manpage.md

Update package manager slogan

2026-07-26 19:48:28 +01:00

MCP-Server.md

docs: update command and integration references

2026-07-18 23:34:31 -07:00

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

Review some docs

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

New-Maintainer-Checklist.md

docs: update maintainer operations guides

2026-07-20 11:47:25 -07:00

Package-Acceptance-Policy.md

docs: adjust minor nit

2026-07-23 08:37:48 +08:00

Prose-Style-Guidelines.md

docs: enforce sentence-case headings and codify prose conventions

2026-07-20 13:29:18 -07:00

Querying-Brew.md

docs: update command and integration references

2026-07-18 23:34:31 -07:00

Rakefile

docs: consolidate language documentation

2026-07-19 13:43:15 -07:00

README.md

docs: improve docs.

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

Releases.md

Block releases on open release blockers

2026-07-24 19:20:36 +01:00

Rename-A-Formula.md

docs: update formula authoring and toolchain references

2026-07-20 09:50:52 -07:00

Reproducible-Builds.md

docs: update formula authoring and toolchain references

2026-07-20 09:50:52 -07: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

docs: address review comments on platform pages

2026-07-19 09:01:13 -07:00

Support-Tiers.md

docs: update installation, platform support and shell completion pages

2026-07-18 23:26:37 -07:00

Tap-Trust.md

docs: update tap trust and supply-chain documentation

2026-07-18 23:26:45 -07:00

Taps.md

docs/Taps: split the trust example into its two alternatives

2026-07-18 23:40:50 -07:00

Tips-and-Tricks.md

docs: update FAQ and troubleshooting pages

2026-07-18 23:26:37 -07:00

Troubleshooting.md

docs: address review comments on troubleshooting pages

2026-07-19 09:00:21 -07:00

Typechecking.md

docs/Typechecking: note that some RBI files are handwritten

2026-07-20 12:40:19 -07:00

Updating-Software-in-Homebrew.md

Review some docs

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

Versions.md

docs: add a shared package acceptance policy

2026-07-19 09:10:44 -07:00

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

docs: clarify upstream expectations

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

Xcode.md

docs: update formula authoring and toolchain references

2026-07-20 09:50:52 -07: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