diff --git a/docs/.well-known/acme-challenge/CgQNmjNTd6fUriinp4XpuRI5PBGp7zEXbEEsQceSD0k b/docs/.well-known/acme-challenge/CgQNmjNTd6fUriinp4XpuRI5PBGp7zEXbEEsQceSD0k deleted file mode 100644 index d3ba42ff4b..0000000000 --- a/docs/.well-known/acme-challenge/CgQNmjNTd6fUriinp4XpuRI5PBGp7zEXbEEsQceSD0k +++ /dev/null @@ -1 +0,0 @@ -CgQNmjNTd6fUriinp4XpuRI5PBGp7zEXbEEsQceSD0k.unNjkXuFqjKx4BO8gem4nzeMm1tSZxPPeBjNqQhFCqQ diff --git a/docs/Common-Issues.md b/docs/Common-Issues.md index 01ab4e8065..a3a31ce80b 100644 --- a/docs/Common-Issues.md +++ b/docs/Common-Issues.md @@ -80,7 +80,7 @@ When running `brew upgrade`, you see something like this: $ brew upgrade Error: undefined method `include?' for nil:NilClass Please report this bug: - https://docs.brew.sh/Troubleshooting.html + https://docs.brew.sh/Troubleshooting /usr/local/Library/Homebrew/formula.rb:393:in `canonical_name' /usr/local/Library/Homebrew/formula.rb:425:in `factory' /usr/local/Library/Contributions/examples/brew-upgrade.rb:7 diff --git a/docs/Formula-Cookbook.md b/docs/Formula-Cookbook.md index c4db9e9f8b..1f2b2e89e2 100644 --- a/docs/Formula-Cookbook.md +++ b/docs/Formula-Cookbook.md @@ -344,7 +344,7 @@ If you have already forked Homebrew on GitHub, then you can manually push (just git push https://github.com/myname/homebrew-core/ ``` -Now, [open a pull request](https://docs.brew.sh/How-To-Open-a-Homebrew-Pull-Request.html) for your changes. +Now, [open a pull request](https://docs.brew.sh/How-To-Open-a-Homebrew-Pull-Request) for your changes. * One formula per commit; one commit per formula * Keep merge commits out of the pull request diff --git a/docs/Manpage.md b/docs/Manpage.md index e4f189490b..91f9e0414d 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -39,7 +39,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note * `analytics` [`state`]: Display anonymous user behaviour analytics state. - Read more at . + Read more at . * `analytics` (`on`|`off`): Turn on/off Homebrew's analytics. @@ -212,7 +212,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note information on all installed formulae. See the docs for examples of using the JSON output: - + * `install` [`--debug`] [`--env=`(`std`|`super`)] [`--ignore-dependencies`|`--only-dependencies`] [`--cc=``compiler`] [`--build-from-source`|`--force-bottle`] [`--devel`|`--HEAD`] [`--keep-tmp`] [`--build-bottle`] [`--force`] [`--verbose`] `formula` [`options` ...]: Install `formula`. @@ -493,7 +493,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note Pass `--installed` to get information on installed taps. See the docs for examples of using the JSON output: - + * `tap-pin` `tap`: Pin `tap`, prioritizing its formulae over core when formula names are supplied @@ -914,7 +914,7 @@ scripts that reside somewhere in the `PATH`, named `brew-``cmdname` or to create your own commands without modifying Homebrew's internals. Instructions for creating your own commands can be found in the docs: - + ## SPECIFYING FORMULAE @@ -1031,7 +1031,7 @@ can take several different forms: *Default:* the number of available CPU cores. * `HOMEBREW_NO_ANALYTICS`: - If set, Homebrew will not send analytics. See: + If set, Homebrew will not send analytics. See: * `HOMEBREW_NO_AUTO_UPDATE`: If set, Homebrew will not auto-update before running `brew install`, diff --git a/docs/New-Maintainer-Checklist.md b/docs/New-Maintainer-Checklist.md index 72abf2ddb8..cb4919d697 100644 --- a/docs/New-Maintainer-Checklist.md +++ b/docs/New-Maintainer-Checklist.md @@ -39,8 +39,8 @@ A few requests: own fork. - if still in doubt please ask for help and we'll help you out - please read: - - https://docs.brew.sh/Brew-Test-Bot-For-Core-Contributors.html - - https://docs.brew.sh/Maintainer-Guidelines.html + - https://docs.brew.sh/Brew-Test-Bot-For-Core-Contributors + - https://docs.brew.sh/Maintainer-Guidelines - anything else you haven't read on https://docs.brew.sh How does that sound? diff --git a/docs/_config.yml b/docs/_config.yml index 210d0b0d40..d535e7bd39 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,17 +1,31 @@ -include: [.well-known] -exclude: [bin, vendor, CNAME, Gemfile, Gemfile.lock] +title: Homebrew Documentation +description: Documentation for the missing package manager for macOS. -# Same as GitHub Pages -# https://help.github.com/articles/using-jekyll-with-pages#troubleshooting -# Disable despite enabled on GitHub Pages for supported plugins to work. -# safe: true -kramdown: - input: GFM - hard_wrap: false -lsi: false -highlighter: rouge +exclude: + - bin + - CNAME + - Gemfile* + - README.md + - vendor -gems: +plugins: - jekyll-feed - jekyll-sitemap - jekyll-seo-tag + +defaults: + - scope: + path: "" + values: + image: /img/homebrew-256x256.png + +logo: /img/homebrew-256x256.png + +github: + repository_nwo: Homebrew/brew + +twitter: + username: MacHomebrew + +facebook: + publisher: https://www.facebook.com/machomebrew/ diff --git a/docs/_layouts/base.html b/docs/_layouts/base.html index ee631bda54..422e98bed8 100644 --- a/docs/_layouts/base.html +++ b/docs/_layouts/base.html @@ -1,21 +1,29 @@ +{% assign t = site.data.locales[page.lang][page.lang] %} {% if page.title %} - {{ page.title }} — Homebrew - {% elsif page.direction == "rtl" %} - {{ page.subtitle }} — Homebrew + {{ page.title }} — {{ site.title }} + {% elsif t.subtitle %} + {% if page.direction == "rtl" %} + {{ site.title }} — {{ t.subtitle }} {% else %} - Homebrew — {{ page.subtitle }} + {{ t.subtitle }} — {{ t.subtitle }} + {% endif %} + {% else %} + {{ site.title }} {% endif %} {% seo title=false %} {% feed_meta %} - + + {% if site.url == "http://localhost:4000" %} + + {% endif %} - {% for lang in site.langs %} - {% if lang.langcode == "en" %} + {% if site.data.locales %} + {% assign locales = site.data.locales | sort %} + {% for locale in locales %} + {% assign lang = locale[0] %} + {% if lang == "en" %} {% else %} - + {% endif %} {% endfor %} + {% endif %}