brew/docs
Sam Ford 1c0e657edb
docs: update redirecting url
A php.net URL in `docs/Versions.md` is redirecting to www.php.net, so
this updates the URL to avoid the redirection.
2024-11-24 10:46:37 -05:00
..
assets/img/docs
governance Remove broken opavote links 2024-07-02 20:44:51 -04:00
vale-styles/Homebrew Lint Ruby docs. 2024-05-01 11:35:21 +02: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
.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 Acceptable-Casks: remove outdated info 2024-11-12 12:35:31 -08:00
Acceptable-Formulae.md
Adding-Software-to-Homebrew.md Add --force to tap instructions 2024-05-19 14:01:29 +02:00
Analytics.md analytics: support command and test-bot analytics. 2024-04-25 17:38:04 +01:00
Bottles.md
Brew-Livecheck.md docs: Update find-appcast command 2024-08-02 14:48:03 -06:00
BrewTestBot-For-Maintainers.md
BrewTestBot.md
Building-Against-Non-Homebrew-Dependencies.md
C++-Standard-Libraries.md docs: remove references to deprecated/disabled GCC formulae 2024-09-02 12:03:06 -04:00
Cask-Cookbook.md Cask-Cookbook: update verified example 2024-09-25 17:52:31 -07:00
Checksum_Deprecation.md
CNAME
Common-Issues-for-Core-Contributors.md
Common-Issues.md Speed up brew list 2024-05-17 12:38:16 +09:00
Creating-a-Homebrew-Issue.md
Custom-GCC-and-cross-compilers.md docs: remove references to deprecated/disabled GCC formulae 2024-09-02 12:03:06 -04:00
Deprecating-Disabling-and-Removing-Casks.md
Deprecating-Disabling-and-Removing-Formulae.md
docs_rubocop_style.yml Fix/reenable brew style docs 2024-06-13 12:31:47 +01:00
External-Commands.md docs: fix brew style 2024-06-12 19:17:17 +01:00
FAQ.md Add --force to tap instructions 2024-05-19 14:01:29 +02:00
Formula-Cookbook.md Use @@HOMEBREW_PREFIX@@ for replacements in external patches 2024-10-23 16:51:01 +01:00
Gemfile docs: brew style --fix 2024-06-13 09:55:31 +01:00
Gems,-Eggs-and-Perl-Modules.md docs/Gems,-Eggs-and-Perl-Modules: fix typo. 2024-06-26 18:29:18 +10:00
Homebrew-and-Java.md
Homebrew-and-Python.md fix header + anchor 2024-08-01 10:10:32 -04:00
Homebrew-brew-Maintainer-Guide.md docs: clarify pull request review guidelines. 2024-04-10 13:52:18 +01:00
Homebrew-Governance-Archives.md
Homebrew-Governance.md Homebrew-Governance: Our 501(c)3 is empty 2024-06-17 13:56:10 +01:00
Homebrew-homebrew-cask-Maintainer-Guide.md docs: update for Homebrew/cask-fonts deprecation 2024-05-16 09:21:14 -07:00
Homebrew-homebrew-core-Maintainer-Guide.md docs: update info as linux-only labels are automerged 2024-04-06 12:33:17 -04:00
Homebrew-Leadership-Responsibilities.md
Homebrew-on-Linux.md doc: improve clarity by removing redundant phrasing in instructions 2024-10-22 21:36:59 -07:00
How-to-Build-Software-Outside-Homebrew-with-Homebrew-keg-only-Dependencies.md
How-to-Create-and-Maintain-a-Tap.md Use repository consistently instead of repo 2024-06-10 09:31:53 +01:00
How-To-Open-a-Homebrew-Pull-Request.md Update How-To-Open-a-Homebrew-Pull-Request.md 2024-08-29 18:45:10 -05:00
How-To-Organize-AGM.md Lint Ruby docs. 2024-05-01 11:35:21 +02:00
index.md docs: rename README.md to index.md 2024-05-13 14:09:44 -04:00
Installation.md Update docs/Installation.md 2024-11-12 12:51:28 -08:00
Interesting-Taps-and-Forks.md
Kickstarter-Supporters.md
License-Guidelines.md docs/License-Guidelines: update URL to SPDX license expr docs 2024-09-06 19:44:51 +08:00
Linux-CI.md Drop Ubuntu 18.04 devcontainer 2024-09-24 08:35:58 +01:00
Maintainer-Guidelines.md docs/Maintainer-Guidelines: tweak auto-merging. 2024-07-26 17:39:40 +01:00
Maintainers-Avoiding-Burnout.md
Manpage.md Update manpage and completions. 2024-11-11 11:02:52 +00:00
Migrating-A-Formula-To-A-Tap.md
New-Maintainer-Checklist.md docs: clarify pull request review guidelines. 2024-04-10 13:52:18 +01:00
Node-for-Formula-Authors.md docs: update with std_npm_args 2024-08-03 20:28:39 -07:00
Prose-Style-Guidelines.md Prose-Style-Guidelines: use Economist pdf link 2024-10-24 10:54:22 -07:00
Python-for-Formula-Authors.md docs(Python): reapply suggestions and update outdated info 2024-04-14 21:42:25 -04:00
Querying-Brew.md
Rakefile docs: brew style --fix 2024-06-13 09:55:31 +01:00
README.md docs: add webrick gem, generation info 2024-05-13 14:13:07 -04:00
Releases.md
Rename-A-Formula.md
Reproducible-Builds.md
robots.txt
Shell-Completion.md docs/Shell-Completion: update Zsh completions docs for Linux 2024-10-15 03:20:50 +08:00
Taps.md Lint Ruby docs. 2024-05-01 11:35:21 +02:00
Tips-N'-Tricks.md docs: remove references to deprecated/disabled GCC formulae 2024-09-02 12:03:06 -04:00
Troubleshooting.md
Typechecking.md Migrate Parlour extensions to Tapioca compilers 2024-10-14 19:50:09 -07:00
Updating-Software-in-Homebrew.md
Versions.md docs: update redirecting url 2024-11-24 10:46:37 -05:00
Xcode.md

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

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