29 Commits

Author SHA1 Message Date
Markus Reiter
480e264d9a
Lint Ruby docs. 2024-05-01 11:35:21 +02:00
Mike McQuaid
e9b668df35
docs/External-Commands: fix spelling.
Co-authored-by: Kevin <apainintheneck@gmail.com>
2024-04-24 08:40:00 +01:00
Douglas Eichelberger
5772ba12b4 Update External-Commands docs for new command abstraction 2024-04-23 14:53:22 -07:00
apainintheneck
2030f07132 Fix markdown linter errors
v0.13 of the `markdownlint` gem just got released and it has
a few new rules which are docs ended up failing. This fixes
those linter errors so that CI is no longer red.

Rules:
MD055 - Tables: Each row must start and end with a '|'
MD057 - Tables: In the second row every column must have at least '---',
        possibly surrounded with alignment ':' chars
2023-10-02 22:42:39 -07:00
EricFromCanada
9cc4766d33
docs: hyperlink updates
plus some reformatting
2022-12-06 12:52:03 -05:00
EricFromCanada
3855103617
docs: update wording for rest of Users section 2022-02-11 09:25:39 -05:00
EricFromCanada
77efcdf8fb
Add & remove line breaks 2021-12-02 22:58:31 -05:00
Mike McQuaid
0a8167d2dc
docs: update /usr/local references.
Update or remove these based on our latest state.
2021-07-14 10:11:27 +01:00
Rylan Polster
4bf4d3e26e
docs: update external command usage string instructions 2021-01-18 12:10:18 -05:00
Rylan Polster
6d3d88d33e
Apply suggestions from code review
Co-authored-by: Eric Knibbe <enk3@outlook.com>
2021-01-15 10:11:27 -05:00
Rylan Polster
617a2ea0a7 docs: update external command documentation 2021-01-14 20:34:46 -05:00
Jonathan Chang
6f924b08ae docs: livecheck is now internal command 2020-09-09 19:21:10 +10:00
Mike McQuaid
ac0665daff
Refer to default branch in links with HEAD
Anywhere we can use `blob/master` we can use `blob/HEAD` instead. This
will make life easier if we ever rename our default branch in future
(once/if Git and GitHub provides the necessary tooling to do so).
2020-06-25 11:38:40 +01:00
Clay Jensen-Reimann
fa7183726e
Fix typo, suggest python 2019-04-01 15:53:39 -05:00
Clay Jensen-Reimann
bd593aace2
Clarify naming of external command files
It was not clear (to me, at least) that non-ruby external commands should not contain a file suffix. Homebrew will ignore a file `cmd/brew-extcmd.sh` instead of printing a warning or registering it as `brew extcmd.sh`
2019-04-01 09:55:12 -05:00
EricFromCanada
31dbc4f985 Various documentation edits
Mostly edits to formatting, grammar, wording for consistency & readability.
2018-10-05 17:23:22 -04:00
Mike McQuaid
c1376f9f18
docs: various updates.
I read through the docs locally and made various fixes.
2018-09-06 15:07:00 +01:00
Mike McQuaid
190e665bb1 Revert "docs: use short links."
This reverts commit e63a2ee8de12f0f938f6a95cdb9763dbe0187b4a.

Closes #3832.
2018-02-23 19:52:00 +00:00
Mike McQuaid
e63a2ee8de docs: use short links. 2018-02-22 19:25:44 +00:00
Darío Hereñú
d4a9ffee2f
Minor proposal 2018-01-27 20:20:45 -03:00
David C Hall
8fc559f319 Update docs: homebrew/livecheck 2017-10-13 09:47:39 -04:00
Mike McQuaid
fabc5bc893 External Commands: document how --help works. 2017-04-02 17:38:31 +01:00
EricFromCanada
dc7f74210a docs: code example reformatting
Add labeled fences to most code blocks, monospace terms where
appropriate, omit "$" when referring to variables
2017-03-25 22:53:33 -04:00
EricFromCanada
ab4d1a1574 docs: grammar edits, sentence-case secondary headings
Also changes some heading levels so only one primary
heading appears per page.
2017-03-19 14:03:39 -04:00
EricFromCanada
20bb0aae80 Fix broken or inactive URLs
Bare URLs are auto-linked on GitHub but not on docs.brew.sh, so I added
angle brackets around them where appropriate. Also converted
Markdown-linked URLs for clarity.
2017-02-23 12:09:01 -05:00
Jonathan Chang
9a6cd9b83f docs: fix titles on docs.brew.sh 2017-01-04 16:16:00 -06:00
Mike McQuaid
127e9def50 Cleanup documentation site
GitHub now nicely generates a documentation site for us at
http://brew.sh/brew based on our docs folder. Optimise the output of
this and the GitHub docs directory for readability and the various user
groupings.
2017-01-04 10:53:21 +00:00
Mike McQuaid
b85ee1cb8f Update documentation links. 2016-09-20 10:41:42 +01:00
Mike McQuaid
bd6fb88ddc Rearrange repository files. 2016-09-20 10:41:42 +01:00