Merge pull request #3826 from MikeMcQuaid/docs-updates

docs.brew.sh updates

7 files changed, 65 insertions, 38 deletions

diff --git a/docs/.well-known/acme-challenge/CgQNmjNTd6fUriinp4XpuRI5PBGp7zEXbEEsQceSD0k b/docs/.well-known/acme-challenge/CgQNmjNTd6fUriinp4XpuRI5PBGp7zEXbEEsQceSD0k
deleted file mode 100644
index d3ba42ff4..000000000
--- 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 01ab4e806..a3a31ce80 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 c4db9e9f8..1f2b2e89e 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/ <what-you-called-your-branch>
 ```
 
-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 e4f189490..91f9e0414 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 <https://docs.brew.sh/Analytics.html>.
+    Read more at <https://docs.brew.sh/Analytics>.
 
   * `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:
-    <https://docs.brew.sh/Querying-Brew.html>
+    <https://docs.brew.sh/Querying-Brew>
 
   * `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:
-    <https://docs.brew.sh/Querying-Brew.html>
+    <https://docs.brew.sh/Querying-Brew>
 
   * `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:
-<https://docs.brew.sh/External-Commands.html>
+<https://docs.brew.sh/External-Commands>
 
 ## 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: <https://docs.brew.sh/Analytics.html>
+    If set, Homebrew will not send analytics. See: <https://docs.brew.sh/Analytics>
 
   * `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 72abf2ddb..cb4919d69 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 210d0b0d4..d535e7bd3 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 ee631bda5..422e98bed 100644
--- a/docs/_layouts/base.html
+++ b/docs/_layouts/base.html
@@ -1,21 +1,29 @@
+{% assign t = site.data.locales[page.lang][page.lang] %}
 <!DOCTYPE html>
 <html {% if page.direction == "rtl" %}dir="rtl" {% endif %}lang="{{ page.lang }}">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     {% if page.title %}
-    <title>{{ page.title }} — Homebrew</title>
-    {% elsif page.direction == "rtl" %}
-    <title>{{ page.subtitle }} — Homebrew</title>
+    <title>{{ page.title }} — {{ site.title }}</title>
+    {% elsif t.subtitle %}
+    {% if page.direction == "rtl" %}
+    <title>{{ site.title }} — {{ t.subtitle }}</title>
     {% else %}
-    <title>Homebrew — {{ page.subtitle }}</title>
+    <title>{{ t.subtitle }} — {{ t.subtitle }}</title>
+    {% endif %}
+    {% else %}
+    <title>{{ site.title }}</title>
     {% endif %}
     {% seo title=false %}
     {% feed_meta %}
     <meta name="viewport" content="width=device-width">
     <link rel="icon" type="image/x-icon" href="/img/favicon.ico">
-    <link rel="apple-touch-icon"href="/img/apple-touch-icon.png">
+    <link rel="apple-touch-icon" href="/img/apple-touch-icon.png">
     <link rel="stylesheet" href="/css/screen.css" type="text/css" media="screen">
     <link rel="stylesheet" href="/css/pygments.css" type="text/css" media="screen">
+    {% if site.url == "http://localhost:4000" %}
+    <script src="https://github.com/Khan/tota11y/releases/download/0.1.3/tota11y.min.js"></script>
+    {% endif %}
     <script>
       (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
       (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
@@ -27,31 +35,37 @@
       ga('send', 'pageview');
 
     </script>
-    {% 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" %}
       <link rel="alternate" hreflang="en" href="{{ site.url }}" />
       <link rel="alternate" hreflang="x-default" href="{{ site.url }}" />
       {% else %}
-      <link rel="alternate" hreflang="{{ lang.langcode }}" href="{{ lang.langcode | downcase | append: '.html' | prepend: '/index_' | prepend: site.url }}" />
+      <link rel="alternate" hreflang="{{ lang }}" href="{{ lang | prepend: '/index_' | prepend: site.url }}" />
       {% endif %}
     {% endfor %}
+    {% endif %}
   </head>
   <body>
     <div id="wrap">
       <div id="header" class="{{ page.header-class }}">
         <img alt="Homebrew logo" src="/img/homebrew-256x256.png" width="128" height="128">
         <h1><a href="/">Homebrew</a></h1>
-        {% if page.subtitle %}
-        <p id="subtitle"><strong>{{ page.subtitle }}</strong></p>
+        {% if t.subtitle %}
+        <p id="subtitle"><strong>{{ t.subtitle }}</strong></p>
         {% endif %}
 
         {% if page.lang %}
         <select id="language" onchange="loadLanguage(this.options[this.selectedIndex].value)">
-          {% for lang in site.langs %}
-            {% if page.lang == lang.langcode %}
-            <option value="{{ lang.langcode | downcase }}" selected="selected">{{ lang.lang_string }}</option>
+          {% for locale in locales %}
+            {% assign lang = locale[0] %}
+            {% assign locale_name = locale[1][lang].locale_name %}
+            {% if page.lang == lang %}
+            <option value="{{ lang }}" selected="selected">{{ locale_name }}</option>
             {% else %}
-            <option value="{{ lang.langcode | downcase }}">{{ lang.lang_string }}</option>
+            <option value="{{ lang }}">{{ locale_name }}</option>
             {% endif %}
           {% endfor %}
         </select>
@@ -80,9 +94,9 @@
         if (lang === {{ page.lang | jsonify }}) {
             return;
         } else if (lang === "en") {
-            window.location.replace("/");
+            window.location.assign("/");
         } else {
-            window.location.replace("/index_" + lang + ".html");
+            window.location.assign("/index_" + lang);
         }
       }
     </script>