Merge branch 'master' into master

Author: ojacques

.github/assets/sponsors/sponsor-automation-technology.png

@@ -57,10 +57,13 @@ jobs:
         run: |
           pip install .
           pip install \
+            "cairosvg>=2.5" \
             "mkdocs-git-committers-plugin-2>=1.1.1" \
             "mkdocs-git-revision-date-localized-plugin>=1.0" \
             "mkdocs-minify-plugin>=0.3" \
-            "mkdocs-redirects>=1.0"
+            "mkdocs-rss-plugin>=1.1" \
+            "mkdocs-redirects>=1.0" \
+            "pillow<10"
 
       - name: Install Insiders build
         if: github.event.repository.fork == false

.github/assets/sponsors/sponsor-sparkfun.png

@@ -46,10 +46,10 @@ jobs:
           python-version: ${{ env.PYTHON_VERSION }}
 
       - name: Set up Python dependencies
-        run: pip install --upgrade setuptools wheel twine
+        run: pip install --upgrade build twine
 
       - name: Build Python package
-        run: python setup.py build sdist bdist_wheel --universal
+        run: python -m build
 
       - name: Publish Python package
         env:

.github/workflows/documentation.yml

@@ -1,3 +1,68 @@
+mkdocs-material-8.5.2+insiders-4.23.5 (2022-09-18)
+
+  * Fixed #4367: Improved blog plugin date handling for MultiMarkdown syntax
+  * Fixed #4374: Fixed invalid URLs of related links to other blog posts
+
+mkdocs-material-8.5.2 (2022-09-18)
+
+  * Updated Mermaid.js to version 9.1.7
+  * Fixed overly large headlines in search results (8.5.0 regression)
+  * Fixed #4358: Navigation sections appear as clickable (8.5.0 regression)
+  * Fixed #4356: GitHub repository statistics fetched before consent
+
+mkdocs-material-8.5.1 (2022-09-15)
+
+  * Fixed #4366: Removed dependencies with native extensions
+
+mkdocs-material-8.5.0+insiders-4.23.4 (2022-09-14)
+
+  * Fixed #4365: Recursion error in blog plugin due to deepcopy
+  * Fixed path errors for blog plugin on Windows
+  * Fixed publishing workflow in forked repositories
+
+mkdocs-material-8.5.0+insiders-4.23.3 (2022-09-13)
+
+  * Fixed previous and next page links for drafts of blog posts
+
+mkdocs-material-8.5.0 (2022-09-13)
+
+  * Added support for social cards
+  * Added support for code annotation anchor links (deep linking)
+  * Added support for code annotation comment stripping (syntax modifier)
+  * Added support for sidebars scrolling automatically to active item
+  * Added support for anchor following table of contents (= auto scroll)
+  * Added support for tag icons
+
+mkdocs-material-8.4.4+insiders-4.23.2 (2022-09-13)
+
+  * Fixed #4348: Blog plugin crashes on custom nav title
+  * Fixed blog plugin crashing when category contained only drafts
+  * Fixed rendering of content from blog index file
+
+mkdocs-material-8.4.4+insiders-4.23.1 (2022-09-12)
+
+  * Fixed #4345: Blog plugin errors with default settings
+
+mkdocs-material-8.4.4+insiders-4.23.0 (2022-09-12)
+
+  * Added blogging support via built-in blog plugin
+
+mkdocs-material-8.4.4 (2022-09-12)
+
+  * Moved comments integration to separate partial (comments.html)
+
+mkdocs-material-8.4.3+insiders-4.22.1 (2022-09-07)
+
+  * Fixed #4217: Tooltips in data tables render in wrong position
+
+mkdocs-material-8.4.3 (2022-09-07)
+
+  * Added Simple Icons to bundled icons (+2,300 icons)
+  * Added support for changing edit icon
+  * Moved page actions to separate partial (actions.html)
+  * Fixed #4291: Version switching doesn't stay on page when anchors are used
+  * Fixed #4327: Links in data tables do not receive link styling
+
 mkdocs-material-8.4.2 (2022-08-27)
 
   * Updated Slovenian translations

.github/workflows/publish.yml

@@ -40,6 +40,36 @@ it is:
   the `master`, as it's always a matter of opinion whether if benefits the
   overall functionality of the project.
 
