squidfunk · facelessuser · Aug 2, 2020 · squidfunk · Aug 2, 2020 · squidfunk
Unified Split

Showing 410 changed files with 7,629 additions and 5,347 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -77,30 +77,13 @@ jobs:
         with:
           python-version: ${{ env.PYTHON_VERSION }}
 
-      # - uses: actions/cache@v1
-      #   id: cache-python
-      #   with:
-      #     path: ~/.cache/pip
-      #     key: ${{ runner.os }}-pip-${{ env.PYTHON_VERSION }}-${{ hashFiles('**/requirements.txt') }}
-
-      # - if: steps.cache-python.outputs.cache-hit != 'true'
-      - run: pip install -r requirements.txt
-
-      # Set configuration for repository and deploy documentation
-      - env:
-          GH_TOKEN: ${{ secrets.GH_TOKEN }}
-          GH_NAME: ${{ secrets.GH_NAME }}
-          GH_EMAIL: ${{ secrets.GH_EMAIL }}
-        run: |
-          REMOTE="https://${GH_TOKEN}@github.com/${GITHUB_REPOSITORY}"
-          git config --global user.name "${GH_NAME}"
-          git config --global user.email "${GH_EMAIL}"
-          git remote set-url origin ${REMOTE}
-
       # Install theme and dependencies
       - run: |
+          pip install -r requirements.txt
           pip install .
-          pip install mkdocs-minify-plugin>=0.2
+          pip install \
+            mkdocs-minify-plugin>=0.3 \
+            mkdocs-redirects>=1.0
 
       # Build documentation
       - env:

diff --git a/.stylelintrc b/.stylelintrc
@@ -34,7 +34,7 @@
     "selector-class-pattern": "^[a-z0-9]+(-[a-z0-9]+)*(__[a-z]+)?(--[a-z]+)?$",
     "selector-descendant-combinator-no-non-space": null,
     "string-quotes": "double",
-    "unit-whitelist": ["px", "em", "deg", "ms", "%", "mm", "vh", "dppx"],
+    "unit-whitelist": ["px", "em", "deg", "ms", "%", "mm", "vh", "vw", "dppx"],
     "value-keyword-case": "lower",
     "value-no-vendor-prefix": true
   }

diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,76 @@
+mkdocs-material-5.5.8 (2020-08-23)
+
+  * Removed focus outline on details and content tabs for pointer devices
+  * Improved accessibility of content tabs (now navigable via arrow keys)
+  * Fixed #1877: 404 on search index when search is disabled
+  * Fixed some memleaks in observable subscriptions
+  * Fixed color definitions for theme-color meta tag
+
+mkdocs-material-5.5.7 (2020-08-16)
+
+  * Improved contrast ratio to 4.5:1 for syntax highlighting
+  * Improved contrast ratio to 4.5:1 for table of contents
+
+mkdocs-material-5.5.6 (2020-08-12)
+
+  * Switched base template for 404.html to main.html
+  * Fixed #1864: GitHub organisation stats not loading
+
+mkdocs-material-5.5.5+insiders-1.2.0 (2020-08-11)
+
+  * Added feature to expand navigation by default
+
+mkdocs-material-5.5.5 (2020-08-11)
+
+  * Fixed missing vendor and worker distribution files
+
+mkdocs-material-5.5.4 (2020-08-11)
+
+  * Added support for sortable data tables
+
+mkdocs-material-5.5.3 (2020-08-04)
+
+  * Fixed search for languages other than English (5.5.1 regression)
+
+mkdocs-material-5.5.2+insiders-1.1.0 (2020-08-03)
+
+  * Added highlighting of search results
+
+mkdocs-material-5.5.2 (2020-08-03)
+
+  * Improved highlight colors and spacing for ins, del and mark
+  * Changed some keyboard symbols for better equivalents
+  * Removed focus outline for details and code blocks on touch devices
+  * Fixed margins for Admonitions (5.5.1 regression)
+  * Fixed too small content tab labels (5.5.1 regression)
+  * Fixed icon repeating for custom admonition icons
+
+mkdocs-material-5.5.1 (2020-08-01)
+
+  * Improved typesetting by basing font-size and spacings on em
+  * Improved print view by slightly scaling down font-size
+  * Changed custom site title (metadata) to be suffixed with site name
+  * Fixed top- and bottom spacing of paragraphs inside table cells
+
+mkdocs-material-5.5.0 (2020-07-24)
+
+  * Rewrite of entire documentation
+  * Rewrite of syntax highlighting to be customizable with CSS variables
+  * Improved syntax highlighting to work with light and dark theme
+  * Improved slate color scheme to be more customizable and easier on the eyes
+  * Added licenses of icon sets to distribution files
+  * Fixed stale document titles in Google Analytics when using instant loading
+  * Fixed width of previous and next footer links for tablet and above
+  * Fixed issues with top scroll margin for footnotes
+  * Fixed top margin for tabbed content when using a JavaScript highlighter
+  * Deprecated metadata-based redirects, source links and heroes
+
+mkdocs-material-5.4.0+insiders-1.0.0 (2020-07-14)
+
+  * Added grouping of search results
+  * Added missing query terms to search result
+  * Improved search result relevance and scoring
+
 mkdocs-material-5.4.0 (2020-06-29)
 
   * Added support to wrap searches in quotes to switch from OR to AND
