mirror of https://github.com/Homebrew/brew.git synced 2025-07-14 16:09:03 +08:00

History

Co-authored-by: Adrian Ho <the.gromgit@gmail.com>

2024-05-16 20:50:13 +03:00

assets/img/docs

Delete ancient 'managing PRs' flowchart

2024-02-05 01:47:55 +01:00

governance

Lint Ruby docs.

2024-05-01 11:35:21 +02: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: add mdl for Markdown linting

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

.mdl_style.rb

CI: add docs.yml

2022-11-26 10:28:12 -05:00

.mdlrc

docs: add mdl for Markdown linting

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

.rubocop.yml

Turn off FormulaAudit/{Desc,Homepage} for docs

2024-02-02 15:37:01 +00:00

Acceptable-Casks.md

docs: update for Homebrew/cask-versions deprecation

2024-05-02 14:40:07 -07:00

Acceptable-Formulae.md

Update docs/Acceptable-Formulae.md

2024-03-01 15:36:25 -08:00

Adding-Software-to-Homebrew.md

docs: update examples of good commit summaries

2024-04-09 22:10:15 -04:00

Analytics.md

analytics: support command and test-bot analytics.

2024-04-25 17:38:04 +01:00

Bottles.md

docs: redirect from old BrewTestBot URLs

2024-02-15 14:50:24 -05:00

Brew-Livecheck.md

Crate: Rework conditions

2024-02-11 21:53:21 -05:00

BrewTestBot-For-Maintainers.md

docs: redirect from old BrewTestBot URLs

2024-02-15 14:50:24 -05:00

BrewTestBot.md

docs: redirect from old BrewTestBot URLs

2024-02-15 14:50:24 -05:00

Building-Against-Non-Homebrew-Dependencies.md

docs: talk about custom Requirements

2020-09-09 19:21:22 +10:00

C++-Standard-Libraries.md

Update deprecations

2019-01-08 19:13:46 +00:00

Cask-Cookbook.md

docs linting

2024-05-03 23:02:37 +10:00

Checksum_Deprecation.md

docs+rubydoc: various grammar/wording fixes

2023-09-11 02:26:37 -04:00

CNAME

Cleanup documentation site

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

Common-Issues-for-Core-Contributors.md

docs+rubydoc: various grammar/wording fixes

2023-09-11 02:26:37 -04:00

Common-Issues.md

docs: Common-Issues: eliminate unnecessary list reference

2024-02-16 11:04:55 -05:00

Creating-a-Homebrew-Issue.md

Docs: Add guides for common cases

2020-02-25 21:43:03 +01:00

Custom-GCC-and-cross-compilers.md

docs: update wording for rest of Users section

2022-02-11 09:25:39 -05:00

Deprecating-Disabling-and-Removing-Casks.md

docs/Deprecating-Disabling-and-Removing-Casks.md: add cask deprecate/disable reasons

2024-02-25 19:58:35 +11:00

Deprecating-Disabling-and-Removing-Formulae.md

Update docs/Deprecating-Disabling-and-Removing-Formulae.md

2024-02-14 19:17:24 +00:00

External-Commands.md

Lint Ruby docs.

2024-05-01 11:35:21 +02:00

FAQ.md

docs+rubydoc: various grammar/wording fixes

2023-09-11 02:26:37 -04:00

Formula-Cookbook.md

Lint Ruby docs.

2024-05-01 11:35:21 +02:00

Gemfile

docs: add webrick gem, generation info

2024-05-13 14:13:07 -04:00

Gems,-Eggs-and-Perl-Modules.md

docs: remove some system Python notes

2024-03-10 11:34:19 -04:00

Homebrew-and-Java.md

Update Homebrew discussion links

2022-04-05 08:31:40 +01:00

Homebrew-and-Python.md

docs: remove some system Python notes

2024-03-10 11:34:19 -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

CI: add docs.yml

2022-11-26 10:28:12 -05:00

Homebrew-Governance.md

docs/Homebrew-Governance: clarify emergency text.

2024-03-07 10:52:45 +00:00

Homebrew-homebrew-cask-Maintainer-Guide.md

docs: update for Homebrew/cask-versions deprecation

2024-05-02 14:40:07 -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-Leadership-Responsibilities: import changes.

2022-12-08 09:30:41 +00:00

Homebrew-on-Linux.md

Update Homebrew-on-Linux.md

2024-05-16 20:50:13 +03:00

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

docs: fix up more brew --prefix usage.

2023-02-21 08:57:12 +00:00

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

docs: hyperlink updates

2022-12-06 12:52:03 -05:00

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

docs: update language on commit messages & notability

2024-03-01 11:05:08 -08: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

docs/Installation: Use the documented --strip-components tar argument

2024-05-10 08:39:17 -07:00

Interesting-Taps-and-Forks.md

homebrew/autoupdate is no longer official.

2024-03-05 10:30:17 +00:00

Kickstarter-Supporters.md

docs: update wording for rest of Users section

2022-02-11 09:25:39 -05:00

License-Guidelines.md

Fix RuboCop Layout/ group offenses in docs example code

2024-01-24 00:01:42 +00:00

Linux-CI.md

docker: stop building Ubuntu 16.04 image.

2023-03-24 08:57:48 +00:00

Maintainer-Guidelines.md

docs: update for Homebrew/cask-versions deprecation

2024-05-02 14:40:07 -07:00

Maintainers-Avoiding-Burnout.md

docs: various tweaks.

2023-12-06 14:29:09 -05:00

Manpage.md

Add HOMEBREW_ARTIFACT_DOMAIN_NO_FALLBACK

2024-05-14 21:45:37 +09:00

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

Contributors docs: content & formatting updates

2022-11-16 09:03:12 -05:00

New-Maintainer-Checklist.md

docs: clarify pull request review guidelines.

2024-04-10 13:52:18 +01:00

Node-for-Formula-Authors.md

Update example formula descriptions

2024-01-29 22:43:36 +00:00

Prose-Style-Guidelines.md

Contributors docs: adjust line breaks

2022-11-16 09:03:12 -05: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

docs: drop example that requires --eval-all

2024-01-26 08:17:44 -08:00

Rakefile

docs/Rakefile: fix broken link.

2023-09-13 09:00:37 +01:00

README.md

docs: add webrick gem, generation info

2024-05-13 14:13:07 -04:00

Releases.md

Maintainers docs: content & formatting updates

2022-12-06 12:52:03 -05:00

Rename-A-Formula.md

Contributors docs: content & formatting updates

2022-11-16 09:03:12 -05:00

Reproducible-Builds.md

docs: update formula and cask URLs to new sharded format

2023-08-26 14:54:19 +01:00

robots.txt

docs: Add sitemap.xml, robots.txt.

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

Shell-Completion.md

fix(docs): update fish completions command

2023-10-28 18:14:04 -07:00

Taps.md

Lint Ruby docs.

2024-05-01 11:35:21 +02:00

Tips-N'-Tricks.md

Apply suggestions from code review

2023-10-10 12:00:50 -05:00

Troubleshooting.md

docs: various additions & changes

2023-09-05 01:06:31 -04:00

Typechecking.md

Fix Sorbet/ group offenses in docs example code

2024-01-24 00:01:41 +00:00

Updating-Software-in-Homebrew.md

docs: hyperlink updates

2022-12-06 12:52:03 -05:00

Versions.md

Update Acceptable/Deprecating/Forks/Versions docs

2024-02-13 10:13:44 +00:00

Xcode.md

docs: update wording for rest of Users section

2022-02-11 09:25:39 -05:00

README.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