+### Missing translations?
+
+Material for MkDocs ships support for 50+ languages with the help of community
+contributions. When new features are added, sometimes, new translations are
+necessary as well. It's impossible for the maintainers of the project to update
+all translations (we just don't speak 50+ languages), so we have to rely on
+our contributors to incrementally update translations. This process is pretty
+simple, so if you find a translation missing in your language, follow these
+guidelines:
+
+1.  Fork the repository.
+
+2.  Open up the [translation file for your language] as well as the
+    [English translations], as they are always up-to-date. Compare them
+    side-by-side and add the missing translations. __Important__: only add the
+    translations that are different from the defaults, e.g. if your language
+    is left-to-right, don't add the `direction` translation, as English is
+    left-to-right as well. The following translations are for technical
+    purposes, and should not be updated, so if they're missing from your
+    language it's for good reason:
+
+    - `search.config.lang`
+    - `search.config.pipeline`
+    - `search.config.separator`
+
+1.  Create a PR (see below) with your changes.
+
+  [translation file for your language]: https://github.com/squidfunk/mkdocs-material/tree/master/src/partials/languages
+  [English translations]: https://github.com/squidfunk/mkdocs-material/tree/master/src/partials/languages/en.html
+
 ## Submission guidelines
 
 ### Submitting an issue

CHANGELOG

@@ -32,31 +32,37 @@ WORKDIR /tmp
 
 # Copy files necessary for build
 COPY material material
-COPY MANIFEST.in MANIFEST.in
 COPY package.json package.json
 COPY README.md README.md
 COPY requirements.txt requirements.txt
-COPY setup.py setup.py
+COPY pyproject.toml pyproject.toml
 
 # Perform build and cleanup artifacts and caches
 RUN \
   apk upgrade --update-cache -a \
 && \
   apk add --no-cache \
+    cairo \
+    freetype-dev \
     git \
     git-fast-import \
+    jpeg-dev \
     openssh \
+    zlib-dev \
 && \
   apk add --no-cache --virtual .build \
     gcc \
+    libffi-dev \
     musl-dev \
 && \
   pip install --no-cache-dir . \
 && \
   if [ "${WITH_PLUGINS}" = "true" ]; then \
     pip install --no-cache-dir \
       "mkdocs-minify-plugin>=0.3" \
-      "mkdocs-redirects>=1.0"; \
+      "mkdocs-redirects>=1.0" \
+      "pillow>=9.0" \
+      "cairosvg>=2.5"; \
   fi \
 && \
   apk del .build \

CONTRIBUTING.md

@@ -125,6 +125,12 @@
   <a href="https://jitterbit.com/" target=_blank><img
     src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-jitterbit.png" height="58"
   /></a>
+  <a href="https://sparkfun.com/" target=_blank><img
+    src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-sparkfun.png" height="58"
+  /></a>
+  <a href="https://automationtechnology.de/" target=_blank><img
+    src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-automation-technology.png" height="58"
+  /></a>
 </p>
 <p>&nbsp;</p>
 

Dockerfile

@@ -29,7 +29,7 @@ __Challenges__
 - More time needed to get up and running
 
 While [Docusaurus] is one of the best choices when it comes to documentation
-sites that output a single page applications, there are many more solutions,
+sites that output a single page application, there are many more solutions,
 including [Docz], [Gatsby], [Vuepress] and [Docsify] that approach
 this problem similarily.
 

MANIFEST.in

@@ -0,0 +1,4 @@
+squidfunk:
+  name: Martin Donath
+  description: Creator
+  avatar: https://avatars.githubusercontent.com/u/932156

README.md

@@ -0,0 +1,3 @@
+comments: true
+hide:
+  - feedback

docs/alternatives.md

@@ -1,146 +1 @@
----
-template: overrides/main.html
-title: Blog
-search:
-  exclude: true
----
-
-<style>
-  .md-sidebar--secondary:not([hidden]) {
-    visibility: hidden;
-  }
-</style>
-
 # Blog
-
-## [Chinese search support – 中文搜索​支持]
-
-__Insiders adds experimental Chinese language support for the [built-in search 
-plugin] – a feature that has been requested for a long time given the large
-number of Chinese users.__
-
-<aside class="mdx-author" markdown>
-![@squidfunk][@squidfunk avatar]
-
-<span>__Martin Donath__ · @squidfunk</span>
-<span>
-:octicons-calendar-24: May 5, 2022 ·
-:octicons-clock-24: 5 min read ·
-[:octicons-tag-24: 8.2.13+insiders-4.14.0][insiders-4.14.0]
-</span>
-</aside>
-
----
-
-After the United States and Germany, the third-largest country of origin of
-Material for MkDocs users is China. For a long time, the [built-in search plugin]
-didn't allow for proper segmentation of Chinese characters, mainly due to 
-missing support in [`lunr-languages`][lunr-languages] which is used for search 
-tokenization and stemming. The latest Insiders release adds long-awaited Chinese 
-language support for the built-in search plugin, something that has been
-requested by many users.
-
-  [:octicons-arrow-right-24: Continue reading][Chinese search support – 中文搜索​支持]
-
-  [built-in search plugin]: ../setup/setting-up-site-search.md#built-in-search-plugin
-  [@squidfunk avatar]: https://avatars.githubusercontent.com/u/932156
-  [insiders-4.14.0]: ../insiders/changelog.md#4.14.0
-  [lunr-languages]: https://github.com/MihaiValentin/lunr-languages
-  [Chinese search support – 中文搜索​支持]: 2022/chinese-search-support.md
-
-## [The past, present and future]
-
-__2021 was a fantastic year for this project as we shipped many new awesome
-features, saw significant user growth and leveraged GitHub Sponsors to make the
-project sustainable.__
-
-<aside class="mdx-author" markdown>
-![@squidfunk][@squidfunk avatar]
-
-<span>__Martin Donath__ · @squidfunk</span>
-<span>
-:octicons-calendar-24: December 27, 2021 ·
-:octicons-clock-24: 10 min read
-</span>
-</aside>
-
----
-
-Today, together, MkDocs and Material for MkDocs are among the most popular
-options when it comes to choosing a static site generator and theme for your
-technical documentation project. Material for MkDocs ensures that your
-content is always perfectly presented to your audience, regardless of screen
-resolution or device capabilities. It has evolved to a framework for technical
-writing, offering many features, some of which are yet to be found in other
-static site generators. However, we're far from the end, as 2022 is going to
-bring some interesting new capabilities.
-
-  [:octicons-arrow-right-24: Continue reading][The past, present and future]
-
-  [The past, present and future]: 2021/the-past-present-and-future.md
-
-## [Excluding content from search]
-
-__The latest Insiders release brings three new simple ways to exclude dedicated
-parts of a document from the search index, allowing for more fine-grained
-control.__
-
-<aside class="mdx-author" markdown>
-![@squidfunk][@squidfunk avatar]
-
-<span>__Martin Donath__ · @squidfunk</span>
-<span>
-:octicons-calendar-24: September 26, 2021 ·
-:octicons-clock-24: 5 min read ·
-[:octicons-tag-24: 7.3.0+insiders-3.1.1][insiders-3.1.1]
-</span>
-</aside>
-
----
-
-Two weeks ago, Material for MkDocs Insiders shipped a brand new search plugin,
-yielding massive improvements in usability, but also in speed and size of the
-search index. Interestingly, as discussed in the previous blog article, we only
-scratched the surface of what's now possible. This release brings some useful
-features that enhance the writing experience, allowing for more fine-grained
-control of what pages, sections and blocks of a Markdown file should be indexed
-by the built-in search functionality.
-
-[:octicons-arrow-right-24: Continue reading][Excluding content from search]
-
-  [Excluding content from search]: 2021/excluding-content-from-search.md
-  [insiders-3.1.1]: ../insiders/changelog.md#3.1.1
-
-## [Search: better, faster, smaller]
-
-__This is the story of how we managed to completely rebuild client-side search,
-delivering a significantly better user experience while making it faster and
-smaller at the same time.__
-
-<aside class="mdx-author" markdown>
-![@squidfunk][@squidfunk avatar]
-
-<span>__Martin Donath__ · @squidfunk</span>
-<span>
-:octicons-calendar-24: September 13, 2021 ·
-:octicons-clock-24: 15 min read ·
-[:octicons-tag-24: 7.2.6+insiders-3.0.0][insiders-3.0.0]
-</span>
-</aside>
-
----
-
-The search of Material for MkDocs is by far one of its best and most-loved
-assets: multilingual, offline-capable, and most importantly: _all client-side_.
-It provides a solution to empower the users of your documentation to find what
-they're searching for instantly without the headache of managing additional
-servers. However, even though several iterations have been made, there's still
-some room for improvement, which is why we rebuilt the search plugin and
-integration from the ground up. This article shines some light on the internals
-of the new search, why it's much more powerful than the previous version, and
-what's about to come.
-
-[:octicons-arrow-right-24: Continue reading][Search: better, faster, smaller]
-
-  [Search: better, faster, smaller]: 2021/search-better-faster-smaller.md
-  [insiders-3.0.0]: ../insiders/changelog.md#3.0.0