@@ -10,7 +83,7 @@ mkdocs-material-5.3.3 (2020-06-24)
 
 mkdocs-material-5.3.2 (2020-06-21)
 
-  * Improved search type-ahead experience with non-Latin characters
+  * Improved search typeahead experience with non-Latin characters
   * Fixed #1753: Japanese search doesn't work anymore
 
 mkdocs-material-5.3.1 (2020-06-20)

diff --git a/Dockerfile b/Dockerfile
@@ -20,6 +20,9 @@
 
 FROM python:3.8.1-alpine3.11
 
+# Build-time flags
+ARG WITH_PLUGINS=true
+
 # Set build directory
 WORKDIR /tmp
 
@@ -39,10 +42,14 @@ RUN \
     openssh \
   && apk add --no-cache --virtual .build gcc musl-dev \
   && pip install --no-cache-dir . \
-  && pip install --no-cache-dir \
-    'mkdocs-minify-plugin>=0.2' \
-    'mkdocs-git-revision-date-localized-plugin>=0.4' \
-    'mkdocs-awesome-pages-plugin>=2.2.1' \
+  && \
+    if [ "${WITH_PLUGINS}" = "true" ]; then \
+      pip install --no-cache-dir \
+        'mkdocs-awesome-pages-plugin>=2.2.1' \
+        'mkdocs-git-revision-date-localized-plugin>=0.4' \
+        'mkdocs-minify-plugin>=0.3' \
+        'mkdocs-redirects>=1.0'; \
+    fi \
   && apk del .build gcc musl-dev \
   && rm -rf /tmp/*
 

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,5 +1,6 @@
 recursive-include material *.js *.css *.map *.html *.svg *.png *.yml
-recursive-include material *.ttf *.woff *.woff2
+recursive-include material *.ttf *.woff *.woff2 LICENSE*
+recursive-exclude material/assets overrides*
 recursive-exclude material/overrides *
 recursive-exclude site *
 recursive-exclude src *

diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 <p align="center">
-  <a href="https://squidfunk.github.io/mkdocs-material">
+  <a href="https://squidfunk.github.io/mkdocs-material/">
     <img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/logo.png" width="320" alt="Material for MkDocs">
   </a>
 </p>
@@ -34,8 +34,8 @@
     src="https://img.shields.io/docker/pulls/squidfunk/mkdocs-material" 
     alt="Docker Pulls"
   /></a>
-  <a href="https://github.com/sponsors/squidfunk"><img
-    src="https://img.shields.io/static/v1?label=sponsor&message=%E2%9D%A4&logo=GitHub&color=ea4aaa"
+  <a href="https://squidfunk.github.io/mkdocs-material/insiders/"><img
+    src="https://img.shields.io/static/v1?label=%E2%86%92&message=insiders&color=e91e63"
   /></a>
 </p>
 
@@ -97,6 +97,15 @@
   with TypeScript, RxJS, and SCSS, and is compiled with Webpack, bringing
   excellent possibilities for theme extension and customization.
 
+_Material for MkDocs uses the [sponsorware][2] release strategy, which means
+that new features are first exclusively released to sponsors as part of Material
+for MkDocs Insiders. Read on to learn [how sponsorship works][3], and how you
+can [become a sponsor][4]._
+
+  [2]: https://github.com/sponsorware/docs
+  [3]: https://squidfunk.github.io/mkdocs-material/insiders/#how-sponsorship-works
+  [4]: https://squidfunk.github.io/mkdocs-material/insiders/#how-to-become-a-sponsor
+
 ## Quick start
 
 Material for MkDocs can be installed with `pip`:
@@ -117,47 +126,43 @@ For other installation methods, configuration options, and a demo, visit
 
   [1]: https://squidfunk.github.io/mkdocs-material/
 
+## Sponsors
+
+<p>
+  <a href="https://cirrus-ci.org/" target=_blank>
+    <img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/cirrus-ci.svg" width="155" />
+  </a>
+</p>
+
 ## Users
 
 * **Companies** — 
   [AWS](https://awssecworkshops.com/),
+  [Datadog](https://datadoghq.dev/integrations-core/),
   [ING](https://ing-bank.github.io/baker/),
   [Lyft](https://lyft.github.io/amundsen/),
   [Netflix](https://netflix.github.io/titus/),
-  [Uber](https://uber.github.io/ludwig/getting_started/),
   [Salesforce](https://policy-sentry.readthedocs.io/en/latest/),
   [SAP](https://sap.github.io/ui5-tooling/),
   [SoundCloud](https://intervene.dev/),
   [Spotify](https://spotify.github.io/mkdocs-monorepo-plugin/),
   [Square](https://square.github.io/okhttp/),
+  [Uber](https://ludwig-ai.github.io/ludwig-docs/getting_started/),
   [Zalando](https://opensource.zalando.com/skipper/)
 
 * **Open Source** —
   [AutoKeras](https://autokeras.com/),
   [BFE](https://www.bfe-networks.net/),
   [FastAPI](https://fastapi.tiangolo.com/),
   [Kubernetes](https://kops.sigs.k8s.io/),
+  [Nokogiri](https://nokogiri.org/),
   [OpenFaaS](https://docs.openfaas.com/),
   [Pi-Hole](https://docs.pi-hole.net/),
   [Pydantic](https://pydantic-docs.helpmanual.io/),
   [Traefik](https://docs.traefik.io/),
   [Vapor](https://docs.vapor.codes/),
   [ZeroNet](https://zeronet.io/docs/)
 
-## Sponsors
-
-<p>
-  <a href="https://cirrus-ci.org/" target=_blank>
-    <img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/cirrus-ci.svg" width="155" />
-  </a>
-</p>
-
-If you're using this project a lot, consider [sponsoring][2] it! This will give
-me the opportunity to sustain my efforts maintaining it. Every contribution
-counts, no matter how small!
-
-  [2]: https://github.com/sponsors/squidfunk
-
 ## License
 
 **MIT License**

diff --git a/docs/assets/creating-your-site.png b/docs/assets/creating-your-site.png
diff --git a/docs/assets/screenshots/creating-your-site.png b/docs/assets/screenshots/creating-your-site.png
diff --git a/docs/assets/search-highlighting.png b/docs/assets/search-highlighting.png
diff --git a/docs/releases/changelog.md → docs/changelog.md b/docs/releases/changelog.md → docs/changelog.md
@@ -2,21 +2,84 @@
 template: overrides/main.html
 ---
 
-# Upgrading
+# Changelog
 
-To upgrade to the latest version:
+## Material for MkDocs Insiders
 
-``` sh
-pip install --upgrade mkdocs-material
-```
+### 1.2.0 <small>_ August 11, 2020</small>
 
-To inspect the currently installed version:
+* Added feature to expand navigation by default
 
-``` sh
-pip show mkdocs-material
-```
+### 1.1.0 <small>_ August 3, 2020</small>
 
-## Changelog
+* Added highlighting of search results
+
+### 1.0.0 <small>_ July 14, 2020</small>
+
+* Added grouping of search results
+* Added missing query terms to search result
+* Improved search result relevance and scoring
+
+## Material for MkDocs
+
+### 5.5.8 <small>_ August 23, 2020</small>
+
+* Removed focus outline on `details` and content tabs for pointer devices
+* Improved accessibility of content tabs (now navigable via arrow keys)
+* Fixed #1877: `404` on search index when search is disabled
+* Fixed some memleaks in observable subscriptions
+* Fixed color definitions for `theme-color` meta tag
+
+### 5.5.7 <small>_ August 16, 2020</small>
+
+* Improved contrast ratio to 4.5:1 for syntax highlighting
+* Improved contrast ratio to 4.5:1 for table of contents
+
+### 5.5.6 <small>_ August 12, 2020</small>
+
+* Switched base template for `404.html` to `main.html`
+* Fixed #1864: GitHub organisation stats not loading
+
+### 5.5.5 <small>_ August 11, 2020</small>
+
+* Fixed missing vendor and worker distribution files
+
+### 5.5.4 <small>_ August 11, 2020</small>
+
+* Added support for sortable data tables
+
+### 5.5.3 <small>_ August 4, 2020</small>
+
+* Fixed search for languages other than English (5.5.1 regression)
+
+### 5.5.2 <small>_ August 3, 2020</small>
+
+* Improved highlight colors and spacing for `ins`, `del` and `mark`
+* Changed some keyboard symbols for better equivalents
+* Removed focus `outline` for details and code blocks on touch devices
+* Fixed margins for Admonitions (5.5.1 regression)
+* Fixed too small content tab labels (5.5.1 regression)
+* Fixed icon repeating for custom admonition icons
+
+### 5.5.1 <small>_ August 1, 2020</small>
+
+* Improved typesetting by basing `font-size` and spacings on `em`
+* Improved print view by slightly scaling down `font-size`
+* Changed custom site title (metadata) to be suffixed with site name
+* Fixed top- and bottom spacing of paragraphs inside table cells
+
+### 5.5.0 <small>_ July 24, 2020</small>
+
+* Rewrite of entire documentation
+* Rewrite of syntax highlighting to be customizable with CSS variables
+* Improved syntax highlighting to work with light and dark theme
+* Improved `slate` color scheme to be more customizable and easier on the eyes
+* Added licenses of icon sets to distribution files
+* Fixed stale document titles in Google Analytics when using instant loading
+* Fixed width of previous and next footer links for tablet and above
+* Fixed issues with top scroll margin for footnotes
+* Fixed top margin for tabbed content when using a JavaScript highlighter
+* Deprecated metadata-based redirects, source links and heroes
 
 ### 5.4.0 <small>_ June 29, 2020</small>
 
@@ -30,7 +93,7 @@ pip show mkdocs-material
 
 ### 5.3.2 <small>_ June 21, 2020</small>
 
-* Improved search type-ahead experience with non-Latin characters
+* Improved search typeahead experience with non-Latin characters
 * Fixed #1753: Japanese search doesn't work anymore
 
 ### 5.3.1 <small>_ June 20, 2020</small>

diff --git a/docs/contributing.md b/docs/contributing.md