Merge branch 'master' into master
BIN
.github/assets/sponsors/sponsor-automation-technology.png
vendored
Normal file
After Width: | Height: | Size: 11 KiB |
BIN
.github/assets/sponsors/sponsor-sparkfun.png
vendored
Normal file
After Width: | Height: | Size: 10 KiB |
5
.github/workflows/documentation.yml
vendored
@ -57,10 +57,13 @@ jobs:
|
|||||||
run: |
|
run: |
|
||||||
pip install .
|
pip install .
|
||||||
pip install \
|
pip install \
|
||||||
|
"cairosvg>=2.5" \
|
||||||
"mkdocs-git-committers-plugin-2>=1.1.1" \
|
"mkdocs-git-committers-plugin-2>=1.1.1" \
|
||||||
"mkdocs-git-revision-date-localized-plugin>=1.0" \
|
"mkdocs-git-revision-date-localized-plugin>=1.0" \
|
||||||
"mkdocs-minify-plugin>=0.3" \
|
"mkdocs-minify-plugin>=0.3" \
|
||||||
"mkdocs-redirects>=1.0"
|
"mkdocs-rss-plugin>=1.1" \
|
||||||
|
"mkdocs-redirects>=1.0" \
|
||||||
|
"pillow<10"
|
||||||
|
|
||||||
- name: Install Insiders build
|
- name: Install Insiders build
|
||||||
if: github.event.repository.fork == false
|
if: github.event.repository.fork == false
|
||||||
|
4
.github/workflows/publish.yml
vendored
@ -46,10 +46,10 @@ jobs:
|
|||||||
python-version: ${{ env.PYTHON_VERSION }}
|
python-version: ${{ env.PYTHON_VERSION }}
|
||||||
|
|
||||||
- name: Set up Python dependencies
|
- name: Set up Python dependencies
|
||||||
run: pip install --upgrade setuptools wheel twine
|
run: pip install --upgrade build twine
|
||||||
|
|
||||||
- name: Build Python package
|
- name: Build Python package
|
||||||
run: python setup.py build sdist bdist_wheel --universal
|
run: python -m build
|
||||||
|
|
||||||
- name: Publish Python package
|
- name: Publish Python package
|
||||||
env:
|
env:
|
||||||
|
65
CHANGELOG
@ -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)
|
mkdocs-material-8.4.2 (2022-08-27)
|
||||||
|
|
||||||
* Updated Slovenian translations
|
* Updated Slovenian translations
|
||||||
|
@ -40,6 +40,36 @@ it is:
|
|||||||
the `master`, as it's always a matter of opinion whether if benefits the
|
the `master`, as it's always a matter of opinion whether if benefits the
|
||||||
overall functionality of the project.
|
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
|
## Submission guidelines
|
||||||
|
|
||||||
### Submitting an issue
|
### Submitting an issue
|
||||||
|
12
Dockerfile
@ -32,23 +32,27 @@ WORKDIR /tmp
|
|||||||
|
|
||||||
# Copy files necessary for build
|
# Copy files necessary for build
|
||||||
COPY material material
|
COPY material material
|
||||||
COPY MANIFEST.in MANIFEST.in
|
|
||||||
COPY package.json package.json
|
COPY package.json package.json
|
||||||
COPY README.md README.md
|
COPY README.md README.md
|
||||||
COPY requirements.txt requirements.txt
|
COPY requirements.txt requirements.txt
|
||||||
COPY setup.py setup.py
|
COPY pyproject.toml pyproject.toml
|
||||||
|
|
||||||
# Perform build and cleanup artifacts and caches
|
# Perform build and cleanup artifacts and caches
|
||||||
RUN \
|
RUN \
|
||||||
apk upgrade --update-cache -a \
|
apk upgrade --update-cache -a \
|
||||||
&& \
|
&& \
|
||||||
apk add --no-cache \
|
apk add --no-cache \
|
||||||
|
cairo \
|
||||||
|
freetype-dev \
|
||||||
git \
|
git \
|
||||||
git-fast-import \
|
git-fast-import \
|
||||||
|
jpeg-dev \
|
||||||
openssh \
|
openssh \
|
||||||
|
zlib-dev \
|
||||||
&& \
|
&& \
|
||||||
apk add --no-cache --virtual .build \
|
apk add --no-cache --virtual .build \
|
||||||
gcc \
|
gcc \
|
||||||
|
libffi-dev \
|
||||||
musl-dev \
|
musl-dev \
|
||||||
&& \
|
&& \
|
||||||
pip install --no-cache-dir . \
|
pip install --no-cache-dir . \
|
||||||
@ -56,7 +60,9 @@ RUN \
|
|||||||
if [ "${WITH_PLUGINS}" = "true" ]; then \
|
if [ "${WITH_PLUGINS}" = "true" ]; then \
|
||||||
pip install --no-cache-dir \
|
pip install --no-cache-dir \
|
||||||
"mkdocs-minify-plugin>=0.3" \
|
"mkdocs-minify-plugin>=0.3" \
|
||||||
"mkdocs-redirects>=1.0"; \
|
"mkdocs-redirects>=1.0" \
|
||||||
|
"pillow>=9.0" \
|
||||||
|
"cairosvg>=2.5"; \
|
||||||
fi \
|
fi \
|
||||||
&& \
|
&& \
|
||||||
apk del .build \
|
apk del .build \
|
||||||
|
11
MANIFEST.in
@ -1,11 +0,0 @@
|
|||||||
recursive-include material *.js *.css *.map *.html *.svg *.png *.yml
|
|
||||||
recursive-include material *.ttf *.woff *.woff2 LICENSE*
|
|
||||||
recursive-exclude material/overrides *
|
|
||||||
recursive-exclude site *
|
|
||||||
recursive-exclude src *
|
|
||||||
recursive-exclude * __pycache__
|
|
||||||
recursive-exclude * *.py[co]
|
|
||||||
include LICENSE
|
|
||||||
include package.json
|
|
||||||
include README.md
|
|
||||||
include requirements.txt
|
|
@ -125,6 +125,12 @@
|
|||||||
<a href="https://jitterbit.com/" target=_blank><img
|
<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"
|
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-jitterbit.png" height="58"
|
||||||
/></a>
|
/></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>
|
||||||
<p> </p>
|
<p> </p>
|
||||||
|
|
||||||
|
@ -29,7 +29,7 @@ __Challenges__
|
|||||||
- More time needed to get up and running
|
- More time needed to get up and running
|
||||||
|
|
||||||
While [Docusaurus] is one of the best choices when it comes to documentation
|
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
|
including [Docz], [Gatsby], [Vuepress] and [Docsify] that approach
|
||||||
this problem similarily.
|
this problem similarily.
|
||||||
|
|
||||||
|
4
docs/blog/.authors.yml
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
squidfunk:
|
||||||
|
name: Martin Donath
|
||||||
|
description: Creator
|
||||||
|
avatar: https://avatars.githubusercontent.com/u/932156
|
3
docs/blog/.meta.yml
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
comments: true
|
||||||
|
hide:
|
||||||
|
- feedback
|
@ -1,146 +1 @@
|
|||||||
---
|
|
||||||
template: overrides/main.html
|
|
||||||
title: Blog
|
|
||||||
search:
|
|
||||||
exclude: true
|
|
||||||
---
|
|
||||||
|
|
||||||
<style>
|
|
||||||
.md-sidebar--secondary:not([hidden]) {
|
|
||||||
visibility: hidden;
|
|
||||||
}
|
|
||||||
</style>
|
|
||||||
|
|
||||||
# Blog
|
# 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
|
|
||||||
|
247
docs/blog/posts/blog-support-just-landed.md
Normal file
@ -0,0 +1,247 @@
|
|||||||
|
---
|
||||||
|
date: 2022-09-12
|
||||||
|
authors: [squidfunk]
|
||||||
|
description: >
|
||||||
|
Our new blog is built with the brand new built-in blog plugin. You can build
|
||||||
|
a blog alongside your documentation or standalone
|
||||||
|
categories:
|
||||||
|
- Blog
|
||||||
|
links:
|
||||||
|
- Getting started with Insiders: insiders/getting-started.md#requirements
|
||||||
|
- setup/setting-up-a-blog.md#built-in-blog-plugin
|
||||||
|
---
|
||||||
|
|
||||||
|
# Blog support just landed
|
||||||
|
|
||||||
|
__Hey there! You're looking at our new blog, built with the brand new
|
||||||
|
[built-in blog plugin]. With this plugin, you can easily build a blog alongside
|
||||||
|
your documentation or standalone.__
|
||||||
|
|
||||||
|
Proper support for blogging, as requested by many users over the past few years,
|
||||||
|
was something that was desperately missing from Material for MkDocs' feature set.
|
||||||
|
While everybody agreed that blogging support was a blind spot, it was not
|
||||||
|
obvious whether MkDocs could be extended in a way to allow for blogging as we
|
||||||
|
know it from [Jekyll] and friends. The [built-in blog plugin] proves that it is,
|
||||||
|
after all, possible to build a blogging engine on top of MkDocs, in order to
|
||||||
|
create a technical blog alongside your documentation, or as the main thing.
|
||||||
|
|
||||||
|
<!-- more -->
|
||||||
|
|
||||||
|
_This article explains how to build a standalone blog with Material for MkDocs.
|
||||||
|
If you want to build a blog alongside your documentation, please refer to
|
||||||
|
[the plugin's documentation][built-in blog plugin]._
|
||||||
|
|
||||||
|
[built-in blog plugin]: ../../setup/setting-up-a-blog.md#built-in-blog-plugin
|
||||||
|
[Jekyll]: https://jekyllrb.com/
|
||||||
|
|
||||||
|
## Quick start
|
||||||
|
|
||||||
|
### Setting up Insiders
|
||||||
|
|
||||||
|
Before we can start bootstrapping a blog and [write our first post], we need to
|
||||||
|
set up [Insiders], since the [built-in blog plugin] is currently reserved to
|
||||||
|
sponsors. Without the funds this project receives through sponsorships, this
|
||||||
|
plugin wouldn't exist. Three steps are necessary:
|
||||||
|
|
||||||
|
1. [Subscribe to a monthly sponsorship]
|
||||||
|
2. [Create a personal access token]
|
||||||
|
3. [Install Insiders]
|
||||||
|
|
||||||
|
[write our first post]: #writing-your-first-post
|
||||||
|
[Insiders]: ../../insiders/index.md
|
||||||
|
[Subscribe to a monthly sponsorship]: ../../insiders/index.md#how-to-become-a-sponsor
|
||||||
|
[Create a personal access token]: ../../insiders/getting-started.md#requirements
|
||||||
|
[Install Insiders]: ../../insiders/getting-started.md#installation
|
||||||
|
|
||||||
|
### Creating a standalone blog
|
||||||
|
|
||||||
|
After Insiders is installed, you can bootstrap a new project using the `mkdocs`
|
||||||
|
executable:
|
||||||
|
|
||||||
|
```
|
||||||
|
mkdocs new .
|
||||||
|
```
|
||||||
|
|
||||||
|
This will create the following structure:
|
||||||
|
|
||||||
|
```
|
||||||
|
.
|
||||||
|
├─ docs/
|
||||||
|
│ └─ index.md
|
||||||
|
└─ mkdocs.yml
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Configuration
|
||||||
|
|
||||||
|
In this article, we're going to build a standalone blog, which means that the
|
||||||
|
blog lives at the root of your project. For this reason, open `mkdocs.yml`,
|
||||||
|
and replace its contents with:
|
||||||
|
|
||||||
|
``` yaml
|
||||||
|
site_name: My Blog
|
||||||
|
theme:
|
||||||
|
name: material
|
||||||
|
features:
|
||||||
|
- navigation.sections
|
||||||
|
plugins:
|
||||||
|
- meta
|
||||||
|
- blog:
|
||||||
|
blog_dir: . # (1)!
|
||||||
|
- search
|
||||||
|
- tags
|
||||||
|
nav:
|
||||||
|
- index.md
|
||||||
|
```
|
||||||
|
|
||||||
|
1. This is the important part – we're hosting the blog at the root of the
|
||||||
|
project, and not in a subdirectory. For more information, see the
|
||||||
|
[`blog_dir`][blog_dir] configuration option.
|
||||||
|
|
||||||
|
[blog_dir]: ../../setup/setting-up-a-blog.md#+blog.blog_dir
|
||||||
|
|
||||||
|
#### Blog setup
|
||||||
|
|
||||||
|
The blog index page lives in `docs/index.md`. This page was pre-filled by
|
||||||
|
MkDocs with some content, so we're going to replace it with what we need to
|
||||||
|
bootstrap the blog:
|
||||||
|
|
||||||
|
``` markdown
|
||||||
|
# Blog
|
||||||
|
```
|
||||||
|
|
||||||
|
That's it.
|
||||||
|
|
||||||
|
### Writing your first post
|
||||||
|
|
||||||
|
Now that we have set up the [built-in blog plugin], we can start writing our
|
||||||
|
first post. All blog posts are written with the [exact same Markdown flavor] as
|
||||||
|
already included with Material for MkDocs. First, create a folder called `posts`
|
||||||
|
with a file called `hello-world.md`:
|
||||||
|
|
||||||
|
``` sh
|
||||||
|
.
|
||||||
|
├─ docs/
|
||||||
|
│ ├─ posts/
|
||||||
|
│ │ └─ hello-world.md # (1)!
|
||||||
|
│ └─ index.md
|
||||||
|
└─ mkdocs.yml
|
||||||
|
```
|
||||||
|
|
||||||
|
1. If you'd like to arrange posts differently, you're free to do so. The URLs
|
||||||
|
are built from the format specified in [`post_url_format`][post slugs] and
|
||||||
|
the titles and dates of posts, no matter how they are organized
|
||||||
|
inside the `posts` directory.
|
||||||
|
|
||||||
|
Then, open up `hello-world.md`, and add the following lines:
|
||||||
|
|
||||||
|
``` yaml
|
||||||
|
---
|
||||||
|
draft: true # (1)!
|
||||||
|
date: 2022-01-31
|
||||||
|
categories:
|
||||||
|
- Hello
|
||||||
|
- World
|
||||||
|
---
|
||||||
|
|
||||||
|
# Hello world!
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque nec
|
||||||
|
maximus ex. Sed consequat, nulla quis malesuada dapibus, elit metus vehicula
|
||||||
|
erat, ut egestas tellus eros at risus. In hac habitasse platea dictumst.
|
||||||
|
Phasellus id lacus pulvinar erat consequat pretium. Morbi malesuada arcu mauris
|
||||||
|
Nam vel justo sem. Nam placerat purus non varius luctus. Integer pretium leo in
|
||||||
|
sem rhoncus, quis gravida orci mollis. Proin id aliquam est. Vivamus in nunc ac
|
||||||
|
metus tristique pellentesque. Suspendisse viverra urna in accumsan aliquet.
|
||||||
|
|
||||||
|
<!-- more -->
|
||||||
|
|
||||||
|
Donec volutpat, elit ac volutpat laoreet, turpis dolor semper nibh, et dictum
|
||||||
|
massa ex pulvinar elit. Curabitur commodo sit amet dolor sed mattis. Etiam
|
||||||
|
tempor odio eu nisi gravida cursus. Maecenas ante enim, fermentum sit amet
|
||||||
|
molestie nec, mollis ac libero. Vivamus sagittis suscipit eros ut luctus.
|
||||||
|
|
||||||
|
Nunc vehicula sagittis condimentum. Cras facilisis bibendum lorem et feugiat.
|
||||||
|
In auctor accumsan ligula, at consectetur erat commodo quis. Morbi ac nunc
|
||||||
|
pharetra, pellentesque risus in, consectetur urna. Nulla id enim facilisis
|
||||||
|
arcu tincidunt pulvinar. Vestibulum laoreet risus scelerisque porta congue.
|
||||||
|
In velit purus, dictum quis neque nec, molestie viverra risus. Nam pellentesque
|
||||||
|
tellus id elit ultricies, vel finibus erat cursus.
|
||||||
|
```
|
||||||
|
|
||||||
|
1. If you mark a post as a [draft], a red marker appears next to the post date
|
||||||
|
on index pages. When the site is built, drafts are not included in the
|
||||||
|
output. [This behavior can be changed], e.g. for rendering drafts when
|
||||||
|
building deploy previews.
|
||||||
|
|
||||||
|
When you spin up the [live preview server], you should be greeted by your first
|
||||||
|
post! You'll also realize, that [archive] and [category] indexes have been
|
||||||
|
automatically generated for you:
|
||||||
|
|
||||||
|
![Blog]
|
||||||
|
|
||||||
|
However, this is just the start. The [built-in blog plugin] packs a lot of
|
||||||
|
functionality needed in day-to-day blogging. Visit the documentation of the
|
||||||
|
plugin to learn about the following topics:
|
||||||
|
|
||||||
|
<div class="mdx-columns" markdown>
|
||||||
|
|
||||||
|
- [Adding an excerpt]
|
||||||
|
- [Adding authors]
|
||||||
|
- [Adding categories]
|
||||||
|
- [Adding tags]
|
||||||
|
- [Adding related links]
|
||||||
|
- [Linking from and to posts]
|
||||||
|
- [Setting the reading time]
|
||||||
|
- [Setting defaults]
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Additionally, the [built-in blog plugin] has dozens of [configuration options]
|
||||||
|
which allow for fine-tuning the output. You can configure post slugs, general
|
||||||
|
behavior and much more.
|
||||||
|
|
||||||
|
[exact same Markdown flavor]: ../../reference/index.md
|
||||||
|
[post slugs]: ../../setup/setting-up-a-blog.md#+blog.post_url_format
|
||||||
|
[draft]: ../../setup/setting-up-a-blog.md#drafts
|
||||||
|
[This behavior can be changed]: ../../setup/setting-up-a-blog.md#+blog.draft
|
||||||
|
[live preview server]: ../../creating-your-site.md#previewing-as-you-write
|
||||||
|
[archive]: ../../setup/setting-up-a-blog.md#archive
|
||||||
|
[category]: ../../setup/setting-up-a-blog.md#categories
|
||||||
|
[Blog]: blog-support-just-landed/blog.png
|
||||||
|
[Blog post]: blog-support-just-landed/blog-post.png
|
||||||
|
[Adding an excerpt]: ../../setup/setting-up-a-blog.md#adding-an-excerpt
|
||||||
|
[Adding authors]: ../../setup/setting-up-a-blog.md#adding-authors
|
||||||
|
[Adding categories]: ../../setup/setting-up-a-blog.md#adding-categories
|
||||||
|
[Adding tags]: ../../setup/setting-up-a-blog.md#adding-tags
|
||||||
|
[Adding related links]: ../../setup/setting-up-a-blog.md#adding-related-links
|
||||||
|
[Linking from and to posts]: ../../setup/setting-up-a-blog.md#linking-from-and-to-posts
|
||||||
|
[Setting the reading time]: ../../setup/setting-up-a-blog.md#setting-the-reading-time
|
||||||
|
[Setting defaults]: ../../setup/setting-up-a-blog.md#setting-defaults
|
||||||
|
[configuration options]: ../../setup/setting-up-a-blog.md#configuration
|
||||||
|
|
||||||
|
## What's next?
|
||||||
|
|
||||||
|
Getting basic blogging support out the door was quite a challenge – the
|
||||||
|
[built-in blog plugin] is probably the biggest release this year and already
|
||||||
|
packs a lot of functionality. However, Material for MkDocs is used in many
|
||||||
|
different contexts, which is why we'd expect to iterate, as always.
|
||||||
|
|
||||||
|
Some ideas already proposed by users:
|
||||||
|
|
||||||
|
- __Blog series__: Authors should be able to create so called blog series and
|
||||||
|
assign posts to a blog series using simple identifiers. For each post that is
|
||||||
|
part of a series, a list with links to all other posts should be included in
|
||||||
|
the post's content.
|
||||||
|
|
||||||
|
- __Author indexes__: Besides [archive] and [category] indexes, authors should
|
||||||
|
be able to create per-author indexes, which list all posts linked to an
|
||||||
|
author. Additionally, a profile should be created for each author and linked
|
||||||
|
from posts.
|
||||||
|
|
||||||
|
- __Social share buttons__: It should be easy to share blog posts via social
|
||||||
|
media or other ways. For this reason, it should be possible to automatically
|
||||||
|
include social sharing buttons with each post.
|
||||||
|
|
||||||
|
What's still missing from the brand new [built-in blog plugin]? Feel free to
|
||||||
|
share your ideas in the comments. Together, we can build one of the best modern
|
||||||
|
engines for technical blogging!
|
BIN
docs/blog/posts/blog-support-just-landed/blog.png
Normal file
After Width: | Height: | Size: 325 KiB |
@ -1,11 +1,16 @@
|
|||||||
---
|
---
|
||||||
template: overrides/blog.html
|
date: 2022-05-05
|
||||||
|
authors: [squidfunk]
|
||||||
title: Chinese search support
|
title: Chinese search support
|
||||||
description: >
|
description: >
|
||||||
Insiders adds Chinese language support for the built-in search plugin – a
|
Insiders adds Chinese language support for the built-in search plugin – a
|
||||||
feature that has been requested many times
|
feature that has been requested many times
|
||||||
hide:
|
categories:
|
||||||
- feedback
|
- Search
|
||||||
|
links:
|
||||||
|
- blog/posts/search-better-faster-smaller.md
|
||||||
|
- setup/setting-up-site-search.md#chinese-language-support
|
||||||
|
- insiders/index.md#how-to-become-a-sponsor
|
||||||
---
|
---
|
||||||
|
|
||||||
# Chinese search support – 中文搜索支持
|
# Chinese search support – 中文搜索支持
|
||||||
@ -14,23 +19,6 @@ __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
|
plugin] – a feature that has been requested for a long time given the large
|
||||||
number of Chinese users.__
|
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: 3 min read ·
|
|
||||||
[:octicons-tag-24: 8.2.13+insiders-4.14.0][insiders-4.14.0]
|
|
||||||
</span>
|
|
||||||
</aside>
|
|
||||||
|
|
||||||
[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
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
After the United States and Germany, the third-largest country of origin of
|
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]
|
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
|
didn't allow for proper segmentation of Chinese characters, mainly due to
|
||||||
@ -38,6 +26,8 @@ missing support in [lunr-languages] which is used for search tokenization and
|
|||||||
stemming. The latest Insiders release adds long-awaited Chinese language support
|
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.
|
for the built-in search plugin, something that has been requested by many users.
|
||||||
|
|
||||||
|
<!-- more -->
|
||||||
|
|
||||||
_Material for MkDocs終於支持中文了!文本被正確分割並且更容易找到。_
|
_Material for MkDocs終於支持中文了!文本被正確分割並且更容易找到。_
|
||||||
{ style="display: inline" }
|
{ style="display: inline" }
|
||||||
|
|
||||||
@ -45,6 +35,7 @@ _This article explains how to set up Chinese language support for the built-in
|
|||||||
search plugin in a few minutes._
|
search plugin in a few minutes._
|
||||||
{ style="display: inline" }
|
{ style="display: inline" }
|
||||||
|
|
||||||
|
[built-in search plugin]: ../../setup/setting-up-site-search.md#built-in-search-plugin
|
||||||
[lunr-languages]: https://github.com/MihaiValentin/lunr-languages
|
[lunr-languages]: https://github.com/MihaiValentin/lunr-languages
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
@ -1,12 +1,15 @@
|
|||||||
---
|
---
|
||||||
template: overrides/blog.html
|
date: 2021-09-26
|
||||||
|
authors: [squidfunk]
|
||||||
description: >
|
description: >
|
||||||
Three new simple ways to exclude dedicated parts of a document from the search
|
Three new simple ways to exclude dedicated parts of a document from the search
|
||||||
index, allowing for more fine-grained control
|
index, allowing for more fine-grained control
|
||||||
search:
|
categories:
|
||||||
exclude: true
|
- Search
|
||||||
hide:
|
links:
|
||||||
- feedback
|
- blog/posts/search-better-faster-smaller.md
|
||||||
|
- setup/setting-up-site-search.md#search-exclusion
|
||||||
|
- insiders/index.md#how-to-become-a-sponsor
|
||||||
---
|
---
|
||||||
|
|
||||||
# Excluding content from search
|
# Excluding content from search
|
||||||
@ -15,22 +18,6 @@ __The latest Insiders release brings three new simple ways to exclude
|
|||||||
dedicated parts of a document from the search index, allowing for more
|
dedicated parts of a document from the search index, allowing for more
|
||||||
fine-grained control.__
|
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>
|
|
||||||
|
|
||||||
[@squidfunk avatar]: https://avatars.githubusercontent.com/u/932156
|
|
||||||
[insiders-3.1.1]: ../../insiders/changelog.md#3.1.1
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Two weeks ago, Material for MkDocs Insiders shipped a [brand new search
|
Two weeks ago, Material for MkDocs Insiders shipped a [brand new search
|
||||||
plugin], yielding [massive improvements in usability], but also in [speed
|
plugin], yielding [massive improvements in usability], but also in [speed
|
||||||
and size] of the search index. Interestingly, as discussed in the previous
|
and size] of the search index. Interestingly, as discussed in the previous
|
||||||
@ -39,6 +26,8 @@ release brings some useful features that enhance the writing experience,
|
|||||||
allowing for more fine-grained control of what pages, sections and blocks of a
|
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.
|
Markdown file should be indexed by the built-in search functionality.
|
||||||
|
|
||||||
|
<!-- more -->
|
||||||
|
|
||||||
_The following section discusses existing solutions for excluding pages and
|
_The following section discusses existing solutions for excluding pages and
|
||||||
sections from the search index. If you immediately want to learn what's new,
|
sections from the search index. If you immediately want to learn what's new,
|
||||||
skip to the [section just after that][what's new]._
|
skip to the [section just after that][what's new]._
|
||||||
@ -124,7 +113,7 @@ directive to the front matter of the respective Markdown file. The good thing
|
|||||||
is that the author now only has to check the top of the document to learn
|
is that the author now only has to check the top of the document to learn
|
||||||
whether it is excluded or not:
|
whether it is excluded or not:
|
||||||
|
|
||||||
``` sh
|
``` yaml
|
||||||
---
|
---
|
||||||
search:
|
search:
|
||||||
exclude: true
|
exclude: true
|
||||||
@ -137,11 +126,11 @@ search:
|
|||||||
### Excluding sections
|
### Excluding sections
|
||||||
|
|
||||||
If a section should be excluded, the author can use the [Attribute Lists]
|
If a section should be excluded, the author can use the [Attribute Lists]
|
||||||
extension to add a __pragma__ called `{ data-search-exclude }` at the end of a
|
extension to add a __pragma__ called `data-search-exclude` at the end of a
|
||||||
heading. The pragma is not included in the final HTML, as search pragmas are
|
heading. The pragma is not included in the final HTML, as search pragmas are
|
||||||
filtered by the search plugin before the page is rendered:
|
filtered by the search plugin before the page is rendered:
|
||||||
|
|
||||||
=== ":octicons-file-code-16: docs/page.md"
|
=== ":octicons-file-code-16: `docs/page.md`"
|
||||||
|
|
||||||
``` markdown
|
``` markdown
|
||||||
# Document title
|
# Document title
|
||||||
@ -155,7 +144,7 @@ filtered by the search plugin before the page is rendered:
|
|||||||
The content of this section is excluded
|
The content of this section is excluded
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-codescan-16: search_index.json"
|
=== ":octicons-codescan-16: `search_index.json`"
|
||||||
|
|
||||||
``` json
|
``` json
|
||||||
{
|
{
|
||||||
@ -181,7 +170,7 @@ If even more fine-grained control is desired, the __pragma__ can be added to
|
|||||||
any [block-level element] or [inline-level element] that is officially
|
any [block-level element] or [inline-level element] that is officially
|
||||||
supported by the [Attribute Lists] extension:
|
supported by the [Attribute Lists] extension:
|
||||||
|
|
||||||
=== ":octicons-file-code-16: docs/page.md"
|
=== ":octicons-file-code-16: `docs/page.md`"
|
||||||
|
|
||||||
``` markdown
|
``` markdown
|
||||||
# Document title
|
# Document title
|
||||||
@ -192,7 +181,7 @@ supported by the [Attribute Lists] extension:
|
|||||||
{ data-search-exclude }
|
{ data-search-exclude }
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-codescan-16: search_index.json"
|
=== ":octicons-codescan-16: `search_index.json`"
|
||||||
|
|
||||||
``` json
|
``` json
|
||||||
{
|
{
|
@ -1,12 +1,16 @@
|
|||||||
---
|
---
|
||||||
template: overrides/blog.html
|
date: 2021-09-13
|
||||||
|
authors: [squidfunk]
|
||||||
|
readtime: 15
|
||||||
description: >
|
description: >
|
||||||
How we rebuilt client-side search, delivering a better user experience while
|
How we rebuilt client-side search, delivering a better user experience while
|
||||||
making it faster and smaller at the same time
|
making it faster and smaller at the same time
|
||||||
search:
|
categories:
|
||||||
exclude: true
|
- Search
|
||||||
hide:
|
- Performance
|
||||||
- feedback
|
links:
|
||||||
|
- setup/setting-up-site-search.md#built-in-search-plugin
|
||||||
|
- insiders/index.md#how-to-become-a-sponsor
|
||||||
---
|
---
|
||||||
|
|
||||||
# Search: better, faster, smaller
|
# Search: better, faster, smaller
|
||||||
@ -15,22 +19,6 @@ __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
|
delivering a significantly better user experience while making it faster and
|
||||||
smaller at the same time.__
|
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>
|
|
||||||
|
|
||||||
[@squidfunk avatar]: https://avatars.githubusercontent.com/u/932156
|
|
||||||
[insiders-3.0.0]: ../../insiders/changelog.md#3.0.0
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
The [search] of Material for MkDocs is by far one of its best and most-loved
|
The [search] of Material for MkDocs is by far one of its best and most-loved
|
||||||
assets: [multilingual], [offline-capable], and most importantly: _all
|
assets: [multilingual], [offline-capable], and most importantly: _all
|
||||||
client-side_. It provides a solution to empower the users of your documentation
|
client-side_. It provides a solution to empower the users of your documentation
|
||||||
@ -41,6 +29,8 @@ 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
|
internals of the new search, why it's much more powerful than the previous
|
||||||
version, and what's about to come.
|
version, and what's about to come.
|
||||||
|
|
||||||
|
<!-- more -->
|
||||||
|
|
||||||
_The next section discusses the architecture and issues of the current search
|
_The next section discusses the architecture and issues of the current search
|
||||||
implementation. If you immediately want to learn what's new, skip to the
|
implementation. If you immediately want to learn what's new, skip to the
|
||||||
[section just after that][what's new]._
|
[section just after that][what's new]._
|
||||||
@ -78,7 +68,7 @@ the original Markdown file:
|
|||||||
|
|
||||||
??? example "Expand to inspect example"
|
??? example "Expand to inspect example"
|
||||||
|
|
||||||
=== ":octicons-file-code-16: docs/page.md"
|
=== ":octicons-file-code-16: `docs/page.md`"
|
||||||
|
|
||||||
```` markdown
|
```` markdown
|
||||||
# Example
|
# Example
|
||||||
@ -108,7 +98,7 @@ the original Markdown file:
|
|||||||
* Profit!
|
* Profit!
|
||||||
````
|
````
|
||||||
|
|
||||||
=== ":octicons-codescan-16: search_index.json"
|
=== ":octicons-codescan-16: `search_index.json`"
|
||||||
|
|
||||||
``` json
|
``` json
|
||||||
{
|
{
|
Before Width: | Height: | Size: 225 KiB After Width: | Height: | Size: 225 KiB |
Before Width: | Height: | Size: 174 KiB After Width: | Height: | Size: 174 KiB |
Before Width: | Height: | Size: 55 KiB After Width: | Height: | Size: 55 KiB |
@ -1,12 +1,11 @@
|
|||||||
---
|
---
|
||||||
template: overrides/blog.html
|
date: 2021-12-27
|
||||||
|
authors: [squidfunk]
|
||||||
description: >
|
description: >
|
||||||
2021 was a fantastic year for this project as we shipped many new awesome
|
2021 was a fantastic year for this project as we shipped many new awesome
|
||||||
features and made this project sustainable
|
features and made this project sustainable
|
||||||
search:
|
categories:
|
||||||
exclude: true
|
- General
|
||||||
hide:
|
|
||||||
- feedback
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# The past, present and future
|
# The past, present and future
|
||||||
@ -15,20 +14,6 @@ __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
|
features, saw significant user growth and leveraged GitHub Sponsors to make the
|
||||||
project sustainable.__
|
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>
|
|
||||||
|
|
||||||
[@squidfunk avatar]: https://avatars.githubusercontent.com/u/932156
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Today, together, [MkDocs] and Material for MkDocs are among the most popular
|
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
|
options when it comes to choosing a static site generator and theme for your
|
||||||
technical documentation project. Material for MkDocs ensures that your
|
technical documentation project. Material for MkDocs ensures that your
|
||||||
@ -38,6 +23,8 @@ 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
|
static site generators. However, we're far from the end, as 2022 is going to
|
||||||
bring some interesting new capabilities.
|
bring some interesting new capabilities.
|
||||||
|
|
||||||
|
<!-- more -->
|
||||||
|
|
||||||
_This article showcases all features that were added in 2021 and gives an
|
_This article showcases all features that were added in 2021 and gives an
|
||||||
outlook on what's going to drop in 2022. Additionally, it provides some context
|
outlook on what's going to drop in 2022. Additionally, it provides some context
|
||||||
on the history of the project._
|
on the history of the project._
|
||||||
@ -187,7 +174,7 @@ __55__ times, `mkdocs-material-insiders` was shipped __72__ times.
|
|||||||
[Color palette toggle]: ../../setup/changing-the-colors.md#color-palette-toggle
|
[Color palette toggle]: ../../setup/changing-the-colors.md#color-palette-toggle
|
||||||
[Content tabs: improved support]: ../../reference/content-tabs.md
|
[Content tabs: improved support]: ../../reference/content-tabs.md
|
||||||
[Content tabs: auto-linking]: ../../reference/content-tabs.md#linked-content-tabs
|
[Content tabs: auto-linking]: ../../reference/content-tabs.md#linked-content-tabs
|
||||||
[Cookie consent]: ../../setup/ensuring-data-privacy.md#native-cookie-consent
|
[Cookie consent]: ../../setup/ensuring-data-privacy.md#cookie-consent
|
||||||
[Custom admonition icons]: ../../reference/admonitions.md#admonition-icons
|
[Custom admonition icons]: ../../reference/admonitions.md#admonition-icons
|
||||||
[Dark mode support for images]: ../../reference/images.md#light-and-dark-mode
|
[Dark mode support for images]: ../../reference/images.md#light-and-dark-mode
|
||||||
[Dismissable announcement bar]: ../../setup/setting-up-the-header.md#mark-as-read
|
[Dismissable announcement bar]: ../../setup/setting-up-the-header.md#mark-as-read
|
Before Width: | Height: | Size: 94 KiB After Width: | Height: | Size: 94 KiB |
Before Width: | Height: | Size: 74 KiB After Width: | Height: | Size: 74 KiB |
Before Width: | Height: | Size: 93 KiB After Width: | Height: | Size: 93 KiB |
@ -15,8 +15,8 @@ modern CSS features like [custom properties] and [mask images].
|
|||||||
|
|
||||||
The following table lists all browsers for which Material for MkDocs offers full
|
The following table lists all browsers for which Material for MkDocs offers full
|
||||||
support, so it can be assumed that all features work without degradation. If you
|
support, so it can be assumed that all features work without degradation. If you
|
||||||
find a feature not to be working in a browser in the supported version range,
|
find that something doesn't look right in a browser which is in the supported
|
||||||
please [open an issue]:
|
version range, please [open an issue]:
|
||||||
|
|
||||||
<figure markdown>
|
<figure markdown>
|
||||||
|
|
||||||
|
@ -6,6 +6,38 @@ template: overrides/main.html
|
|||||||
|
|
||||||
## Material for MkDocs
|
## Material for MkDocs
|
||||||
|
|
||||||
|
### 8.5.2 <small>_ September 18, 2022</small> { id="8.5.2" }
|
||||||
|
|
||||||
|
- 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
|
||||||
|
|
||||||
|
### 8.5.1 <small>_ September 15, 2022</small> { id="8.5.1" }
|
||||||
|
|
||||||
|
- Fixed #4366: Removed dependencies with native extensions
|
||||||
|
|
||||||
|
### 8.5.0 <small>_ September 13, 2022</small> { id="8.5.0" }
|
||||||
|
|
||||||
|
- 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
|
||||||
|
|
||||||
|
### 8.4.4 <small>_ September 12, 2022</small> { id="8.4.4" }
|
||||||
|
|
||||||
|
- Moved comments integration to separate partial (`comments.html`)
|
||||||
|
|
||||||
|
### 8.4.3 <small>_ September 7, 2022</small> { id="8.4.3" }
|
||||||
|
|
||||||
|
- 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
|
||||||
|
|
||||||
### 8.4.2 <small>_ August 27, 2022</small> { id="8.4.2" }
|
### 8.4.2 <small>_ August 27, 2022</small> { id="8.4.2" }
|
||||||
|
|
||||||
- Updated Slovenian translations
|
- Updated Slovenian translations
|
||||||
|
@ -153,6 +153,7 @@ and much more:
|
|||||||
- [Setting up site search]
|
- [Setting up site search]
|
||||||
- [Setting up site analytics]
|
- [Setting up site analytics]
|
||||||
- [Setting up social cards]
|
- [Setting up social cards]
|
||||||
|
- [Setting up a blog]
|
||||||
- [Setting up tags]
|
- [Setting up tags]
|
||||||
- [Setting up versioning]
|
- [Setting up versioning]
|
||||||
- [Setting up the header]
|
- [Setting up the header]
|
||||||
@ -164,7 +165,7 @@ and much more:
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
Furthermore, see the list of supported [Markdown extensions] that are natively
|
Furthermore, see the list of supported [Markdown extensions] that are natively
|
||||||
integrated with Material for MkDocs, delivering a low-effort and unprecedented
|
integrated with Material for MkDocs, delivering an unprecedented low-effort
|
||||||
technical writing experience.
|
technical writing experience.
|
||||||
|
|
||||||
[Changing the colors]: setup/changing-the-colors.md
|
[Changing the colors]: setup/changing-the-colors.md
|
||||||
@ -176,6 +177,7 @@ technical writing experience.
|
|||||||
[Setting up site search]: setup/setting-up-site-search.md
|
[Setting up site search]: setup/setting-up-site-search.md
|
||||||
[Setting up site analytics]: setup/setting-up-site-analytics.md
|
[Setting up site analytics]: setup/setting-up-site-analytics.md
|
||||||
[Setting up social cards]: setup/setting-up-social-cards.md
|
[Setting up social cards]: setup/setting-up-social-cards.md
|
||||||
|
[Setting up a blog]: setup/setting-up-a-blog.md
|
||||||
[Setting up tags]: setup/setting-up-tags.md
|
[Setting up tags]: setup/setting-up-tags.md
|
||||||
[Setting up versioning]: setup/setting-up-versioning.md
|
[Setting up versioning]: setup/setting-up-versioning.md
|
||||||
[Setting up the header]: setup/setting-up-the-header.md
|
[Setting up the header]: setup/setting-up-the-header.md
|
||||||
|
@ -103,25 +103,37 @@ assets may also be put in the `overrides` directory:
|
|||||||
│ │ ├─ analytics/ # Analytics integrations
|
│ │ ├─ analytics/ # Analytics integrations
|
||||||
│ │ └─ analytics.html # Analytics setup
|
│ │ └─ analytics.html # Analytics setup
|
||||||
│ ├─ languages/ # Translation languages
|
│ ├─ languages/ # Translation languages
|
||||||
|
│ ├─ actions.html # Actions
|
||||||
|
│ ├─ comments.html # Comment system (empty by default)
|
||||||
|
│ ├─ consent.html # Consent
|
||||||
│ ├─ content.html # Page content
|
│ ├─ content.html # Page content
|
||||||
│ ├─ copyright.html # Copyright and theme information
|
│ ├─ copyright.html # Copyright and theme information
|
||||||
|
│ ├─ feedback.html # Was this page helpful?
|
||||||
│ ├─ footer.html # Footer bar
|
│ ├─ footer.html # Footer bar
|
||||||
│ ├─ header.html # Header bar
|
│ ├─ header.html # Header bar
|
||||||
|
│ ├─ icons.html # Custom icons
|
||||||
│ ├─ language.html # Translation setup
|
│ ├─ language.html # Translation setup
|
||||||
│ ├─ logo.html # Logo in header and sidebar
|
│ ├─ logo.html # Logo in header and sidebar
|
||||||
│ ├─ nav.html # Main navigation
|
│ ├─ nav.html # Main navigation
|
||||||
│ ├─ nav-item.html # Main navigation item
|
│ ├─ nav-item.html # Main navigation item
|
||||||
|
│ ├─ pagination.html # Pagination (used for blog)
|
||||||
│ ├─ palette.html # Color palette
|
│ ├─ palette.html # Color palette
|
||||||
|
│ ├─ post.html # Blog post excerpt
|
||||||
│ ├─ search.html # Search interface
|
│ ├─ search.html # Search interface
|
||||||
│ ├─ social.html # Social links
|
│ ├─ social.html # Social links
|
||||||
│ ├─ source.html # Repository information
|
│ ├─ source.html # Repository information
|
||||||
│ ├─ source-file.html # Source file information
|
│ ├─ source-file.html # Source file information
|
||||||
│ ├─ tabs.html # Tabs navigation
|
│ ├─ tabs.html # Tabs navigation
|
||||||
│ ├─ tabs-item.html # Tabs navigation item
|
│ ├─ tabs-item.html # Tabs navigation item
|
||||||
|
│ ├─ tags.html # Tags
|
||||||
│ ├─ toc.html # Table of contents
|
│ ├─ toc.html # Table of contents
|
||||||
│ └─ toc-item.html # Table of contents item
|
│ └─ toc-item.html # Table of contents item
|
||||||
├─ 404.html # 404 error page
|
├─ 404.html # 404 error page
|
||||||
├─ base.html # Base template
|
├─ base.html # Base template
|
||||||
|
├─ blog.html # Blog index page
|
||||||
|
├─ blog-archive.html # Blog archive index page
|
||||||
|
├─ blog-category.html # Blog category index page
|
||||||
|
├─ blog-post.html # Blog post page
|
||||||
└─ main.html # Default page
|
└─ main.html # Default page
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -170,6 +182,21 @@ Then, e.g. to override the site title, add the following lines to `main.html`:
|
|||||||
{% endblock %}
|
{% endblock %}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
If you intend to __add__ something to a block rather than to replace it
|
||||||
|
altogether with new content, use `{{ super() }}` inside the block to include the
|
||||||
|
original block content. This is particularly useful when adding third-party
|
||||||
|
scripts to your docs, e.g.
|
||||||
|
|
||||||
|
``` html
|
||||||
|
{% extends "base.html" %}
|
||||||
|
|
||||||
|
{% block scripts %}
|
||||||
|
<!-- Add scripts that need to run before here -->
|
||||||
|
{{ super() }}
|
||||||
|
<!-- Add scripts that need to run afterwards here -->
|
||||||
|
{% endblock %}
|
||||||
|
```
|
||||||
|
|
||||||
The following template blocks are provided by the theme:
|
The following template blocks are provided by the theme:
|
||||||
|
|
||||||
| Block name | Purpose |
|
| Block name | Purpose |
|
||||||
@ -177,6 +204,7 @@ The following template blocks are provided by the theme:
|
|||||||
| `analytics` | Wraps the Google Analytics integration |
|
| `analytics` | Wraps the Google Analytics integration |
|
||||||
| `announce` | Wraps the announcement bar |
|
| `announce` | Wraps the announcement bar |
|
||||||
| `config` | Wraps the JavaScript application config |
|
| `config` | Wraps the JavaScript application config |
|
||||||
|
| `container` | Wraps the main content container |
|
||||||
| `content` | Wraps the main content |
|
| `content` | Wraps the main content |
|
||||||
| `extrahead` | Empty block to add custom meta tags |
|
| `extrahead` | Empty block to add custom meta tags |
|
||||||
| `fonts` | Wraps the font definitions |
|
| `fonts` | Wraps the font definitions |
|
||||||
|
@ -1,6 +1,5 @@
|
|||||||
---
|
---
|
||||||
template: overrides/main.html
|
template: overrides/main.html
|
||||||
title: Getting started
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Getting started
|
# Getting started
|
||||||
@ -19,8 +18,8 @@ If not, we recommend using [`docker`][docker].
|
|||||||
### with pip <small>recommended</small> { #with-pip data-toc-label="with pip" }
|
### with pip <small>recommended</small> { #with-pip data-toc-label="with pip" }
|
||||||
|
|
||||||
Material for MkDocs is published as a [Python package] and can be installed with
|
Material for MkDocs is published as a [Python package] and can be installed with
|
||||||
`pip`, ideally by using a [virtual environment]. If not, scroll down and expand
|
`pip`, ideally by using a [virtual environment]. Open up a terminal and install
|
||||||
the help box. Install with:
|
Material for MkDocs with:
|
||||||
|
|
||||||
=== "Latest"
|
=== "Latest"
|
||||||
|
|
||||||
@ -38,7 +37,7 @@ the help box. Install with:
|
|||||||
good idea to limit upgrades to the current major version.
|
good idea to limit upgrades to the current major version.
|
||||||
|
|
||||||
This will make sure that you don't accidentally [upgrade to the next
|
This will make sure that you don't accidentally [upgrade to the next
|
||||||
major version], which may include breaking changes that silently break
|
major version], which may include breaking changes that silently corrupt
|
||||||
your site. Additionally, you can use `pip freeze` to create a lockfile,
|
your site. Additionally, you can use `pip freeze` to create a lockfile,
|
||||||
so builds are reproducible at all times:
|
so builds are reproducible at all times:
|
||||||
|
|
||||||
@ -81,8 +80,8 @@ troubleshoot if you run into errors.
|
|||||||
### with docker
|
### with docker
|
||||||
|
|
||||||
The official [Docker image] is a great way to get up and running in a few
|
The official [Docker image] is a great way to get up and running in a few
|
||||||
minutes, as it comes with all dependencies pre-installed. Pull the image for the
|
minutes, as it comes with all dependencies pre-installed. Open up a terminal
|
||||||
`latest` version with:
|
and pull the image with:
|
||||||
|
|
||||||
=== "Latest"
|
=== "Latest"
|
||||||
|
|
||||||
@ -151,8 +150,8 @@ want to use the very latest version:
|
|||||||
git clone https://github.com/squidfunk/mkdocs-material.git
|
git clone https://github.com/squidfunk/mkdocs-material.git
|
||||||
```
|
```
|
||||||
|
|
||||||
The theme will reside in the folder `mkdocs-material/material`. When cloning
|
The theme will reside in the folder `mkdocs-material/material`. After cloning
|
||||||
from `git`, you must install all required dependencies yourself:
|
from `git`, you must install all required dependencies with:
|
||||||
|
|
||||||
```
|
```
|
||||||
pip install -e mkdocs-material
|
pip install -e mkdocs-material
|
||||||
|
@ -6,6 +6,39 @@ template: overrides/main.html
|
|||||||
|
|
||||||
## Material for MkDocs Insiders
|
## Material for MkDocs Insiders
|
||||||
|
|
||||||
|
### 4.23.5 <small>_ September 18, 2022</small> { id="4.23.5" }
|
||||||
|
|
||||||
|
- Fixed #4367: Improved blog plugin date handling for MultiMarkdown syntax
|
||||||
|
- Fixed #4374: Fixed invalid URLs of related links to other blog posts
|
||||||
|
|
||||||
|
### 4.23.4 <small>_ September 14, 2022</small> { id="4.23.4" }
|
||||||
|
|
||||||
|
- Fixed #4365: Recursion error in blog plugin due to `deepcopy`
|
||||||
|
- Fixed path errors for blog plugin on Windows
|
||||||
|
- Fixed publishing workflow in forked repositories
|
||||||
|
|
||||||
|
### 4.23.3 <small>_ September 13, 2022</small> { id="4.23.3" }
|
||||||
|
|
||||||
|
- Fixed previous and next page links for drafts of blog posts
|
||||||
|
|
||||||
|
### 4.23.2 <small>_ September 13, 2022</small> { id="4.23.2" }
|
||||||
|
|
||||||
|
- 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
|
||||||
|
|
||||||
|
### 4.23.1 <small>_ September 12, 2022</small> { id="4.23.1" }
|
||||||
|
|
||||||
|
- Fixed #4345: Blog plugin errors with default settings
|
||||||
|
|
||||||
|
### 4.23.0 <small>_ September 12, 2022</small> { id="4.23.0" }
|
||||||
|
|
||||||
|
- Added blogging support via built-in blog plugin
|
||||||
|
|
||||||
|
### 4.22.1 <small>_ September 7, 2022</small> { id="4.22.1" }
|
||||||
|
|
||||||
|
- Fixed #4217: Tooltips in data tables render in wrong position
|
||||||
|
|
||||||
### 4.22.0 <small>_ August 21, 2022</small> { id="4.22.0" }
|
### 4.22.0 <small>_ August 21, 2022</small> { id="4.22.0" }
|
||||||
|
|
||||||
- Added support for navigation status
|
- Added support for navigation status
|
||||||
|
@ -97,10 +97,9 @@ docker pull ghcr.io/${GH_USERNAME}/mkdocs-material-insiders
|
|||||||
dedicated token which you'll only use for publishing the Docker image.
|
dedicated token which you'll only use for publishing the Docker image.
|
||||||
|
|
||||||
[^5]:
|
[^5]:
|
||||||
The Insiders repository contains three GitHub Actions workflows:
|
The Insiders repository contains two GitHub Actions workflows:
|
||||||
|
|
||||||
- `build.yml` – Build and lint the project (disabled on forks)
|
- `build.yml` – Build and lint the project (disabled on forks)
|
||||||
- `documentation.yml` – Build and deploy the documentation (disabled on forks)
|
|
||||||
- `publish.yml` – Build and publish the Docker image
|
- `publish.yml` – Build and publish the Docker image
|
||||||
|
|
||||||
### with git
|
### with git
|
||||||
@ -162,7 +161,7 @@ necessary to split the `mkdocs.yml` configuration into a base configuration, and
|
|||||||
one with plugin overrides. Note that this is a limitation of MkDocs, which can
|
one with plugin overrides. Note that this is a limitation of MkDocs, which can
|
||||||
be mitigated by using [configuration inheritance]:
|
be mitigated by using [configuration inheritance]:
|
||||||
|
|
||||||
=== ":octicons-file-code-16: mkdocs.insiders.yml"
|
=== ":octicons-file-code-16: `mkdocs.insiders.yml`"
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
INHERIT: mkdocs.yml
|
INHERIT: mkdocs.yml
|
||||||
@ -172,7 +171,7 @@ be mitigated by using [configuration inheritance]:
|
|||||||
- tags
|
- tags
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: mkdocs.yml"
|
=== ":octicons-file-code-16: `mkdocs.yml`"
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
# Configuration with everything except Insiders plugins
|
# Configuration with everything except Insiders plugins
|
||||||
@ -192,7 +191,7 @@ mkdocs build --config-file mkdocs.insiders.yml
|
|||||||
the alternative key-value syntax in both files. The above example would
|
the alternative key-value syntax in both files. The above example would
|
||||||
then look like:
|
then look like:
|
||||||
|
|
||||||
=== ":octicons-file-code-16: mkdocs.insiders.yml"
|
=== ":octicons-file-code-16: `mkdocs.insiders.yml`"
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
INHERIT: mkdocs.yml
|
INHERIT: mkdocs.yml
|
||||||
@ -200,7 +199,7 @@ mkdocs build --config-file mkdocs.insiders.yml
|
|||||||
social: {}
|
social: {}
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: mkdocs.yml"
|
=== ":octicons-file-code-16 `mkdocs.yml`"
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
# Additional configuration above
|
# Additional configuration above
|
||||||
|
@ -82,36 +82,32 @@ a handful of them, [thanks to our awesome sponsors]!
|
|||||||
## What's in for me?
|
## What's in for me?
|
||||||
|
|
||||||
The moment you [become a sponsor][how to become a sponsor], you'll get __immediate
|
The moment you [become a sponsor][how to become a sponsor], you'll get __immediate
|
||||||
access to 25 additional features__ that you can start using right away, and
|
access to 21 additional features__ that you can start using right away, and
|
||||||
which are currently exclusively available to sponsors:
|
which are currently exclusively available to sponsors:
|
||||||
|
|
||||||
<div class="mdx-columns" markdown>
|
<div class="mdx-columns" markdown>
|
||||||
|
|
||||||
|
- [x] [Blog plugin] :material-alert-decagram:{ .mdx-pulse title="Added on September 12, 2022" }
|
||||||
|
- [x] [Blog plugin: related links] :material-alert-decagram:{ .mdx-pulse title="Added on September 12, 2022" }
|
||||||
- [x] [Navigation status] :material-alert-decagram:{ .mdx-pulse title="Added on August 21, 2022" }
|
- [x] [Navigation status] :material-alert-decagram:{ .mdx-pulse title="Added on August 21, 2022" }
|
||||||
- [x] [Meta plugin] :material-alert-decagram:{ .mdx-pulse title="Added on July 17, 2022" }
|
- [x] [Meta plugin] :material-alert-decagram:{ .mdx-pulse title="Added on July 17, 2022" }
|
||||||
- [x] [Additional tags indexes] :material-alert-decagram:{ .mdx-pulse title="Added on July 7, 2022" }
|
- [x] [Tags plugin: additional indexes]
|
||||||
- [x] [Document contributors]
|
- [x] [Document contributors]
|
||||||
- [x] [Automatic light / dark mode]
|
- [x] [Automatic light / dark mode]
|
||||||
- [x] [Content tabs: anchor links]
|
- [x] [Content tabs: anchor links]
|
||||||
- [x] [Navigation pruning]
|
- [x] [Navigation pruning]
|
||||||
- [x] [Tooltips]
|
- [x] [Tooltips]
|
||||||
- [x] [Chinese search support]
|
- [x] [Chinese search support]
|
||||||
- [x] [Tag icons]
|
|
||||||
- [x] [Card grids]
|
- [x] [Card grids]
|
||||||
- [x] [Offline plugin]
|
- [x] [Offline plugin]
|
||||||
- [x] [Privacy plugin]
|
- [x] [Privacy plugin]
|
||||||
- [x] [Table of contents anchor following]
|
|
||||||
- [x] [Annotations]
|
- [x] [Annotations]
|
||||||
- [x] [Navigation icons]
|
- [x] [Navigation icons]
|
||||||
- [x] Sidebars automatically scroll to active item
|
|
||||||
- [x] [Code annotations: anchor links]
|
|
||||||
- [x] [Code annotations: strip comments]
|
|
||||||
- [x] [Brand new search plugin]
|
- [x] [Brand new search plugin]
|
||||||
- [x] [Rich search previews]
|
- [x] [Rich search previews]
|
||||||
- [x] [Tokenizer with lookahead]
|
- [x] [Tokenizer with lookahead]
|
||||||
- [x] [Advanced search highlighting]
|
- [x] [Advanced search highlighting]
|
||||||
- [x] [Excluding content from search]
|
- [x] [Excluding content from search]
|
||||||
- [x] [Social cards]
|
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -182,6 +178,8 @@ You can cancel your sponsorship anytime.[^5]
|
|||||||
[![IP Fabric]](https://ipfabric.io/){ target=_blank title="IP Fabric" }
|
[![IP Fabric]](https://ipfabric.io/){ target=_blank title="IP Fabric" }
|
||||||
[![Apex.AI]](https://www.apex.ai/){ target=_blank title="Apex.AI" }
|
[![Apex.AI]](https://www.apex.ai/){ target=_blank title="Apex.AI" }
|
||||||
[![Jitterbit]](https://jitterbit.com/){ target=_blank title="Jitterbit" }
|
[![Jitterbit]](https://jitterbit.com/){ target=_blank title="Jitterbit" }
|
||||||
|
[![Sparkfun]](https://sparkfun.com/){ target=_blank title="Sparkfun Electronics" }
|
||||||
|
[![Automation Technology]](https://automationtechnology.de/){ target=_blank title="Automation Technology" }
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -206,6 +204,8 @@ You can cancel your sponsorship anytime.[^5]
|
|||||||
[IP Fabric]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-ip-fabric.png
|
[IP Fabric]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-ip-fabric.png
|
||||||
[Apex.AI]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-apex-ai.png
|
[Apex.AI]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-apex-ai.png
|
||||||
[Jitterbit]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-jitterbit.png
|
[Jitterbit]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-jitterbit.png
|
||||||
|
[Sparkfun]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-sparkfun.png
|
||||||
|
[Automation Technology]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-automation-technology.png
|
||||||
|
|
||||||
<hr />
|
<hr />
|
||||||
|
|
||||||
@ -232,21 +232,6 @@ features prefixed with a checkmark symbol, denoting whether a feature is
|
|||||||
:octicons-check-circle-fill-24:{ style="color: var(--md-default-fg-color--lightest)" } planned, but not yet implemented. When the funding goal is hit, the features
|
:octicons-check-circle-fill-24:{ style="color: var(--md-default-fg-color--lightest)" } planned, but not yet implemented. When the funding goal is hit, the features
|
||||||
are released for general availability.
|
are released for general availability.
|
||||||
|
|
||||||
#### $ 8,000 – Scotch Bonnet
|
|
||||||
|
|
||||||
- [x] [Social cards]
|
|
||||||
- [x] [Code annotations: anchor links]
|
|
||||||
- [x] [Code annotations: strip comments]
|
|
||||||
- [x] [Tag icons]
|
|
||||||
- [x] [Table of contents anchor following]
|
|
||||||
- [x] Sidebars automatically scroll to active item
|
|
||||||
|
|
||||||
[Social cards]: ../setup/setting-up-social-cards.md
|
|
||||||
[Code annotations: anchor links]: ../reference/code-blocks.md#anchor-links
|
|
||||||
[Code annotations: strip comments]: ../reference/code-blocks.md#stripping-comments
|
|
||||||
[Tag icons]: ../setup/setting-up-tags.md#tag-icons
|
|
||||||
[Table of contents anchor following]: ../setup/setting-up-navigation.md#anchor-following
|
|
||||||
|
|
||||||
#### $ 10,000 – Carolina Reaper
|
#### $ 10,000 – Carolina Reaper
|
||||||
|
|
||||||
- [x] [Brand new search plugin]
|
- [x] [Brand new search plugin]
|
||||||
@ -256,24 +241,25 @@ are released for general availability.
|
|||||||
- [x] [Excluding content from search]
|
- [x] [Excluding content from search]
|
||||||
- [x] [Offline plugin]
|
- [x] [Offline plugin]
|
||||||
|
|
||||||
[Brand new search plugin]: ../blog/2021/search-better-faster-smaller.md
|
[Brand new search plugin]: ../blog/posts/search-better-faster-smaller.md
|
||||||
[Rich search previews]: ../blog/2021/search-better-faster-smaller.md#rich-search-previews
|
[Rich search previews]: ../blog/posts/search-better-faster-smaller.md#rich-search-previews
|
||||||
[Tokenizer with lookahead]: ../blog/2021/search-better-faster-smaller.md#tokenizer-lookahead
|
[Tokenizer with lookahead]: ../blog/posts/search-better-faster-smaller.md#tokenizer-lookahead
|
||||||
[Advanced search highlighting]: ../blog/2021/search-better-faster-smaller.md#accurate-highlighting
|
[Advanced search highlighting]: ../blog/posts/search-better-faster-smaller.md#accurate-highlighting
|
||||||
[Excluding content from search]: ../setup/setting-up-site-search.md#search-exclusion
|
[Excluding content from search]: ../setup/setting-up-site-search.md#search-exclusion
|
||||||
[Offline plugin]: ../setup/building-for-offline-usage.md
|
[Offline plugin]: ../setup/building-for-offline-usage.md
|
||||||
|
|
||||||
#### $ 12,000 – Piri Piri
|
#### $ 12,000 – Piri Piri
|
||||||
|
|
||||||
- [x] [Annotations]
|
- [x] [Blog plugin]
|
||||||
- [x] [Chinese search support]
|
- [x] [Chinese search support]
|
||||||
|
- [x] [Annotations]
|
||||||
- [x] [Navigation icons]
|
- [x] [Navigation icons]
|
||||||
- [x] [Navigation pruning]
|
- [x] [Navigation pruning]
|
||||||
- [x] [Navigation status]
|
- [x] [Navigation status]
|
||||||
- [ ] Blog plugin
|
|
||||||
|
|
||||||
|
[Blog plugin]: ../setup/setting-up-a-blog.md
|
||||||
|
[Chinese search support]: ../blog/posts/chinese-search-support.md
|
||||||
[Annotations]: ../reference/annotations.md
|
[Annotations]: ../reference/annotations.md
|
||||||
[Chinese search support]: ../blog/2022/chinese-search-support.md
|
|
||||||
[Navigation icons]: ../reference/index.md#setting-the-page-icon
|
[Navigation icons]: ../reference/index.md#setting-the-page-icon
|
||||||
[Navigation pruning]: ../setup/setting-up-navigation.md#navigation-pruning
|
[Navigation pruning]: ../setup/setting-up-navigation.md#navigation-pruning
|
||||||
[Navigation status]: ../reference/index.md#setting-the-page-status
|
[Navigation status]: ../reference/index.md#setting-the-page-status
|
||||||
@ -297,13 +283,16 @@ are released for general availability.
|
|||||||
#### $ 16,000 – Chipotle
|
#### $ 16,000 – Chipotle
|
||||||
|
|
||||||
- [x] [Meta plugin]
|
- [x] [Meta plugin]
|
||||||
- [x] [Additional tags indexes]
|
- [x] [Blog plugin: related links]
|
||||||
|
- [x] [Tags plugin: additional indexes]
|
||||||
- [ ] [Instant previews]
|
- [ ] [Instant previews]
|
||||||
|
- [ ] Navigation subtitles
|
||||||
- [ ] ... more to be announced
|
- [ ] ... more to be announced
|
||||||
|
|
||||||
[Meta plugin]: ../reference/index.md#built-in-meta-plugin
|
[Meta plugin]: ../reference/index.md#built-in-meta-plugin
|
||||||
[Additional tags indexes]: ../setup/setting-up-tags.md#tags-extra-files
|
[Tags plugin: additional indexes]: ../setup/setting-up-tags.md#+tags.tags_extra_files
|
||||||
[Instant previews]: https://twitter.com/squidfunk/status/1466794654213492743
|
[Instant previews]: https://twitter.com/squidfunk/status/1466794654213492743
|
||||||
|
[Blog plugin: related links]: ../setup/setting-up-a-blog.md#adding-related-links
|
||||||
|
|
||||||
### Goals completed
|
### Goals completed
|
||||||
|
|
||||||
@ -311,13 +300,28 @@ This section lists all funding goals that were previously completed, which means
|
|||||||
that those features were part of Insiders, but are now generally available and
|
that those features were part of Insiders, but are now generally available and
|
||||||
can be used by all users.
|
can be used by all users.
|
||||||
|
|
||||||
|
#### $ 8,000 – Scotch Bonnet
|
||||||
|
|
||||||
|
- [x] [Social cards]
|
||||||
|
- [x] [Code annotations: anchor links]
|
||||||
|
- [x] [Code annotations: strip comments]
|
||||||
|
- [x] [Tag icons]
|
||||||
|
- [x] [Table of contents anchor following]
|
||||||
|
- [x] Sidebars automatically scroll to active item
|
||||||
|
|
||||||
|
[Social cards]: ../setup/setting-up-social-cards.md
|
||||||
|
[Code annotations: anchor links]: ../reference/code-blocks.md#anchor-links
|
||||||
|
[Code annotations: strip comments]: ../reference/code-blocks.md#stripping-comments
|
||||||
|
[Tag icons]: ../setup/setting-up-tags.md#tag-icons
|
||||||
|
[Table of contents anchor following]: ../setup/setting-up-navigation.md#anchor-following
|
||||||
|
|
||||||
#### $ 7,000 – Royal Gold
|
#### $ 7,000 – Royal Gold
|
||||||
|
|
||||||
- [x] [Cookie consent]
|
- [x] [Cookie consent]
|
||||||
- [x] [Was this page helpful?]
|
- [x] [Was this page helpful?]
|
||||||
- [x] [Dismissable announcement bar]
|
- [x] [Dismissable announcement bar]
|
||||||
|
|
||||||
[Cookie consent]: ../setup/ensuring-data-privacy.md#native-cookie-consent
|
[Cookie consent]: ../setup/ensuring-data-privacy.md#cookie-consent
|
||||||
[Was this page helpful?]: ../setup/setting-up-site-analytics.md#was-this-page-helpful
|
[Was this page helpful?]: ../setup/setting-up-site-analytics.md#was-this-page-helpful
|
||||||
[Dismissable announcement bar]: ../setup/setting-up-the-header.md#mark-as-read
|
[Dismissable announcement bar]: ../setup/setting-up-the-header.md#mark-as-read
|
||||||
|
|
||||||
|
@ -35,7 +35,7 @@ See additional configuration options:
|
|||||||
|
|
||||||
### Admonition icons
|
### Admonition icons
|
||||||
|
|
||||||
[:octicons-tag-24: 8.3.0][icon support] ·
|
[:octicons-tag-24: 8.3.0][Admonition icons support] ·
|
||||||
:octicons-beaker-24: Experimental
|
:octicons-beaker-24: Experimental
|
||||||
|
|
||||||
Each of the supported admonition types has a distinct icon, which can be changed
|
Each of the supported admonition types has a distinct icon, which can be changed
|
||||||
@ -103,7 +103,7 @@ theme:
|
|||||||
quote: fontawesome/solid/quote-left
|
quote: fontawesome/solid/quote-left
|
||||||
```
|
```
|
||||||
|
|
||||||
[icon support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.3.0
|
[Admonition icons support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.3.0
|
||||||
[custom icon]: ../setup/changing-the-logo-and-icons.md#additional-icons
|
[custom icon]: ../setup/changing-the-logo-and-icons.md#additional-icons
|
||||||
[supported types]: #supported-types
|
[supported types]: #supported-types
|
||||||
[icon search]: icons-emojis.md#search
|
[icon search]: icons-emojis.md#search
|
||||||
@ -231,7 +231,7 @@ Adding a `+` after the `???` token renders the block expanded:
|
|||||||
|
|
||||||
### Inline blocks
|
### Inline blocks
|
||||||
|
|
||||||
[:octicons-tag-24: 7.0.0][Inline support] ·
|
[:octicons-tag-24: 7.0.0][Inline blocks support] ·
|
||||||
:octicons-beaker-24: Experimental
|
:octicons-beaker-24: Experimental
|
||||||
|
|
||||||
Admonitions can also be rendered as inline blocks (i.e. for sidebars), placing
|
Admonitions can also be rendered as inline blocks (i.e. for sidebars), placing
|
||||||
@ -283,14 +283,14 @@ prior to the content block you want to place them beside. If there's
|
|||||||
insufficient space to render the admonition next to the block, the admonition
|
insufficient space to render the admonition next to the block, the admonition
|
||||||
will stretch to the full width of the viewport, e.g. on mobile viewports.
|
will stretch to the full width of the viewport, e.g. on mobile viewports.
|
||||||
|
|
||||||
[Inline support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.0.0
|
[Inline blocks support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.0.0
|
||||||
|
|
||||||
### Supported types
|
### Supported types
|
||||||
|
|
||||||
Following is a list of type qualifiers provided by Material for MkDocs, whereas
|
Following is a list of type qualifiers provided by Material for MkDocs, whereas
|
||||||
the default type, and thus fallback for unknown type qualifiers, is `note`:
|
the default type, and thus fallback for unknown type qualifiers, is `note`:
|
||||||
|
|
||||||
`note`{ #type-note }
|
[`note`](#type:note){ #type:note }
|
||||||
|
|
||||||
: !!! note
|
: !!! note
|
||||||
|
|
||||||
@ -298,7 +298,7 @@ the default type, and thus fallback for unknown type qualifiers, is `note`:
|
|||||||
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
|
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
|
||||||
purus auctor massa, nec semper lorem quam in massa.
|
purus auctor massa, nec semper lorem quam in massa.
|
||||||
|
|
||||||
`abstract`{ #type-abstract }, `summary`, `tldr`
|
[`abstract`](#type:abstract){ #type:abstract }, `summary`, `tldr`
|
||||||
|
|
||||||
: !!! abstract
|
: !!! abstract
|
||||||
|
|
||||||
@ -306,7 +306,7 @@ the default type, and thus fallback for unknown type qualifiers, is `note`:
|
|||||||
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
|
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
|
||||||
purus auctor massa, nec semper lorem quam in massa.
|
purus auctor massa, nec semper lorem quam in massa.
|
||||||
|
|
||||||
`info`{ #type-info }, `todo`
|
[`info`](#type:info){ #type:info }, `todo`
|
||||||
|
|
||||||
: !!! info
|
: !!! info
|
||||||
|
|
||||||
@ -314,7 +314,7 @@ the default type, and thus fallback for unknown type qualifiers, is `note`:
|
|||||||
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
|
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
|
||||||
purus auctor massa, nec semper lorem quam in massa.
|
purus auctor massa, nec semper lorem quam in massa.
|
||||||
|
|
||||||
`tip`{ #type-tip }, `hint`, `important`
|
[`tip`](#type:tip){ #type:tip }, `hint`, `important`
|
||||||
|
|
||||||
: !!! tip
|
: !!! tip
|
||||||
|
|
||||||
@ -322,7 +322,7 @@ the default type, and thus fallback for unknown type qualifiers, is `note`:
|
|||||||
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
|
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
|
||||||
purus auctor massa, nec semper lorem quam in massa.
|
purus auctor massa, nec semper lorem quam in massa.
|
||||||
|
|
||||||
`success`{ #type-success }, `check`, `done`
|
[`success`](#type:success){ #type:success }, `check`, `done`
|
||||||
|
|
||||||
: !!! success
|
: !!! success
|
||||||
|
|
||||||
@ -330,7 +330,7 @@ the default type, and thus fallback for unknown type qualifiers, is `note`:
|
|||||||
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
|
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
|
||||||
purus auctor massa, nec semper lorem quam in massa.
|
purus auctor massa, nec semper lorem quam in massa.
|
||||||
|
|
||||||
`question`{ #type-question }, `help`, `faq`
|
[`question`](#type:question){ #type:question }, `help`, `faq`
|
||||||
|
|
||||||
: !!! question
|
: !!! question
|
||||||
|
|
||||||
@ -338,7 +338,7 @@ the default type, and thus fallback for unknown type qualifiers, is `note`:
|
|||||||
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
|
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
|
||||||
purus auctor massa, nec semper lorem quam in massa.
|
purus auctor massa, nec semper lorem quam in massa.
|
||||||
|
|
||||||
`warning`{ #type-warning }, `caution`, `attention`
|
[`warning`](#type:warning){ #type:warning }, `caution`, `attention`
|
||||||
|
|
||||||
: !!! warning
|
: !!! warning
|
||||||
|
|
||||||
@ -346,7 +346,7 @@ the default type, and thus fallback for unknown type qualifiers, is `note`:
|
|||||||
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
|
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
|
||||||
purus auctor massa, nec semper lorem quam in massa.
|
purus auctor massa, nec semper lorem quam in massa.
|
||||||
|
|
||||||
`failure`{ #type-failure }, `fail`, `missing`
|
[`failure`](#type:failure){ #type:failure }, `fail`, `missing`
|
||||||
|
|
||||||
: !!! failure
|
: !!! failure
|
||||||
|
|
||||||
@ -354,7 +354,7 @@ the default type, and thus fallback for unknown type qualifiers, is `note`:
|
|||||||
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
|
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
|
||||||
purus auctor massa, nec semper lorem quam in massa.
|
purus auctor massa, nec semper lorem quam in massa.
|
||||||
|
|
||||||
`danger`{ #type-danger }, `error`
|
[`danger`](#type:danger){ #type:danger }, `error`
|
||||||
|
|
||||||
: !!! danger
|
: !!! danger
|
||||||
|
|
||||||
@ -362,7 +362,7 @@ the default type, and thus fallback for unknown type qualifiers, is `note`:
|
|||||||
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
|
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
|
||||||
purus auctor massa, nec semper lorem quam in massa.
|
purus auctor massa, nec semper lorem quam in massa.
|
||||||
|
|
||||||
`bug`{ #type-bug }
|
[`bug`](#type:bug){ #type:bug }
|
||||||
|
|
||||||
: !!! bug
|
: !!! bug
|
||||||
|
|
||||||
@ -370,7 +370,7 @@ the default type, and thus fallback for unknown type qualifiers, is `note`:
|
|||||||
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
|
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
|
||||||
purus auctor massa, nec semper lorem quam in massa.
|
purus auctor massa, nec semper lorem quam in massa.
|
||||||
|
|
||||||
`example`{ #type-example }
|
[`example`](#type:example){ #type:example }
|
||||||
|
|
||||||
: !!! example
|
: !!! example
|
||||||
|
|
||||||
@ -378,7 +378,7 @@ the default type, and thus fallback for unknown type qualifiers, is `note`:
|
|||||||
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
|
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
|
||||||
purus auctor massa, nec semper lorem quam in massa.
|
purus auctor massa, nec semper lorem quam in massa.
|
||||||
|
|
||||||
`quote`{ #type-quote }, `cite`
|
[`quote`](#type:quote){ #type:quote }, `cite`
|
||||||
|
|
||||||
: !!! quote
|
: !!! quote
|
||||||
|
|
||||||
@ -414,7 +414,7 @@ and add the following CSS to an [additional style sheet]:
|
|||||||
}
|
}
|
||||||
</style>
|
</style>
|
||||||
|
|
||||||
=== ":octicons-file-code-16: docs/stylesheets/extra.css"
|
=== ":octicons-file-code-16: `docs/stylesheets/extra.css`"
|
||||||
|
|
||||||
``` css
|
``` css
|
||||||
:root {
|
:root {
|
||||||
@ -436,7 +436,7 @@ and add the following CSS to an [additional style sheet]:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: mkdocs.yml"
|
=== ":octicons-file-code-16: `mkdocs.yml`"
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
extra_css:
|
extra_css:
|
||||||
|
@ -83,13 +83,12 @@ theme:
|
|||||||
|
|
||||||
#### Anchor links
|
#### Anchor links
|
||||||
|
|
||||||
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
|
[:octicons-tag-24: 8.5.0][Anchor links support] ·
|
||||||
[:octicons-tag-24: insiders-4.4.0][Insiders] ·
|
|
||||||
:octicons-beaker-24: Experimental
|
:octicons-beaker-24: Experimental
|
||||||
|
|
||||||
In order to link to code annotations and share them more easily, [Insiders] adds
|
In order to be able to link to code annotations and share them more easily, an
|
||||||
an anchor link to each annotation automatically, which you can copy via right
|
anchor link is automatically added to each annotation, which you can copy via
|
||||||
click or open in a new tab:
|
right click or open in a new tab:
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
# (1)!
|
# (1)!
|
||||||
@ -99,7 +98,7 @@ click or open in a new tab:
|
|||||||
rendered open in a new tab. You can also right-click me to __copy link
|
rendered open in a new tab. You can also right-click me to __copy link
|
||||||
address__ to share me with others.
|
address__ to share me with others.
|
||||||
|
|
||||||
[Insiders]: ../insiders/index.md
|
[Anchor links support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.5.0
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
@ -126,8 +125,6 @@ import tensorflow as tf
|
|||||||
|
|
||||||
### Adding a title
|
### Adding a title
|
||||||
|
|
||||||
[:octicons-tag-24: 7.3.6][Title support]
|
|
||||||
|
|
||||||
In order to provide additional context, a custom title can be added to a code
|
In order to provide additional context, a custom title can be added to a code
|
||||||
block by using the `title="<custom title>"` option directly after the shortcode,
|
block by using the `title="<custom title>"` option directly after the shortcode,
|
||||||
e.g. to display the name of a file:
|
e.g. to display the name of a file:
|
||||||
@ -154,8 +151,6 @@ def bubble_sort(items):
|
|||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
[Title support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.3.6
|
|
||||||
|
|
||||||
### Adding annotations
|
### Adding annotations
|
||||||
|
|
||||||
Code annotations can be placed anywhere in a code block where a comment for the
|
Code annotations can be placed anywhere in a code block where a comment for the
|
||||||
@ -195,13 +190,11 @@ theme:
|
|||||||
|
|
||||||
#### Stripping comments
|
#### Stripping comments
|
||||||
|
|
||||||
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
|
[:octicons-tag-24: 8.5.0][Stripping comments support] ·
|
||||||
[:octicons-tag-24: insiders-4.4.0][Insiders] ·
|
|
||||||
:octicons-beaker-24: Experimental
|
:octicons-beaker-24: Experimental
|
||||||
|
|
||||||
If you wish to strip the comment characters surrounding a code annotation,
|
If you wish to strip the comment characters surrounding a code annotation,
|
||||||
[Insiders] adds a new syntax that allows for just that. Simply add an `!` after
|
simply add an `!` after the closing parenthesis of the code annotation:
|
||||||
the closing parens of the code annotation:
|
|
||||||
|
|
||||||
```` markdown title="Code block with annotation, stripped"
|
```` markdown title="Code block with annotation, stripped"
|
||||||
``` yaml
|
``` yaml
|
||||||
@ -225,6 +218,8 @@ Note that this only allows for a single code annotation to be rendered per
|
|||||||
comment. If you want to add multiple code annotations, comments cannot be
|
comment. If you want to add multiple code annotations, comments cannot be
|
||||||
stripped for technical reasons.
|
stripped for technical reasons.
|
||||||
|
|
||||||
|
[Stripping comments support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.5.0
|
||||||
|
|
||||||
### Adding line numbers
|
### Adding line numbers
|
||||||
|
|
||||||
Line numbers can be added to a code block by using the `linenums="<start>"`
|
Line numbers can be added to a code block by using the `linenums="<start>"`
|
||||||
@ -354,7 +349,7 @@ Let's say you want to change the color of `#!js "strings"`. While there are
|
|||||||
several [types of string tokens], they use the same color. You can assign
|
several [types of string tokens], they use the same color. You can assign
|
||||||
a new color by using an [additional style sheet]:
|
a new color by using an [additional style sheet]:
|
||||||
|
|
||||||
=== ":octicons-file-code-16: docs/stylesheets/extra.css"
|
=== ":octicons-file-code-16: `docs/stylesheets/extra.css`"
|
||||||
|
|
||||||
``` css
|
``` css
|
||||||
:root > * {
|
:root > * {
|
||||||
@ -362,7 +357,7 @@ a new color by using an [additional style sheet]:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: mkdocs.yml"
|
=== ":octicons-file-code-16: `mkdocs.yml`"
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
extra_css:
|
extra_css:
|
||||||
@ -373,7 +368,7 @@ If you want to tweak a specific type of string, e.g. ``#!js `backticks` ``, you
|
|||||||
can lookup the specific CSS class name in the [syntax theme definition], and
|
can lookup the specific CSS class name in the [syntax theme definition], and
|
||||||
override it as part of your [additional style sheet]:
|
override it as part of your [additional style sheet]:
|
||||||
|
|
||||||
=== ":octicons-file-code-16: docs/stylesheets/extra.css"
|
=== ":octicons-file-code-16: `docs/stylesheets/extra.css`"
|
||||||
|
|
||||||
``` css
|
``` css
|
||||||
.highlight .sb {
|
.highlight .sb {
|
||||||
@ -381,7 +376,7 @@ override it as part of your [additional style sheet]:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: mkdocs.yml"
|
=== ":octicons-file-code-16: `mkdocs.yml`"
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
extra_css:
|
extra_css:
|
||||||
@ -400,7 +395,7 @@ If you have a lot of content hosted inside your code annotations, it can be a
|
|||||||
good idea to increase the width of the tooltip by adding the following as part
|
good idea to increase the width of the tooltip by adding the following as part
|
||||||
of an [additional style sheet]:
|
of an [additional style sheet]:
|
||||||
|
|
||||||
=== ":octicons-file-code-16: docs/stylesheets/extra.css"
|
=== ":octicons-file-code-16: `docs/stylesheets/extra.css`"
|
||||||
|
|
||||||
``` css
|
``` css
|
||||||
:root {
|
:root {
|
||||||
@ -408,7 +403,7 @@ of an [additional style sheet]:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: mkdocs.yml"
|
=== ":octicons-file-code-16: `mkdocs.yml`"
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
extra_css:
|
extra_css:
|
||||||
@ -439,7 +434,7 @@ will close them.
|
|||||||
If you wish to revert to the prior behavior and display code annotation numbers,
|
If you wish to revert to the prior behavior and display code annotation numbers,
|
||||||
you can add an [additional style sheet] and copy and paste the following CSS:
|
you can add an [additional style sheet] and copy and paste the following CSS:
|
||||||
|
|
||||||
=== ":octicons-file-code-16: docs/stylesheets/extra.css"
|
=== ":octicons-file-code-16: `docs/stylesheets/extra.css`"
|
||||||
|
|
||||||
``` css
|
``` css
|
||||||
.md-typeset .md-annotation__index > ::before {
|
.md-typeset .md-annotation__index > ::before {
|
||||||
@ -450,7 +445,7 @@ you can add an [additional style sheet] and copy and paste the following CSS:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: mkdocs.yml"
|
=== ":octicons-file-code-16: `mkdocs.yml`"
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
extra_css:
|
extra_css:
|
||||||
|
@ -57,7 +57,7 @@ or to the [publishing guide for Insiders][tab_2].
|
|||||||
|
|
||||||
### Linked content tabs
|
### Linked content tabs
|
||||||
|
|
||||||
[:octicons-tag-24: 8.3.0][link support] ·
|
[:octicons-tag-24: 8.3.0][Linked content tabs support] ·
|
||||||
:octicons-unlock-24: Feature flag ·
|
:octicons-unlock-24: Feature flag ·
|
||||||
:octicons-beaker-24: Experimental
|
:octicons-beaker-24: Experimental
|
||||||
|
|
||||||
@ -76,18 +76,18 @@ tabs with the same label will be activated when a user clicks a content tab
|
|||||||
regardless of order inside a container. Furthermore, this feature is fully
|
regardless of order inside a container. Furthermore, this feature is fully
|
||||||
integrated with [instant loading] and persisted across page loads.
|
integrated with [instant loading] and persisted across page loads.
|
||||||
|
|
||||||
=== ":octicons-check-circle-fill-16: Enabled"
|
=== "Feature enabled"
|
||||||
|
|
||||||
[![content.tabs.link enabled]][content.tabs.link enabled]
|
[![Linked content tabs enabled]][Linked content tabs enabled]
|
||||||
|
|
||||||
=== ":octicons-skip-16: Disabled"
|
=== "Feature disabled"
|
||||||
|
|
||||||
[![content.tabs.link disabled]][content.tabs.link disabled]
|
[![Linked content tabs disabled]][Linked content tabs disabled]
|
||||||
|
|
||||||
[link support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.3.0
|
[Linked content tabs support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.3.0
|
||||||
[instant loading]: ../setup/setting-up-navigation.md#instant-loading
|
[instant loading]: ../setup/setting-up-navigation.md#instant-loading
|
||||||
[content.tabs.link enabled]: ../assets/screenshots/content-tabs-link.png
|
[Linked content tabs enabled]: ../assets/screenshots/content-tabs-link.png
|
||||||
[content.tabs.link disabled]: ../assets/screenshots/content-tabs.png
|
[Linked content tabs disabled]: ../assets/screenshots/content-tabs.png
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
@ -131,7 +131,7 @@ If you want to make data tables sortable, you can add [tablesort], which is
|
|||||||
natively integrated with Material for MkDocs and will also work with [instant
|
natively integrated with Material for MkDocs and will also work with [instant
|
||||||
loading] via [additional JavaScript]:
|
loading] via [additional JavaScript]:
|
||||||
|
|
||||||
=== ":octicons-file-code-16: docs/javascripts/tablesort.js"
|
=== ":octicons-file-code-16: `docs/javascripts/tablesort.js`"
|
||||||
|
|
||||||
``` js
|
``` js
|
||||||
document$.subscribe(function() {
|
document$.subscribe(function() {
|
||||||
@ -142,7 +142,7 @@ loading] via [additional JavaScript]:
|
|||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: mkdocs.yml"
|
=== ":octicons-file-code-16: `mkdocs.yml`"
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
extra_javascript:
|
extra_javascript:
|
||||||
|
@ -6,7 +6,7 @@ icon: material/emoticon-happy-outline
|
|||||||
# Icons, Emojis
|
# Icons, Emojis
|
||||||
|
|
||||||
One of the best features of Material for MkDocs is the possibility to use [more
|
One of the best features of Material for MkDocs is the possibility to use [more
|
||||||
than 8,000 icons][icon search] and thousands of emojis in your project
|
than 10,000 icons][icon search] and thousands of emojis in your project
|
||||||
documentation with practically zero additional effort. Moreover, custom icons
|
documentation with practically zero additional effort. Moreover, custom icons
|
||||||
can be added and used in `mkdocs.yml`, documents and templates.
|
can be added and used in `mkdocs.yml`, documents and templates.
|
||||||
|
|
||||||
@ -50,6 +50,7 @@ The following icon sets are bundled with Material for MkDocs:
|
|||||||
- :material-material-design: – [Material Design]
|
- :material-material-design: – [Material Design]
|
||||||
- :fontawesome-brands-font-awesome: – [FontAwesome]
|
- :fontawesome-brands-font-awesome: – [FontAwesome]
|
||||||
- :octicons-mark-github-16: – [Octicons]
|
- :octicons-mark-github-16: – [Octicons]
|
||||||
|
- :simple-simpleicons: – [Simple Icons]
|
||||||
|
|
||||||
See additional configuration options:
|
See additional configuration options:
|
||||||
|
|
||||||
@ -60,6 +61,7 @@ See additional configuration options:
|
|||||||
[Material Design]: https://materialdesignicons.com/
|
[Material Design]: https://materialdesignicons.com/
|
||||||
[FontAwesome]: https://fontawesome.com/search?m=free
|
[FontAwesome]: https://fontawesome.com/search?m=free
|
||||||
[Octicons]: https://octicons.github.com/
|
[Octicons]: https://octicons.github.com/
|
||||||
|
[Simple Icons]: https://simpleicons.org/
|
||||||
[Attribute Lists]: ../setup/extensions/python-markdown.md#attribute-lists
|
[Attribute Lists]: ../setup/extensions/python-markdown.md#attribute-lists
|
||||||
[Emoji]: ../setup/extensions/python-markdown-extensions.md#emoji
|
[Emoji]: ../setup/extensions/python-markdown-extensions.md#emoji
|
||||||
[Emoji with custom icons]: ../setup/extensions/python-markdown-extensions.md#custom-icons
|
[Emoji with custom icons]: ../setup/extensions/python-markdown-extensions.md#custom-icons
|
||||||
@ -116,7 +118,7 @@ declarations into dedicated CSS classes:
|
|||||||
}
|
}
|
||||||
</style>
|
</style>
|
||||||
|
|
||||||
=== ":octicons-file-code-16: docs/stylesheets/extra.css"
|
=== ":octicons-file-code-16: `docs/stylesheets/extra.css`"
|
||||||
|
|
||||||
``` css
|
``` css
|
||||||
.twitter {
|
.twitter {
|
||||||
@ -124,7 +126,7 @@ declarations into dedicated CSS classes:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: mkdocs.yml"
|
=== ":octicons-file-code-16: `mkdocs.yml`"
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
extra_css:
|
extra_css:
|
||||||
@ -153,7 +155,7 @@ Similar to adding [colors], it's just as easy to add [animations] to icons by
|
|||||||
using an [additional style sheet], defining a `@keyframes` rule and adding a
|
using an [additional style sheet], defining a `@keyframes` rule and adding a
|
||||||
dedicated CSS class to the icon:
|
dedicated CSS class to the icon:
|
||||||
|
|
||||||
=== ":octicons-file-code-16: docs/stylesheets/extra.css"
|
=== ":octicons-file-code-16: `docs/stylesheets/extra.css`"
|
||||||
|
|
||||||
``` css
|
``` css
|
||||||
@keyframes heart {
|
@keyframes heart {
|
||||||
@ -169,7 +171,7 @@ dedicated CSS class to the icon:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: mkdocs.yml"
|
=== ":octicons-file-code-16: `mkdocs.yml`"
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
extra_css:
|
extra_css:
|
||||||
|
@ -32,7 +32,7 @@ See additional configuration options:
|
|||||||
|
|
||||||
### Lightbox
|
### Lightbox
|
||||||
|
|
||||||
[:octicons-tag-24: 0.1.0][glightbox support] ·
|
[:octicons-tag-24: 0.1.0][Lightbox support] ·
|
||||||
[:octicons-cpu-24: Plugin][glightbox]
|
[:octicons-cpu-24: Plugin][glightbox]
|
||||||
|
|
||||||
If you want to add image zoom functionality to your documentation, the
|
If you want to add image zoom functionality to your documentation, the
|
||||||
@ -53,7 +53,7 @@ plugins:
|
|||||||
We recommend checking out the available
|
We recommend checking out the available
|
||||||
[configuration options][glightbox options].
|
[configuration options][glightbox options].
|
||||||
|
|
||||||
[glightbox support]: https://github.com/squidfunk/mkdocs-material/releases/tag/0.1.0
|
[Lightbox support]: https://github.com/squidfunk/mkdocs-material/releases/tag/0.1.0
|
||||||
[glightbox]: https://github.com/blueswen/mkdocs-glightbox
|
[glightbox]: https://github.com/blueswen/mkdocs-glightbox
|
||||||
[glightbox options]: https://github.com/blueswen/mkdocs-glightbox#usage
|
[glightbox options]: https://github.com/blueswen/mkdocs-glightbox#usage
|
||||||
|
|
||||||
|
@ -24,16 +24,20 @@ tags. Add the following lines to `mkdocs.yml`:
|
|||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
plugins:
|
plugins:
|
||||||
- meta
|
- meta # (1)!
|
||||||
```
|
```
|
||||||
|
|
||||||
|
1. Note that the meta plugin should be located at the beginning of the list
|
||||||
|
of `plugins`, so that other plugins (including the [built-in blog plugin])
|
||||||
|
will pick up the set defaults.
|
||||||
|
|
||||||
> If you need to be able to build your documentation with and without
|
> If you need to be able to build your documentation with and without
|
||||||
> [Insiders], please refer to the [built-in plugins] section to learn how
|
> [Insiders], please refer to the [built-in plugins] section to learn how
|
||||||
> shared configurations help to achieve this.
|
> shared configurations help to achieve this.
|
||||||
|
|
||||||
The following configuration options are available:
|
The following configuration options are available:
|
||||||
|
|
||||||
`meta_file`{ #meta-file }
|
[`meta_file`](#+meta.meta_file){ #+meta.meta_file }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: `**/.meta.yml` – This option specifies the
|
: :octicons-milestone-24: Default: `**/.meta.yml` – This option specifies the
|
||||||
name of the meta files that the plugin should look for. The default setting
|
name of the meta files that the plugin should look for. The default setting
|
||||||
@ -48,6 +52,7 @@ The following configuration options are available:
|
|||||||
1. Note that it's strongly recommended to prefix meta files with a `.`,
|
1. Note that it's strongly recommended to prefix meta files with a `.`,
|
||||||
since otherwise they would be included in the build output.
|
since otherwise they would be included in the build output.
|
||||||
|
|
||||||
|
[built-in blog plugin]: ../setup/setting-up-a-blog.md#built-in-blog-plugin
|
||||||
[built-in plugins]: ../insiders/getting-started.md#built-in-plugins
|
[built-in plugins]: ../insiders/getting-started.md#built-in-plugins
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
@ -57,7 +62,7 @@ The following configuration options are available:
|
|||||||
The page title can be overridden for a document with the front matter `title`
|
The page title can be overridden for a document with the front matter `title`
|
||||||
property. Add the following lines at the top of a Markdown file:
|
property. Add the following lines at the top of a Markdown file:
|
||||||
|
|
||||||
``` sh
|
``` yaml
|
||||||
---
|
---
|
||||||
title: Lorem ipsum dolor sit amet # (1)!
|
title: Lorem ipsum dolor sit amet # (1)!
|
||||||
---
|
---
|
||||||
@ -79,7 +84,7 @@ title: Lorem ipsum dolor sit amet # (1)!
|
|||||||
The page description can be overridden for a document with the front matter
|
The page description can be overridden for a document with the front matter
|
||||||
`description` property. Add the following lines at the top of a Markdown file:
|
`description` property. Add the following lines at the top of a Markdown file:
|
||||||
|
|
||||||
``` sh
|
``` yaml
|
||||||
---
|
---
|
||||||
description: Nullam urna elit, malesuada eget finibus ut, ac tortor. # (1)!
|
description: Nullam urna elit, malesuada eget finibus ut, ac tortor. # (1)!
|
||||||
---
|
---
|
||||||
@ -100,7 +105,7 @@ description: Nullam urna elit, malesuada eget finibus ut, ac tortor. # (1)!
|
|||||||
An icon can be assigned to each page, which is then rendered as part of the
|
An icon can be assigned to each page, which is then rendered as part of the
|
||||||
navigation sidebar. Add the following lines at the top of a Markdown file:
|
navigation sidebar. Add the following lines at the top of a Markdown file:
|
||||||
|
|
||||||
``` sh
|
``` yaml
|
||||||
---
|
---
|
||||||
icon: material/emoticon-happy # (1)!
|
icon: material/emoticon-happy # (1)!
|
||||||
---
|
---
|
||||||
@ -153,7 +158,7 @@ The page status can now be set for a document with the front matter `status`
|
|||||||
property. For example, you can mark a page as `new` with the following lines at
|
property. For example, you can mark a page as `new` with the following lines at
|
||||||
the top of a Markdown file:
|
the top of a Markdown file:
|
||||||
|
|
||||||
``` sh
|
``` yaml
|
||||||
---
|
---
|
||||||
status: new
|
status: new
|
||||||
---
|
---
|
||||||
@ -173,7 +178,7 @@ If you're using [theme extension] and created a new page template in the
|
|||||||
`overrides` directory, you can enable it for a specific page. Add the following
|
`overrides` directory, you can enable it for a specific page. Add the following
|
||||||
lines at the top of a Markdown file:
|
lines at the top of a Markdown file:
|
||||||
|
|
||||||
``` sh
|
``` yaml
|
||||||
---
|
---
|
||||||
template: custom.html
|
template: custom.html
|
||||||
---
|
---
|
||||||
@ -185,7 +190,7 @@ template: custom.html
|
|||||||
??? question "How to set a page template for an entire folder?"
|
??? question "How to set a page template for an entire folder?"
|
||||||
|
|
||||||
With the help of the [built-in meta plugin], you can set a custom template
|
With the help of the [built-in meta plugin], you can set a custom template
|
||||||
for an entire section and all nested pages, by creating a `.meta.yml`
|
for an entire section and all nested pages, by creating a `.meta.yml` file
|
||||||
in the corresponding folder with the following content:
|
in the corresponding folder with the following content:
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
|
@ -21,7 +21,7 @@ This configuration enables support for rendering block and inline block
|
|||||||
equations through [MathJax]. Create a configuration file and add the following
|
equations through [MathJax]. Create a configuration file and add the following
|
||||||
lines to `mkdocs.yml`:
|
lines to `mkdocs.yml`:
|
||||||
|
|
||||||
=== ":octicons-file-code-16: docs/javascripts/mathjax.js"
|
=== ":octicons-file-code-16: `docs/javascripts/mathjax.js`"
|
||||||
|
|
||||||
``` js
|
``` js
|
||||||
window.MathJax = {
|
window.MathJax = {
|
||||||
@ -44,7 +44,7 @@ lines to `mkdocs.yml`:
|
|||||||
|
|
||||||
1. This integrates MathJax with [instant loading].
|
1. This integrates MathJax with [instant loading].
|
||||||
|
|
||||||
=== ":octicons-file-code-16: mkdocs.yml"
|
=== ":octicons-file-code-16: `mkdocs.yml`"
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
markdown_extensions:
|
markdown_extensions:
|
||||||
|
@ -4,18 +4,18 @@ icon: material/tooltip-plus
|
|||||||
status: new
|
status: new
|
||||||
---
|
---
|
||||||
|
|
||||||
# Tooltips
|
# Abbreviations
|
||||||
|
|
||||||
Material for MkDocs makes it trivial to add tooltips to links, abbreviations
|
Technical documentation often incurs the usage of many acronyms, which may
|
||||||
and all other elements, which allows for implementing glossary-like
|
need additional explanation, especially for new user of your project. For these
|
||||||
functionality, as well as small hints that are shown when the user hovers or
|
matters, Material for MkDocs uses a combination of Markdown extensions to
|
||||||
focuses an element.
|
enable site-wide glossaries.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
This configuration enables support for tooltips and abbreviations and allows to
|
This configuration enables abbreviations and allows to build a simple
|
||||||
build a simple glossary, sourcing definitions from a central location. Add the
|
project-wide glossary, sourcing definitions from a central location. Add the
|
||||||
following lines to `mkdocs.yml`:
|
following line to `mkdocs.yml`:
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
markdown_extensions:
|
markdown_extensions:
|
||||||
@ -108,7 +108,7 @@ extension:
|
|||||||
|
|
||||||
### Adding abbreviations
|
### Adding abbreviations
|
||||||
|
|
||||||
Abbreviations can be defined by using a special syntax similar to [links] and
|
Abbreviations can be defined by using a special syntax similar to URLs and
|
||||||
[footnotes], starting with a `*` and immediately followed by the term or
|
[footnotes], starting with a `*` and immediately followed by the term or
|
||||||
acronym to be associated in square brackets:
|
acronym to be associated in square brackets:
|
||||||
|
|
||||||
@ -128,7 +128,6 @@ The HTML specification is maintained by the W3C.
|
|||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
[links]: #adding-tooltips
|
|
||||||
[footnotes]: footnotes.md
|
[footnotes]: footnotes.md
|
||||||
|
|
||||||
### Adding a glossary
|
### Adding a glossary
|
||||||
@ -143,14 +142,14 @@ pages with the following configuration:
|
|||||||
`includes` is used), as MkDocs might otherwise complain about an
|
`includes` is used), as MkDocs might otherwise complain about an
|
||||||
unreferenced file.
|
unreferenced file.
|
||||||
|
|
||||||
=== ":octicons-file-code-16: includes/abbreviations.md"
|
=== ":octicons-file-code-16: `includes/abbreviations.md`"
|
||||||
|
|
||||||
```` markdown
|
```` markdown
|
||||||
*[HTML]: Hyper Text Markup Language
|
*[HTML]: Hyper Text Markup Language
|
||||||
*[W3C]: World Wide Web Consortium
|
*[W3C]: World Wide Web Consortium
|
||||||
````
|
````
|
||||||
|
|
||||||
=== ":octicons-file-code-16: mkdocs.yml"
|
=== ":octicons-file-code-16: `mkdocs.yml`"
|
||||||
|
|
||||||
```` yaml
|
```` yaml
|
||||||
markdown_extensions:
|
markdown_extensions:
|
||||||
|
@ -91,17 +91,17 @@
|
|||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"title": {
|
"title": {
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#toc-title",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#+toc.title",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"permalink": {
|
"permalink": {
|
||||||
"oneOf": [
|
"oneOf": [
|
||||||
{
|
{
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#toc-permalink",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#+toc.permalink",
|
||||||
"type": "boolean"
|
"type": "boolean"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#toc-permalink",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#+toc.permalink",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
@ -113,15 +113,15 @@
|
|||||||
"default": false
|
"default": false
|
||||||
},
|
},
|
||||||
"permalink_title": {
|
"permalink_title": {
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#toc-permalink-title",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#+toc.permalink_title",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"slugify": {
|
"slugify": {
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#toc-slugify",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#+toc.slugify",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"toc_depth": {
|
"toc_depth": {
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#toc-depth",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#+toc.toc_depth",
|
||||||
"type": "number",
|
"type": "number",
|
||||||
"enum": [
|
"enum": [
|
||||||
0,
|
0,
|
||||||
|
@ -127,7 +127,7 @@
|
|||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"mode": {
|
"mode": {
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#critic-mode",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.critic.mode",
|
||||||
"enum": [
|
"enum": [
|
||||||
"view",
|
"view",
|
||||||
"accept",
|
"accept",
|
||||||
@ -158,24 +158,24 @@
|
|||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"emoji_generator": {
|
"emoji_generator": {
|
||||||
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/emoji/#options",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.emoji_generator",
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"default": "!!python/name:materialx.emoji.to_svg"
|
"default": "!!python/name:materialx.emoji.to_svg"
|
||||||
},
|
},
|
||||||
"emoji_index": {
|
"emoji_index": {
|
||||||
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/emoji/#options",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.emoji_index",
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"default": "!!python/name:materialx.emoji.twemoji"
|
"default": "!!python/name:materialx.emoji.twemoji"
|
||||||
},
|
},
|
||||||
"options": {
|
"options": {
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#custom-icons",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.options.custom_icons",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"custom_icons": {
|
"custom_icons": {
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#custom-icons",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.options.custom_icons",
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#custom-icons",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.options.custom_icons",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"uniqueItems": true,
|
"uniqueItems": true,
|
||||||
@ -212,11 +212,11 @@
|
|||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"use_pygments": {
|
"use_pygments": {
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#highlight-use-pygments",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.use_pygments",
|
||||||
"type": "boolean"
|
"type": "boolean"
|
||||||
},
|
},
|
||||||
"auto_title": {
|
"auto_title": {
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#highlight-auto-title",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.auto_title",
|
||||||
"type": "boolean"
|
"type": "boolean"
|
||||||
},
|
},
|
||||||
"auto_title_map": {
|
"auto_title_map": {
|
||||||
@ -224,11 +224,11 @@
|
|||||||
"type": "object"
|
"type": "object"
|
||||||
},
|
},
|
||||||
"linenums": {
|
"linenums": {
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#highlight-linenums",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.linenums",
|
||||||
"type": "boolean"
|
"type": "boolean"
|
||||||
},
|
},
|
||||||
"linenums_style": {
|
"linenums_style": {
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#highlight-linenums-style",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.linenums_style",
|
||||||
"enum": [
|
"enum": [
|
||||||
"inline",
|
"inline",
|
||||||
"pymdownx-inline",
|
"pymdownx-inline",
|
||||||
@ -236,7 +236,7 @@
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
"anchor_linenums": {
|
"anchor_linenums": {
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#highlight-anchor-linenums",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.anchor_linenums",
|
||||||
"type": "boolean"
|
"type": "boolean"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
@ -359,7 +359,8 @@
|
|||||||
"properties": {
|
"properties": {
|
||||||
"smart_mark": {
|
"smart_mark": {
|
||||||
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/mark/#options",
|
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/mark/#options",
|
||||||
"type": "boolean"
|
"type": "boolean",
|
||||||
|
"default": true
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"additionalProperties": false
|
"additionalProperties": false
|
||||||
@ -386,45 +387,50 @@
|
|||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#smartsymbols",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#smartsymbols",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"smart_mark": {
|
|
||||||
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/mark/#options",
|
|
||||||
"type": "boolean"
|
|
||||||
},
|
|
||||||
"trademark": {
|
"trademark": {
|
||||||
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/mark/#options",
|
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/smartsymbols/#options",
|
||||||
"type": "boolean"
|
"type": "boolean",
|
||||||
|
"default": true
|
||||||
},
|
},
|
||||||
"copyright": {
|
"copyright": {
|
||||||
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/mark/#options",
|
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/smartsymbols/#options",
|
||||||
"type": "boolean"
|
"type": "boolean",
|
||||||
|
"default": true
|
||||||
},
|
},
|
||||||
"registered": {
|
"registered": {
|
||||||
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/mark/#options",
|
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/smartsymbols/#options",
|
||||||
"type": "boolean"
|
"type": "boolean",
|
||||||
|
"default": true
|
||||||
},
|
},
|
||||||
"care_of": {
|
"care_of": {
|
||||||
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/mark/#options",
|
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/smartsymbols/#options",
|
||||||
"type": "boolean"
|
"type": "boolean",
|
||||||
|
"default": true
|
||||||
},
|
},
|
||||||
"plusminus": {
|
"plusminus": {
|
||||||
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/mark/#options",
|
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/smartsymbols/#options",
|
||||||
"type": "boolean"
|
"type": "boolean",
|
||||||
|
"default": true
|
||||||
},
|
},
|
||||||
"arrows": {
|
"arrows": {
|
||||||
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/mark/#options",
|
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/smartsymbols/#options",
|
||||||
"type": "boolean"
|
"type": "boolean",
|
||||||
|
"default": true
|
||||||
},
|
},
|
||||||
"notequal": {
|
"notequal": {
|
||||||
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/mark/#options",
|
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/smartsymbols/#options",
|
||||||
"type": "boolean"
|
"type": "boolean",
|
||||||
|
"default": true
|
||||||
},
|
},
|
||||||
"fractions": {
|
"fractions": {
|
||||||
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/mark/#options",
|
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/smartsymbols/#options",
|
||||||
"type": "boolean"
|
"type": "boolean",
|
||||||
|
"default": true
|
||||||
},
|
},
|
||||||
"ordinal_numbers": {
|
"ordinal_numbers": {
|
||||||
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/mark/#options",
|
"markdownDescription": "https://facelessuser.github.io/pymdown-extensions/extensions/smartsymbols/#options",
|
||||||
"type": "boolean"
|
"type": "boolean",
|
||||||
|
"default": true
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"additionalProperties": false
|
"additionalProperties": false
|
||||||
@ -496,10 +502,10 @@
|
|||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"custom_fences": {
|
"custom_fences": {
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#superfences-custom-fences",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.superfences.custom_fences",
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#superfences-custom-fences",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.superfences.custom_fences",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"name": {
|
"name": {
|
||||||
@ -561,12 +567,12 @@
|
|||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"custom_checkbox": {
|
"custom_checkbox": {
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tasklist-custom-checkbox",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.tasklist.custom_checkbox",
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"default": true
|
"default": true
|
||||||
},
|
},
|
||||||
"clickable_checkbox": {
|
"clickable_checkbox": {
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tasklist-clickable-checkbox",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.tasklist.clickable_checkbox",
|
||||||
"type": "boolean"
|
"type": "boolean"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
@ -72,17 +72,17 @@
|
|||||||
},
|
},
|
||||||
"name": {
|
"name": {
|
||||||
"title": "Feedback rating name",
|
"title": "Feedback rating name",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#feedback-rating-name",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#+analytics.feedback.ratings.name",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"data": {
|
"data": {
|
||||||
"title": "Feedback rating data",
|
"title": "Feedback rating data",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#feedback-rating-data",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#+analytics.feedback.ratings.data",
|
||||||
"type": "number"
|
"type": "number"
|
||||||
},
|
},
|
||||||
"note": {
|
"note": {
|
||||||
"title": "Feedback rating data",
|
"title": "Feedback rating data",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#feedback-rating-note",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#+analytics.feedback.ratings.note",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
@ -139,22 +139,25 @@
|
|||||||
"properties": {
|
"properties": {
|
||||||
"title": {
|
"title": {
|
||||||
"title": "Cookie consent title",
|
"title": "Cookie consent title",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.title",
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"default": "Cookie consent"
|
"default": "Cookie consent"
|
||||||
},
|
},
|
||||||
"description": {
|
"description": {
|
||||||
"title": "Cookie consent description",
|
"title": "Cookie consent description",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.description",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"cookies": {
|
"cookies": {
|
||||||
"title": "Cookies",
|
"title": "Cookies",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.cookies",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"analytics": {
|
"analytics": {
|
||||||
"$ref": "#/definitions/cookie"
|
"$ref": "#/definitions/cookie"
|
||||||
|
},
|
||||||
|
"github": {
|
||||||
|
"$ref": "#/definitions/cookie"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"patternProperties": {
|
"patternProperties": {
|
||||||
@ -166,19 +169,29 @@
|
|||||||
"defaultSnippets": [
|
"defaultSnippets": [
|
||||||
{
|
{
|
||||||
"label": "analytics (default)",
|
"label": "analytics (default)",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.cookies",
|
||||||
"body": {
|
"body": {
|
||||||
"analytics": {
|
"analytics": {
|
||||||
"name": "Google Analytics",
|
"name": "Google Analytics",
|
||||||
"checked": true
|
"checked": true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"label": "github (default)",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.cookies",
|
||||||
|
"body": {
|
||||||
|
"analytics": {
|
||||||
|
"name": "GitHub",
|
||||||
|
"checked": true
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"actions": {
|
"actions": {
|
||||||
"title": "Cookie consent actions",
|
"title": "Cookie consent actions",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.actions",
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"oneOf": [
|
"oneOf": [
|
||||||
@ -208,7 +221,7 @@
|
|||||||
"defaultSnippets": [
|
"defaultSnippets": [
|
||||||
{
|
{
|
||||||
"label": "actions (default)",
|
"label": "actions (default)",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.actions",
|
||||||
"body": {
|
"body": {
|
||||||
"actions": [
|
"actions": [
|
||||||
"accept",
|
"accept",
|
||||||
@ -235,12 +248,12 @@
|
|||||||
},
|
},
|
||||||
"link": {
|
"link": {
|
||||||
"title": "Social link",
|
"title": "Social link",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#social-link",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#+social.link",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"name": {
|
"name": {
|
||||||
"title": "Social link name",
|
"title": "Social link name",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#social-name",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#+social.name",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
@ -262,17 +275,17 @@
|
|||||||
"properties": {
|
"properties": {
|
||||||
"name": {
|
"name": {
|
||||||
"title": "Alternate language name",
|
"title": "Alternate language name",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#language-name",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#+alternate.name",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"link": {
|
"link": {
|
||||||
"title": "Alternate language link",
|
"title": "Alternate language link",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#language-link",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#+alternate.link",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"lang": {
|
"lang": {
|
||||||
"title": "Alternate language code (ISO 639-1)",
|
"title": "Alternate language code (ISO 639-1)",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#language-lang",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#+alternate.lang",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
@ -22,6 +22,9 @@
|
|||||||
"built-in": {
|
"built-in": {
|
||||||
"description": "Built-in plugins",
|
"description": "Built-in plugins",
|
||||||
"oneOf": [
|
"oneOf": [
|
||||||
|
{
|
||||||
|
"$ref": "plugins/blog.json"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"$ref": "plugins/meta.json"
|
"$ref": "plugins/meta.json"
|
||||||
},
|
},
|
||||||
|
327
docs/schema/plugins/blog.json
Normal file
@ -0,0 +1,327 @@
|
|||||||
|
{
|
||||||
|
"$schema": "https://json-schema.org/draft-07/schema",
|
||||||
|
"title": "Built-in blog plugin",
|
||||||
|
"oneOf": [
|
||||||
|
{
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#built-in-blog-plugin",
|
||||||
|
"enum": [
|
||||||
|
"blog"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"blog": {
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#built-in-blog-plugin",
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"enabled": {
|
||||||
|
"title": "Enable plugin",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.enabled",
|
||||||
|
"type": "boolean",
|
||||||
|
"default": true
|
||||||
|
},
|
||||||
|
"blog_dir": {
|
||||||
|
"title": "Blog directory",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.blog_dir",
|
||||||
|
"type": "string",
|
||||||
|
"default": "blog"
|
||||||
|
},
|
||||||
|
"blog_custom_dir": {
|
||||||
|
"title": "Blog template directory (internal)",
|
||||||
|
"markdownDescription": "Warning: this option is for internal use only, use at your own risk",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"post_date_format": {
|
||||||
|
"title": "Format string for post dates",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.post_date_format",
|
||||||
|
"oneOf": [
|
||||||
|
{
|
||||||
|
"enum": [
|
||||||
|
"full",
|
||||||
|
"long",
|
||||||
|
"medium",
|
||||||
|
"short"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"default": "long"
|
||||||
|
},
|
||||||
|
"post_url_date_format": {
|
||||||
|
"title": "Format string for post dates in URLs",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.post_url_date_format",
|
||||||
|
"oneOf": [
|
||||||
|
{
|
||||||
|
"enum": [
|
||||||
|
"YYYY",
|
||||||
|
"YYYY/MM",
|
||||||
|
"YYYY/MM/dd"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"default": "YYYY"
|
||||||
|
},
|
||||||
|
"post_url_format": {
|
||||||
|
"title": "Format string for post URLs",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.post_url_format",
|
||||||
|
"oneOf": [
|
||||||
|
{
|
||||||
|
"enum": [
|
||||||
|
"\"{date}/{slug}\"",
|
||||||
|
"\"{slug}\""
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"post_slugify": {
|
||||||
|
"title": "Post slugify function",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.post_slugify",
|
||||||
|
"type": "string",
|
||||||
|
"default": "!!python/name:pymdownx.slugs.uslugify"
|
||||||
|
},
|
||||||
|
"post_slugify_separator": {
|
||||||
|
"title": "Post slugify separator",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.post_slugify_separator",
|
||||||
|
"type": "string",
|
||||||
|
"default": "\"-\""
|
||||||
|
},
|
||||||
|
"post_excerpt": {
|
||||||
|
"title": "Post excerpts",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.post_excerpt",
|
||||||
|
"oneOf": [
|
||||||
|
{
|
||||||
|
"title": "Post excerpts are optional",
|
||||||
|
"enum": [
|
||||||
|
"optional"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "Post excerpts are required, thus the build will fail",
|
||||||
|
"enum": [
|
||||||
|
"required"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"default": "optional"
|
||||||
|
},
|
||||||
|
"post_excerpt_separator": {
|
||||||
|
"title": "Post excerpt separator",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.post_excerpt_separator",
|
||||||
|
"type": "string",
|
||||||
|
"default": "<!-- more -->"
|
||||||
|
},
|
||||||
|
"post_readtime": {
|
||||||
|
"title": "Post reading time computation",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.post_readtime",
|
||||||
|
"type": "boolean",
|
||||||
|
"default": true
|
||||||
|
},
|
||||||
|
"post_readtime_words_per_minute": {
|
||||||
|
"title": "Post reading time words per minute",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.post_readtime_words_per_minute",
|
||||||
|
"type": "number",
|
||||||
|
"default": 265
|
||||||
|
},
|
||||||
|
"archive": {
|
||||||
|
"title": "Archive",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.archive",
|
||||||
|
"type": "boolean",
|
||||||
|
"default": true
|
||||||
|
},
|
||||||
|
"archive_name": {
|
||||||
|
"title": "Archive name",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.archive_name",
|
||||||
|
"type": "string",
|
||||||
|
"default": "Archive"
|
||||||
|
},
|
||||||
|
"archive_date_format": {
|
||||||
|
"title": "Format string for archive dates",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.archive_date_format",
|
||||||
|
"oneOf": [
|
||||||
|
{
|
||||||
|
"enum": [
|
||||||
|
"YYYY",
|
||||||
|
"MMMM YYYY"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"default": "YYYY"
|
||||||
|
},
|
||||||
|
"archive_url_date_format": {
|
||||||
|
"title": "Format string for archive dates in URLs",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.archive_url_date_format",
|
||||||
|
"oneOf": [
|
||||||
|
{
|
||||||
|
"enum": [
|
||||||
|
"YYYY",
|
||||||
|
"YYYY/MM"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"default": "YYYY"
|
||||||
|
},
|
||||||
|
"archive_url_format": {
|
||||||
|
"title": "Format string for archive URLs",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.archive_url_format",
|
||||||
|
"oneOf": [
|
||||||
|
{
|
||||||
|
"enum": [
|
||||||
|
"\"archive/{date}\""
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"categories": {
|
||||||
|
"title": "Categories",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.categories",
|
||||||
|
"type": "boolean",
|
||||||
|
"default": true
|
||||||
|
},
|
||||||
|
"categories_name": {
|
||||||
|
"title": "Categories name",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.categories_name",
|
||||||
|
"type": "string",
|
||||||
|
"default": "Categories"
|
||||||
|
},
|
||||||
|
"categories_url_format": {
|
||||||
|
"title": "Format string for category URLs",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.categories_url_format",
|
||||||
|
"oneOf": [
|
||||||
|
{
|
||||||
|
"enum": [
|
||||||
|
"\"category/{slug}\"",
|
||||||
|
"\"{slug}\""
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"categories_slugify": {
|
||||||
|
"title": "Categories slugify function",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.categories_slugify",
|
||||||
|
"type": "string",
|
||||||
|
"default": "!!python/name:pymdownx.slugs.uslugify"
|
||||||
|
},
|
||||||
|
"categories_slugify_separator": {
|
||||||
|
"title": "Categories slugify separator",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.categories_slugify_separator",
|
||||||
|
"type": "string",
|
||||||
|
"default": "\"-\""
|
||||||
|
},
|
||||||
|
"categories_allowed": {
|
||||||
|
"title": "Categories allowed",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.categories_allowed",
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"default": []
|
||||||
|
},
|
||||||
|
"pagination": {
|
||||||
|
"title": "Pagination",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.pagination",
|
||||||
|
"type": "boolean",
|
||||||
|
"default": true
|
||||||
|
},
|
||||||
|
"pagination_per_page": {
|
||||||
|
"title": "Posts per page",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.pagination_per_page",
|
||||||
|
"type": "number",
|
||||||
|
"default": 10
|
||||||
|
},
|
||||||
|
"pagination_url_format": {
|
||||||
|
"title": "Format string for pagination URLs",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.pagination_url_format",
|
||||||
|
"oneOf": [
|
||||||
|
{
|
||||||
|
"enum": [
|
||||||
|
"\"page/{page}\"",
|
||||||
|
"\"{page}\""
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"pagination_template": {
|
||||||
|
"title": "Template string for pagination",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.pagination_template",
|
||||||
|
"oneOf": [
|
||||||
|
{
|
||||||
|
"enum": [
|
||||||
|
"~2~",
|
||||||
|
"$link_first $link_previous ~2~ $link_next $link_last",
|
||||||
|
"$link_previous $page $link_next"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"default": "~2~"
|
||||||
|
},
|
||||||
|
"authors": {
|
||||||
|
"title": "Author info",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.authors",
|
||||||
|
"type": "boolean",
|
||||||
|
"default": true
|
||||||
|
},
|
||||||
|
"authors_file": {
|
||||||
|
"title": "Authors file",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.authors_file",
|
||||||
|
"type": "string",
|
||||||
|
"default": ".authors.yml"
|
||||||
|
},
|
||||||
|
"authors_in_excerpt": {
|
||||||
|
"title": "Number of authors to render in post excerpts",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.authors_in_excerpt",
|
||||||
|
"type": "number",
|
||||||
|
"default": 1
|
||||||
|
},
|
||||||
|
"draft": {
|
||||||
|
"title": "Render posts marked as drafts",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.draft",
|
||||||
|
"type": "boolean",
|
||||||
|
"default": false
|
||||||
|
},
|
||||||
|
"draft_on_serve": {
|
||||||
|
"title": "Render posts marked as drafts when previewing",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.draft_on_serve",
|
||||||
|
"type": "boolean",
|
||||||
|
"default": true
|
||||||
|
},
|
||||||
|
"draft_if_future_date": {
|
||||||
|
"title": "Automatically mark posts with future dates as drafts",
|
||||||
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.draft_if_future_date",
|
||||||
|
"type": "boolean",
|
||||||
|
"default": false
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
@ -23,7 +23,7 @@
|
|||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"title": "Repository slug",
|
"title": "Repository slug",
|
||||||
"markdownDescription": "https://github.com/ojacques/mkdocs-git-committers-plugin-2#config",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#+git-committers.repository",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
@ -17,7 +17,7 @@
|
|||||||
"properties": {
|
"properties": {
|
||||||
"meta_file": {
|
"meta_file": {
|
||||||
"title": "Meta file name",
|
"title": "Meta file name",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/#meta-file",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/#+meta.meta_file",
|
||||||
"pattern": "\\.yml$",
|
"pattern": "\\.yml$",
|
||||||
"default": "\"**/.meta.yml\""
|
"default": "\"**/.meta.yml\""
|
||||||
}
|
}
|
||||||
|
@ -17,7 +17,7 @@
|
|||||||
"properties": {
|
"properties": {
|
||||||
"enabled": {
|
"enabled": {
|
||||||
"title": "Enable plugin",
|
"title": "Enable plugin",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-for-offline-usage/#enabled",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/building-for-offline-usage/#+offline.enabled",
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"default": true
|
"default": true
|
||||||
}
|
}
|
||||||
|
@ -17,13 +17,13 @@
|
|||||||
"properties": {
|
"properties": {
|
||||||
"enabled": {
|
"enabled": {
|
||||||
"title": "Enable plugin",
|
"title": "Enable plugin",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#enabled",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.enabled",
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"default": true
|
"default": true
|
||||||
},
|
},
|
||||||
"externals": {
|
"externals": {
|
||||||
"title": "External assets",
|
"title": "External assets",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#externals",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.externals",
|
||||||
"oneOf": [
|
"oneOf": [
|
||||||
{
|
{
|
||||||
"title": "Bundle external assets",
|
"title": "Bundle external assets",
|
||||||
@ -42,17 +42,17 @@
|
|||||||
},
|
},
|
||||||
"externals_dir": {
|
"externals_dir": {
|
||||||
"title": "External assets download directory",
|
"title": "External assets download directory",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#externals-dir",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.externals_dir",
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"default": "assets/externals"
|
"default": "assets/externals"
|
||||||
},
|
},
|
||||||
"externals_exclude": {
|
"externals_exclude": {
|
||||||
"title": "External assets to be excluded",
|
"title": "External assets to be excluded",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#externals-exclude",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.externals_exclude",
|
||||||
"type": "array",
|
"type": "array",
|
||||||
"items": {
|
"items": {
|
||||||
"title": "External assets matching this pattern will not be bundled",
|
"title": "External assets matching this pattern will not be bundled",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#externals-exclude",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+privacy.externals_exclude",
|
||||||
"pattern": ".*"
|
"pattern": ".*"
|
||||||
},
|
},
|
||||||
"uniqueItems": true,
|
"uniqueItems": true,
|
||||||
|
@ -33,17 +33,17 @@
|
|||||||
},
|
},
|
||||||
"separator": {
|
"separator": {
|
||||||
"title": "Separator for indexing and query tokenization",
|
"title": "Separator for indexing and query tokenization",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-separator",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#+search.separator",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"jieba_dict": {
|
"jieba_dict": {
|
||||||
"title": "Jieba dictionary replacement",
|
"title": "Jieba dictionary replacement",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#jieba-dict",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#+search.jieba_dict",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"jieba_dict_user": {
|
"jieba_dict_user": {
|
||||||
"title": "Jieba dictionary augmentation",
|
"title": "Jieba dictionary augmentation",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#jieba-dict",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#+search.jieba_dict_user",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
@ -56,7 +56,7 @@
|
|||||||
"definitions": {
|
"definitions": {
|
||||||
"lang": {
|
"lang": {
|
||||||
"title": "Site search language",
|
"title": "Site search language",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-lang",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#+search.lang",
|
||||||
"oneOf": [
|
"oneOf": [
|
||||||
{
|
{
|
||||||
"title": "Site search language: Arabic",
|
"title": "Site search language: Arabic",
|
||||||
|
@ -17,23 +17,23 @@
|
|||||||
"properties": {
|
"properties": {
|
||||||
"cards": {
|
"cards": {
|
||||||
"title": "Social card generation",
|
"title": "Social card generation",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#cards",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.cards",
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"default": true
|
"default": true
|
||||||
},
|
},
|
||||||
"cards_color": {
|
"cards_color": {
|
||||||
"title": "Social card color palette",
|
"title": "Social card color palette",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#cards-color",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.cards_color",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"fill": {
|
"fill": {
|
||||||
"title": "Background fill color",
|
"title": "Background fill color",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#cards-color",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.cards_color",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"text": {
|
"text": {
|
||||||
"title": "Foreground text color",
|
"title": "Foreground text color",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#cards-color",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.cards_color",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
@ -48,7 +48,7 @@
|
|||||||
},
|
},
|
||||||
"cards_dir": {
|
"cards_dir": {
|
||||||
"title": "Social card directory",
|
"title": "Social card directory",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#cards-dir",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/#+social.cards_dir",
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"default": "assets/images/social"
|
"default": "assets/images/social"
|
||||||
}
|
}
|
||||||
|
@ -17,13 +17,13 @@
|
|||||||
"properties": {
|
"properties": {
|
||||||
"tags_file": {
|
"tags_file": {
|
||||||
"title": "Markdown file to render tags index",
|
"title": "Markdown file to render tags index",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#tags-file",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#+tags.tags_file",
|
||||||
"pattern": "\\.md$",
|
"pattern": "\\.md$",
|
||||||
"default": "tags.md"
|
"default": "tags.md"
|
||||||
},
|
},
|
||||||
"tags_extra_files": {
|
"tags_extra_files": {
|
||||||
"title": "Markdown files to render additional tags indexes",
|
"title": "Markdown files to render additional tags indexes",
|
||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#tags-extra-files",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#+tags.tags_extra_files",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"patternProperties": {
|
"patternProperties": {
|
||||||
"\\.md$": {
|
"\\.md$": {
|
||||||
|
@ -436,6 +436,9 @@
|
|||||||
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/",
|
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
|
"edit": {
|
||||||
|
"$ref": "#/definitions/icon"
|
||||||
|
},
|
||||||
"logo": {
|
"logo": {
|
||||||
"$ref": "#/definitions/icon"
|
"$ref": "#/definitions/icon"
|
||||||
},
|
},
|
||||||
@ -550,6 +553,10 @@
|
|||||||
},
|
},
|
||||||
"additionalProperties": false,
|
"additionalProperties": false,
|
||||||
"defaultSnippets": [
|
"defaultSnippets": [
|
||||||
|
{
|
||||||
|
"label": "edit",
|
||||||
|
"body": "edit: ${1:material/pencil}"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"label": "logo",
|
"label": "logo",
|
||||||
"body": "logo: ${1:material/library}"
|
"body": "logo: ${1:material/library}"
|
||||||
|
@ -42,24 +42,14 @@ Before you can use [Giscus], you need to complete the following steps:
|
|||||||
</script>
|
</script>
|
||||||
```
|
```
|
||||||
|
|
||||||
You can either integrate [Giscus] on every page by overriding the `main.html`
|
The by default empty [`comments.html`][comments] partial is the best place to
|
||||||
template, or create a new template (e.g. `blog.html`) to extend from `main.html`
|
add the code snippet generated by [Giscus]. Follow the guide on [theme extension]
|
||||||
which includes the comment system, so you can decide for each page whether you
|
and [override the `comments.html` partial][overriding partials] with:
|
||||||
want to allow comments or not.
|
|
||||||
|
|
||||||
In order to integrate [Giscus], follow the guide on [theme extension] and
|
``` html hl_lines="3"
|
||||||
[override the `content` block][overriding blocks], extending the default by
|
{% if page.meta.comments %}
|
||||||
calling the `super()` function at the beginning of the block:
|
|
||||||
|
|
||||||
``` html hl_lines="8"
|
|
||||||
{% extends "base.html" %}
|
|
||||||
|
|
||||||
{% block content %}
|
|
||||||
{{ super() }}
|
|
||||||
|
|
||||||
<!-- Giscus -->
|
|
||||||
<h2 id="__comments">{{ lang.t("meta.comments") }}</h2>
|
<h2 id="__comments">{{ lang.t("meta.comments") }}</h2>
|
||||||
<!-- Replace with generated snippet -->
|
<!-- Insert generated code here -->
|
||||||
|
|
||||||
<!-- Synchronize Giscus theme with palette -->
|
<!-- Synchronize Giscus theme with palette -->
|
||||||
<script>
|
<script>
|
||||||
@ -71,7 +61,7 @@ calling the `super()` function at the beginning of the block:
|
|||||||
var theme = palette.color.scheme === "slate" ? "dark" : "light"
|
var theme = palette.color.scheme === "slate" ? "dark" : "light"
|
||||||
giscus.setAttribute("data-theme", theme) // (1)!
|
giscus.setAttribute("data-theme", theme) // (1)!
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Register event handlers after documented loaded */
|
/* Register event handlers after documented loaded */
|
||||||
document.addEventListener("DOMContentLoaded", function() {
|
document.addEventListener("DOMContentLoaded", function() {
|
||||||
var ref = document.querySelector("[data-md-component=palette]")
|
var ref = document.querySelector("[data-md-component=palette]")
|
||||||
@ -90,7 +80,7 @@ calling the `super()` function at the beginning of the block:
|
|||||||
})
|
})
|
||||||
})
|
})
|
||||||
</script>
|
</script>
|
||||||
{% endblock %}
|
{% endif %}
|
||||||
```
|
```
|
||||||
|
|
||||||
1. This code block ensures that [Giscus] renders with a dark theme when the
|
1. This code block ensures that [Giscus] renders with a dark theme when the
|
||||||
@ -98,12 +88,24 @@ calling the `super()` function at the beginning of the block:
|
|||||||
so you can change it to your liking.
|
so you can change it to your liking.
|
||||||
|
|
||||||
Replace the highlighted line with the snippet you generated with the [Giscus]
|
Replace the highlighted line with the snippet you generated with the [Giscus]
|
||||||
configuration tool in the previous step. If you extended `main.html`, you should
|
configuration tool in the previous step. If you copied the snippet from above,
|
||||||
now see the [Giscus] comment system at the bottom of each page. If you created
|
you can enable comments on a page by setting the `comments` front matter
|
||||||
a new, separate template, you can enable Giscus by [setting the page template]
|
property to `true`:
|
||||||
via front matter.
|
|
||||||
|
``` yaml
|
||||||
|
---
|
||||||
|
comments: true
|
||||||
|
---
|
||||||
|
|
||||||
|
# Document title
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
If you wish to enable comments for an entire folder, you can use the
|
||||||
|
[built-in meta plugin].
|
||||||
|
|
||||||
[Giscus GitHub App]: https://github.com/apps/giscus
|
[Giscus GitHub App]: https://github.com/apps/giscus
|
||||||
[theme extension]: ../customization.md#extending-the-theme
|
[theme extension]: ../customization.md#extending-the-theme
|
||||||
[overriding blocks]: ../customization.md#overriding-blocks
|
[comments]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/comments.html
|
||||||
[setting the page template]: ../reference/index.md#setting-the-page-template
|
[overriding partials]: ../customization.md#overriding-partials
|
||||||
|
[built-in meta plugin]: ../reference/index.md#built-in-meta-plugin
|
||||||
|
@ -13,7 +13,7 @@ static site, including stars and forks. Furthermore, the
|
|||||||
|
|
||||||
### Repository
|
### Repository
|
||||||
|
|
||||||
[:octicons-tag-24: 0.1.0][repo_url support] ·
|
[:octicons-tag-24: 0.1.0][Repository support] ·
|
||||||
:octicons-milestone-24: Default: _none_
|
:octicons-milestone-24: Default: _none_
|
||||||
|
|
||||||
In order to display a link to the repository of your project as part of your
|
In order to display a link to the repository of your project as part of your
|
||||||
@ -37,14 +37,14 @@ GitHub repositories also include the tag of the latest release.[^1]
|
|||||||
pre-release) for the latest tag you want to display next to the number of
|
pre-release) for the latest tag you want to display next to the number of
|
||||||
stars and forks.
|
stars and forks.
|
||||||
|
|
||||||
[repo_url support]: https://github.com/squidfunk/mkdocs-material/releases/tag/0.1.0
|
[Repository support]: https://github.com/squidfunk/mkdocs-material/releases/tag/0.1.0
|
||||||
[repo_url]: https://www.mkdocs.org/user-guide/configuration/#repo_url
|
[repo_url]: https://www.mkdocs.org/user-guide/configuration/#repo_url
|
||||||
[latest release]: https://docs.github.com/en/rest/reference/releases#get-the-latest-release
|
[latest release]: https://docs.github.com/en/rest/reference/releases#get-the-latest-release
|
||||||
[create a release]: https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release
|
[create a release]: https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release
|
||||||
|
|
||||||
#### Repository name
|
#### Repository name
|
||||||
|
|
||||||
[:octicons-tag-24: 0.1.0][repo_name support] ·
|
[:octicons-tag-24: 0.1.0][Repository name support] ·
|
||||||
:octicons-milestone-24: Default: _automatically set to_ `GitHub`, `GitLab` _or_
|
:octicons-milestone-24: Default: _automatically set to_ `GitHub`, `GitLab` _or_
|
||||||
`Bitbucket`
|
`Bitbucket`
|
||||||
|
|
||||||
@ -56,14 +56,14 @@ _repository name_ automatically. If you wish to customize the name, set
|
|||||||
repo_name: squidfunk/mkdocs-material
|
repo_name: squidfunk/mkdocs-material
|
||||||
```
|
```
|
||||||
|
|
||||||
[repo_name support]: https://github.com/squidfunk/mkdocs-material/releases/tag/0.1.0
|
[Repository name support]: https://github.com/squidfunk/mkdocs-material/releases/tag/0.1.0
|
||||||
[repo_name]: https://www.mkdocs.org/user-guide/configuration/#repo_name
|
[repo_name]: https://www.mkdocs.org/user-guide/configuration/#repo_name
|
||||||
|
|
||||||
#### Repository icon
|
#### Repository icon
|
||||||
|
|
||||||
[:octicons-tag-24: 5.0.0][icon.repo support] ·
|
[:octicons-tag-24: 5.0.0][Repository icon support] ·
|
||||||
:octicons-milestone-24: Default:
|
:octicons-milestone-24: Default:
|
||||||
[`fontawesome/brands/git-alt`][icon.repo default]
|
:fontawesome-brands-git-alt: – `fontawesome/brands/git-alt`
|
||||||
|
|
||||||
While the default repository icon is a generic git icon, it can be set to
|
While the default repository icon is a generic git icon, it can be set to
|
||||||
any icon bundled with the theme by referencing a valid icon path in
|
any icon bundled with the theme by referencing a valid icon path in
|
||||||
@ -97,13 +97,13 @@ Some popular choices:
|
|||||||
- :fontawesome-brands-bitbucket: – `fontawesome/brands/bitbucket`
|
- :fontawesome-brands-bitbucket: – `fontawesome/brands/bitbucket`
|
||||||
- :fontawesome-solid-trash: – `fontawesome/solid/trash`
|
- :fontawesome-solid-trash: – `fontawesome/solid/trash`
|
||||||
|
|
||||||
[icon.repo support]: https://github.com/squidfunk/mkdocs-material/releases/tag/5.0.0
|
[Repository icon support]: https://github.com/squidfunk/mkdocs-material/releases/tag/5.0.0
|
||||||
[icon.repo default]: https://github.com/squidfunk/mkdocs-material/blob/master/material/.icons/fontawesome/brands/git-alt.svg
|
[Repository icon default]: https://github.com/squidfunk/mkdocs-material/blob/master/material/.icons/fontawesome/brands/git-alt.svg
|
||||||
[icon search]: ../reference/icons-emojis.md#search
|
[icon search]: ../reference/icons-emojis.md#search
|
||||||
|
|
||||||
#### Edit button
|
#### Edit button
|
||||||
|
|
||||||
[:octicons-tag-24: 0.1.0][edit_uri support] ·
|
[:octicons-tag-24: 0.1.0][Edit button support] ·
|
||||||
:octicons-milestone-24: Default: _automatically set_
|
:octicons-milestone-24: Default: _automatically set_
|
||||||
|
|
||||||
If the repository URL points to a [GitHub], [GitLab] or [Bitbucket] repository,
|
If the repository URL points to a [GitHub], [GitLab] or [Bitbucket] repository,
|
||||||
@ -122,7 +122,26 @@ changed by setting [`edit_uri`][edit_uri] in `mkdocs.yml`:
|
|||||||
edit_uri: ""
|
edit_uri: ""
|
||||||
```
|
```
|
||||||
|
|
||||||
[edit_uri support]: https://github.com/squidfunk/mkdocs-material/releases/tag/0.1.0
|
The icon of the edit button can be changed with the following lines:
|
||||||
|
|
||||||
|
``` yaml
|
||||||
|
theme:
|
||||||
|
icon:
|
||||||
|
edit: material/pencil # (1)!
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Enter a few keywords to find the perfect icon using our [icon search] and
|
||||||
|
click on the shortcode to copy it to your clipboard:
|
||||||
|
|
||||||
|
<div class="mdx-iconsearch" data-mdx-component="iconsearch">
|
||||||
|
<input class="md-input md-input--stretch mdx-iconsearch__input" placeholder="Search icon" data-mdx-component="iconsearch-query" value="material file edit" />
|
||||||
|
<div class="mdx-iconsearch-result" data-mdx-component="iconsearch-result" data-mdx-mode="file">
|
||||||
|
<div class="mdx-iconsearch-result__meta"></div>
|
||||||
|
<ol class="mdx-iconsearch-result__list"></ol>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
[Edit button support]: https://github.com/squidfunk/mkdocs-material/releases/tag/0.1.0
|
||||||
[edit_uri]: https://www.mkdocs.org/user-guide/configuration/#edit_uri
|
[edit_uri]: https://www.mkdocs.org/user-guide/configuration/#edit_uri
|
||||||
[GitHub]: https://github.com/
|
[GitHub]: https://github.com/
|
||||||
[GitLab]: https://about.gitlab.com/
|
[GitLab]: https://about.gitlab.com/
|
||||||
@ -140,7 +159,7 @@ links to all [contributors] or [authors] involved.
|
|||||||
|
|
||||||
#### Document dates
|
#### Document dates
|
||||||
|
|
||||||
[:octicons-tag-24: 4.6.0][git-revision-date-localized support] ·
|
[:octicons-tag-24: 4.6.0][Document dates support] ·
|
||||||
[:octicons-cpu-24: Plugin][git-revision-date-localized]
|
[:octicons-cpu-24: Plugin][git-revision-date-localized]
|
||||||
|
|
||||||
The [git-revision-date-localized] plugin adds support for adding the date of
|
The [git-revision-date-localized] plugin adds support for adding the date of
|
||||||
@ -161,7 +180,7 @@ plugins:
|
|||||||
|
|
||||||
The following configuration options are supported:
|
The following configuration options are supported:
|
||||||
|
|
||||||
`type`{ #type }
|
[`type`](#+git-revision-date-localized.type){ #+git-revision-date-localized.type }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: `date` – The format of the date to be
|
: :octicons-milestone-24: Default: `date` – The format of the date to be
|
||||||
displayed. Valid values are `date`, `datetime`, `iso_date`, `iso_datetime`
|
displayed. Valid values are `date`, `datetime`, `iso_date`, `iso_datetime`
|
||||||
@ -173,10 +192,9 @@ The following configuration options are supported:
|
|||||||
type: date
|
type: date
|
||||||
```
|
```
|
||||||
|
|
||||||
`enable_creation_date`{ #enable-creation-date }
|
[`enable_creation_date`](#+git-revision-date-localized.enable_creation_date){ #+git-revision-date-localized.enable_creation_date }
|
||||||
|
|
||||||
: [:octicons-tag-24: 7.1.4][enable_creation_date support] ·
|
: :octicons-milestone-24: Default: `false` – Enables the display of the
|
||||||
:octicons-milestone-24: Default: `false` – Enables the display of the
|
|
||||||
creation date of the file associated with the page next to the last updated
|
creation date of the file associated with the page next to the last updated
|
||||||
date at the bottom of the page:
|
date at the bottom of the page:
|
||||||
|
|
||||||
@ -186,7 +204,7 @@ The following configuration options are supported:
|
|||||||
enable_creation_date: true
|
enable_creation_date: true
|
||||||
```
|
```
|
||||||
|
|
||||||
`fallback_to_build_date`{ #fallback-to-build-date }
|
[`fallback_to_build_date`](#+git-revision-date-localized.fallback_to_build_date){ #+git-revision-date-localized.fallback_to_build_date }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: `false` – Enables falling back to
|
: :octicons-milestone-24: Default: `false` – Enables falling back to
|
||||||
the time when `mkdocs build` was executed. Can be used as a fallback when
|
the time when `mkdocs build` was executed. Can be used as a fallback when
|
||||||
@ -202,9 +220,8 @@ The other configuration options of this extension are not officially supported
|
|||||||
by Material for MkDocs, which is why they may yield unexpected results. Use
|
by Material for MkDocs, which is why they may yield unexpected results. Use
|
||||||
them at your own risk.
|
them at your own risk.
|
||||||
|
|
||||||
[git-revision-date-localized support]: https://github.com/squidfunk/mkdocs-material/releases/tag/4.6.0
|
[Document dates support]: https://github.com/squidfunk/mkdocs-material/releases/tag/4.6.0
|
||||||
[git-revision-date-localized]: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
|
[git-revision-date-localized]: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
|
||||||
[enable_creation_date support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.1.4
|
|
||||||
|
|
||||||
#### Document contributors
|
#### Document contributors
|
||||||
|
|
||||||
@ -238,9 +255,9 @@ plugins:
|
|||||||
|
|
||||||
The following configuration options are supported:
|
The following configuration options are supported:
|
||||||
|
|
||||||
`repository`{ #committers-repository }
|
[`repository`](#+git-committers.repository){ #+git-committers.repository }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: Required –
|
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: __Required__ –
|
||||||
This property must be set to the slug of the repository that contains your
|
This property must be set to the slug of the repository that contains your
|
||||||
documentation. The slug must follow the pattern `<username>/<repository>`:
|
documentation. The slug must follow the pattern `<username>/<repository>`:
|
||||||
|
|
||||||
|
@ -49,7 +49,7 @@ from the local file system.
|
|||||||
|
|
||||||
The following configuration options are available:
|
The following configuration options are available:
|
||||||
|
|
||||||
`enabled`{ #enabled }
|
[`enabled`](#+offline.enabled){ #+offline.enabled }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: `true` – This option specifies whether
|
: :octicons-milestone-24: Default: `true` – This option specifies whether
|
||||||
the plugin is enabled when building your project. If you want to switch
|
the plugin is enabled when building your project. If you want to switch
|
||||||
|
@ -18,7 +18,7 @@ fit your brand's identity by using [CSS variables][custom colors].
|
|||||||
|
|
||||||
#### Color scheme
|
#### Color scheme
|
||||||
|
|
||||||
[:octicons-tag-24: 5.2.0][palette.scheme support] ·
|
[:octicons-tag-24: 5.2.0][Color scheme support] ·
|
||||||
:octicons-milestone-24: Default: `default`
|
:octicons-milestone-24: Default: `default`
|
||||||
|
|
||||||
Material for MkDocs supports two color schemes: a __light mode__, which is just
|
Material for MkDocs supports two color schemes: a __light mode__, which is just
|
||||||
@ -50,11 +50,11 @@ Click on a tile to change the color scheme:
|
|||||||
})
|
})
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
[palette.scheme support]: https://github.com/squidfunk/mkdocs-material/releases/tag/5.2.0
|
[Color scheme support]: https://github.com/squidfunk/mkdocs-material/releases/tag/5.2.0
|
||||||
|
|
||||||
#### Primary color
|
#### Primary color
|
||||||
|
|
||||||
[:octicons-tag-24: 0.2.0][palette.primary support] ·
|
[:octicons-tag-24: 0.2.0][Primary color support] ·
|
||||||
:octicons-milestone-24: Default: `indigo`
|
:octicons-milestone-24: Default: `indigo`
|
||||||
|
|
||||||
The primary color is used for the header, the sidebar, text links and several
|
The primary color is used for the header, the sidebar, text links and several
|
||||||
@ -105,11 +105,11 @@ Click on a tile to change the primary color:
|
|||||||
})
|
})
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
[palette.primary support]: https://github.com/squidfunk/mkdocs-material/releases/tag/0.2.0
|
[Primary color support]: https://github.com/squidfunk/mkdocs-material/releases/tag/0.2.0
|
||||||
|
|
||||||
#### Accent color
|
#### Accent color
|
||||||
|
|
||||||
[:octicons-tag-24: 0.2.0][palette.accent support] ·
|
[:octicons-tag-24: 0.2.0][Accent color support] ·
|
||||||
:octicons-milestone-24: Default: `indigo`
|
:octicons-milestone-24: Default: `indigo`
|
||||||
|
|
||||||
The accent color is used to denote elements that can be interacted with, e.g.
|
The accent color is used to denote elements that can be interacted with, e.g.
|
||||||
@ -162,11 +162,11 @@ Click on a tile to change the accent color:
|
|||||||
})
|
})
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
[palette.accent support]: https://github.com/squidfunk/mkdocs-material/releases/tag/0.2.0
|
[Accent color support]: https://github.com/squidfunk/mkdocs-material/releases/tag/0.2.0
|
||||||
|
|
||||||
### Color palette toggle
|
### Color palette toggle
|
||||||
|
|
||||||
[:octicons-tag-24: 7.1.0][palette.toggle support] ·
|
[:octicons-tag-24: 7.1.0][Color palette toggle support] ·
|
||||||
:octicons-milestone-24: Default: _none_
|
:octicons-milestone-24: Default: _none_
|
||||||
|
|
||||||
Offering a light _and_ dark color palette makes your documentation pleasant to
|
Offering a light _and_ dark color palette makes your documentation pleasant to
|
||||||
@ -209,9 +209,9 @@ and [`accent`][palette.accent] per color palette.
|
|||||||
|
|
||||||
The following properties must be set for each toggle:
|
The following properties must be set for each toggle:
|
||||||
|
|
||||||
`icon`{ #toggle-icon }
|
[`icon`](#+palette.toggle.icon){ #+palette.toggle.icon }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: Required –
|
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: __Required__ –
|
||||||
This property must point to a valid icon path referencing any icon bundled
|
This property must point to a valid icon path referencing any icon bundled
|
||||||
with the theme, or the build will not succeed. Some popular combinations:
|
with the theme, or the build will not succeed. Some popular combinations:
|
||||||
|
|
||||||
@ -221,13 +221,13 @@ The following properties must be set for each toggle:
|
|||||||
* :material-eye: + :material-eye-outline: – `material/eye` + `material/eye-outline`
|
* :material-eye: + :material-eye-outline: – `material/eye` + `material/eye-outline`
|
||||||
* :material-lightbulb: + :material-lightbulb-outline: – `material/lightbulb` + `material/lightbulb-outline`
|
* :material-lightbulb: + :material-lightbulb-outline: – `material/lightbulb` + `material/lightbulb-outline`
|
||||||
|
|
||||||
`name`{ #toggle-name }
|
[`name`](#+palette.toggle.name){ #+palette.toggle.name }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: Required –
|
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: __Required__ –
|
||||||
This property is used as the toggle's `title` attribute and should be set to
|
This property is used as the toggle's `title` attribute and should be set to
|
||||||
a discernable name to improve accessibility. It's rendered as a [tooltip].
|
a discernable name to improve accessibility. It's rendered as a [tooltip].
|
||||||
|
|
||||||
[palette.toggle support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.1.0
|
[Color palette toggle support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.1.0
|
||||||
[palette.scheme]: #color-scheme
|
[palette.scheme]: #color-scheme
|
||||||
[palette.primary]: #primary-color
|
[palette.primary]: #primary-color
|
||||||
[palette.accent]: #accent-color
|
[palette.accent]: #accent-color
|
||||||
@ -236,7 +236,7 @@ The following properties must be set for each toggle:
|
|||||||
|
|
||||||
### System preference
|
### System preference
|
||||||
|
|
||||||
[:octicons-tag-24: 7.1.0][palette.media support] ·
|
[:octicons-tag-24: 7.1.0][System preference support] ·
|
||||||
:octicons-milestone-24: Default: _none_
|
:octicons-milestone-24: Default: _none_
|
||||||
|
|
||||||
Each color palette can be linked to the user's system preference for light and
|
Each color palette can be linked to the user's system preference for light and
|
||||||
@ -266,7 +266,7 @@ When the user first visits your site, the media queries are evaluated in the
|
|||||||
order of their definition. The first media query that matches selects the
|
order of their definition. The first media query that matches selects the
|
||||||
default color palette.
|
default color palette.
|
||||||
|
|
||||||
[palette.media support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.1.0
|
[System preference support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.1.0
|
||||||
|
|
||||||
#### Automatic light / dark mode
|
#### Automatic light / dark mode
|
||||||
|
|
||||||
@ -327,7 +327,7 @@ Let's say you're :fontawesome-brands-youtube:{ style="color: #EE0F0F" }
|
|||||||
__YouTube__, and want to set the primary color to your brand's palette. Just
|
__YouTube__, and want to set the primary color to your brand's palette. Just
|
||||||
add:
|
add:
|
||||||
|
|
||||||
=== ":octicons-file-code-16: docs/stylesheets/extra.css"
|
=== ":octicons-file-code-16: `docs/stylesheets/extra.css`"
|
||||||
|
|
||||||
``` css
|
``` css
|
||||||
:root > * {
|
:root > * {
|
||||||
@ -337,7 +337,7 @@ add:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: mkdocs.yml"
|
=== ":octicons-file-code-16: `mkdocs.yml`"
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
extra_css:
|
extra_css:
|
||||||
@ -358,7 +358,7 @@ by wrapping the definitions in a `[data-md-color-scheme="..."]`
|
|||||||
[attribute selector], which you can then set via `mkdocs.yml` as described
|
[attribute selector], which you can then set via `mkdocs.yml` as described
|
||||||
in the [color schemes][palette.scheme] section:
|
in the [color schemes][palette.scheme] section:
|
||||||
|
|
||||||
=== ":octicons-file-code-16: docs/stylesheets/extra.css"
|
=== ":octicons-file-code-16: `docs/stylesheets/extra.css`"
|
||||||
|
|
||||||
``` css
|
``` css
|
||||||
[data-md-color-scheme="youtube"] {
|
[data-md-color-scheme="youtube"] {
|
||||||
@ -368,7 +368,7 @@ in the [color schemes][palette.scheme] section:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: mkdocs.yml"
|
=== ":octicons-file-code-16: `mkdocs.yml`"
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
theme:
|
theme:
|
||||||
|
@ -15,7 +15,7 @@ or another destination should be used.
|
|||||||
|
|
||||||
### Regular font
|
### Regular font
|
||||||
|
|
||||||
[:octicons-tag-24: 0.1.2][font support] ·
|
[:octicons-tag-24: 0.1.2][Font support] ·
|
||||||
:octicons-milestone-24: Default: [`Roboto`][Roboto]
|
:octicons-milestone-24: Default: [`Roboto`][Roboto]
|
||||||
|
|
||||||
The regular font is used for all body copy, headlines, and essentially
|
The regular font is used for all body copy, headlines, and essentially
|
||||||
@ -31,11 +31,11 @@ theme:
|
|||||||
The typeface will be loaded in 300, 400, _400i_ and __700__.
|
The typeface will be loaded in 300, 400, _400i_ and __700__.
|
||||||
|
|
||||||
[Roboto]: https://fonts.google.com/specimen/Roboto
|
[Roboto]: https://fonts.google.com/specimen/Roboto
|
||||||
[font support]: https://github.com/squidfunk/mkdocs-material/releases/tag/0.1.2
|
[Font support]: https://github.com/squidfunk/mkdocs-material/releases/tag/0.1.2
|
||||||
|
|
||||||
### Monospaced font
|
### Monospaced font
|
||||||
|
|
||||||
[:octicons-tag-24: 0.1.2][font support] ·
|
[:octicons-tag-24: 0.1.2][Font support] ·
|
||||||
:octicons-milestone-24: Default: [`Roboto Mono`][Roboto Mono]
|
:octicons-milestone-24: Default: [`Roboto Mono`][Roboto Mono]
|
||||||
|
|
||||||
The _monospaced font_ is used for code blocks and can be configured separately.
|
The _monospaced font_ is used for code blocks and can be configured separately.
|
||||||
@ -54,7 +54,7 @@ The typeface will be loaded in 400.
|
|||||||
|
|
||||||
### Autoloading
|
### Autoloading
|
||||||
|
|
||||||
[:octicons-tag-24: 1.0.0][font=false support] ·
|
[:octicons-tag-24: 1.0.0][Autoloading support] ·
|
||||||
:octicons-milestone-24: Default: _none_
|
:octicons-milestone-24: Default: _none_
|
||||||
|
|
||||||
If you want to prevent typefaces from being loaded from [Google Fonts], e.g.
|
If you want to prevent typefaces from being loaded from [Google Fonts], e.g.
|
||||||
@ -73,7 +73,7 @@ theme:
|
|||||||
by automatically downloading and self-hosting the web font files.
|
by automatically downloading and self-hosting the web font files.
|
||||||
|
|
||||||
[data privacy]: https://developers.google.com/fonts/faq#what_does_using_the_google_fonts_api_mean_for_the_privacy_of_my_users
|
[data privacy]: https://developers.google.com/fonts/faq#what_does_using_the_google_fonts_api_mean_for_the_privacy_of_my_users
|
||||||
[font=false support]: https://github.com/squidfunk/mkdocs-material/releases/tag/1.0.0
|
[Autoloading support]: https://github.com/squidfunk/mkdocs-material/releases/tag/1.0.0
|
||||||
[built-in privacy plugin]: ensuring-data-privacy.md#built-in-privacy-plugin
|
[built-in privacy plugin]: ensuring-data-privacy.md#built-in-privacy-plugin
|
||||||
|
|
||||||
## Customization
|
## Customization
|
||||||
@ -84,7 +84,7 @@ If you want to load an (additional) font from another destination or override
|
|||||||
the system font, you can use an [additional style sheet] to add the
|
the system font, you can use an [additional style sheet] to add the
|
||||||
corresponding `@font-face` definition:
|
corresponding `@font-face` definition:
|
||||||
|
|
||||||
=== ":octicons-file-code-16: docs/stylesheets/extra.css"
|
=== ":octicons-file-code-16: `docs/stylesheets/extra.css`"
|
||||||
|
|
||||||
``` css
|
``` css
|
||||||
@font-face {
|
@font-face {
|
||||||
@ -93,7 +93,7 @@ corresponding `@font-face` definition:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: mkdocs.yml"
|
=== ":octicons-file-code-16: `mkdocs.yml`"
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
extra_css:
|
extra_css:
|
||||||
|
@ -13,7 +13,7 @@ available.
|
|||||||
|
|
||||||
### Site language
|
### Site language
|
||||||
|
|
||||||
[:octicons-tag-24: 1.12.0][language support] ·
|
[:octicons-tag-24: 1.12.0][Site language support] ·
|
||||||
:octicons-milestone-24: Default: `en`
|
:octicons-milestone-24: Default: `en`
|
||||||
|
|
||||||
You can set the site language in `mkdocs.yml` with:
|
You can set the site language in `mkdocs.yml` with:
|
||||||
@ -100,7 +100,7 @@ The following languages are supported:
|
|||||||
Note that some languages will produce unreadable anchor links due to the way
|
Note that some languages will produce unreadable anchor links due to the way
|
||||||
the default slug function works. Consider using a [Unicode-aware slug function].
|
the default slug function works. Consider using a [Unicode-aware slug function].
|
||||||
|
|
||||||
[language support]: https://github.com/squidfunk/mkdocs-material/releases/tag/1.12.0
|
[Site language support]: https://github.com/squidfunk/mkdocs-material/releases/tag/1.12.0
|
||||||
[single language per document]: https://www.w3.org/International/questions/qa-html-language-declarations.en#attributes
|
[single language per document]: https://www.w3.org/International/questions/qa-html-language-declarations.en#attributes
|
||||||
[language selector]: #site-language-selector
|
[language selector]: #site-language-selector
|
||||||
[Unicode-aware slug function]: extensions/python-markdown.md#toc-slugify
|
[Unicode-aware slug function]: extensions/python-markdown.md#toc-slugify
|
||||||
@ -108,7 +108,7 @@ the default slug function works. Consider using a [Unicode-aware slug function].
|
|||||||
|
|
||||||
### Site language selector
|
### Site language selector
|
||||||
|
|
||||||
[:octicons-tag-24: 7.0.0][alternate support] ·
|
[:octicons-tag-24: 7.0.0][Site language selector support] ·
|
||||||
:octicons-milestone-24: Default: _none_ ·
|
:octicons-milestone-24: Default: _none_ ·
|
||||||
:octicons-beaker-24: Experimental
|
:octicons-beaker-24: Experimental
|
||||||
|
|
||||||
@ -133,35 +133,35 @@ extra:
|
|||||||
|
|
||||||
The following properties are available for each alternate language:
|
The following properties are available for each alternate language:
|
||||||
|
|
||||||
`name`{ #language-name }
|
[`name`](#+alternate.name){ #+alternate.name }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: Required –
|
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: __Required__ –
|
||||||
This value of this property is used inside the language selector as the
|
This value of this property is used inside the language selector as the
|
||||||
name of the language and must be set to a non-empty string.
|
name of the language and must be set to a non-empty string.
|
||||||
|
|
||||||
`link`{ #language-link }
|
[`link`](#+alternate.link){ #+alternate.link }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: Required –
|
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: __Required__ –
|
||||||
This property must be set to an absolute link, which might also point to
|
This property must be set to an absolute link, which might also point to
|
||||||
another domain or subdomain not necessarily generated with MkDocs.
|
another domain or subdomain not necessarily generated with MkDocs.
|
||||||
|
|
||||||
`lang`{ #language-lang }
|
[`lang`](#+alternate.lang){ #+alternate.lang }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: Required –
|
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: __Required__ –
|
||||||
This property must contain an [ISO 639-1 language code] and is used for
|
This property must contain an [ISO 639-1 language code] and is used for
|
||||||
the `hreflang` attribute of the link, improving discoverability via search
|
the `hreflang` attribute of the link, improving discoverability via search
|
||||||
engines.
|
engines.
|
||||||
|
|
||||||
[![Language selector preview]][Language selector preview]
|
[![Language selector preview]][Language selector preview]
|
||||||
|
|
||||||
[alternate support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.0.0
|
[Site language selector support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.0.0
|
||||||
[site_url]: https://www.mkdocs.org/user-guide/configuration/#site_url
|
[site_url]: https://www.mkdocs.org/user-guide/configuration/#site_url
|
||||||
[ISO 639-1 language code]: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
|
[ISO 639-1 language code]: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
|
||||||
[Language selector preview]: ../assets/screenshots/language-selection.png
|
[Language selector preview]: ../assets/screenshots/language-selection.png
|
||||||
|
|
||||||
### Directionality
|
### Directionality
|
||||||
|
|
||||||
[:octicons-tag-24: 2.5.0][direction support] ·
|
[:octicons-tag-24: 2.5.0][Directionality support] ·
|
||||||
:octicons-milestone-24: Default: _automatically set_
|
:octicons-milestone-24: Default: _automatically set_
|
||||||
|
|
||||||
While many languages are read `ltr` (left-to-right), Material for MkDocs also
|
While many languages are read `ltr` (left-to-right), Material for MkDocs also
|
||||||
@ -192,7 +192,7 @@ Click on a tile to change the directionality:
|
|||||||
})
|
})
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
[direction support]: https://github.com/squidfunk/mkdocs-material/releases/tag/2.5.0
|
[Directionality support]: https://github.com/squidfunk/mkdocs-material/releases/tag/2.5.0
|
||||||
|
|
||||||
## Customization
|
## Customization
|
||||||
|
|
||||||
@ -203,7 +203,7 @@ the guide on [theme extension] and create a new partial in the `overrides`
|
|||||||
folder. Then, import the [translations] of the language as a fallback and only
|
folder. Then, import the [translations] of the language as a fallback and only
|
||||||
adjust the ones you want to override:
|
adjust the ones you want to override:
|
||||||
|
|
||||||
=== ":octicons-file-code-16: overrides/partials/languages/custom.html"
|
=== ":octicons-file-code-16: `overrides/partials/languages/custom.html`"
|
||||||
|
|
||||||
``` html
|
``` html
|
||||||
<!-- Import translations for language and fallback -->
|
<!-- Import translations for language and fallback -->
|
||||||
@ -228,7 +228,7 @@ adjust the ones you want to override:
|
|||||||
2. Check the [list of available languages], pick the translation you want
|
2. Check the [list of available languages], pick the translation you want
|
||||||
to override for your language and add them here.
|
to override for your language and add them here.
|
||||||
|
|
||||||
=== ":octicons-file-code-16: mkdocs.yml"
|
=== ":octicons-file-code-16: `mkdocs.yml`"
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
theme:
|
theme:
|
||||||
|
@ -15,8 +15,8 @@ when writing your documentation in Markdown. Not enough? You can also add
|
|||||||
|
|
||||||
### Logo
|
### Logo
|
||||||
|
|
||||||
[:octicons-tag-24: 0.1.0][logo support] ·
|
[:octicons-tag-24: 0.1.0][Logo support] ·
|
||||||
:octicons-milestone-24: Default: [`material/library`][logo default]
|
:octicons-milestone-24: Default: :material-library: – `material/library`
|
||||||
|
|
||||||
The logo can be changed to a user-provided image (any type, incl. `*.png` and
|
The logo can be changed to a user-provided image (any type, incl. `*.png` and
|
||||||
`*.svg`) located in the `docs` folder, or to any icon bundled with the theme.
|
`*.svg`) located in the `docs` folder, or to any icon bundled with the theme.
|
||||||
@ -48,8 +48,7 @@ Add the following lines to `mkdocs.yml`:
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
[logo support]: https://github.com/squidfunk/mkdocs-material/releases/tag/0.1.0
|
[Logo support]: https://github.com/squidfunk/mkdocs-material/releases/tag/0.1.0
|
||||||
[logo default]: https://github.com/squidfunk/mkdocs-material/blob/master/material/.icons/material/library.svg
|
|
||||||
[icon search]: ../reference/icons-emojis.md#search
|
[icon search]: ../reference/icons-emojis.md#search
|
||||||
|
|
||||||
Normally, the logo in the header and sidebar links to the homepage of the
|
Normally, the logo in the header and sidebar links to the homepage of the
|
||||||
@ -63,8 +62,8 @@ extra:
|
|||||||
|
|
||||||
### Favicon
|
### Favicon
|
||||||
|
|
||||||
[:octicons-tag-24: 0.1.0][favicon support] ·
|
[:octicons-tag-24: 0.1.0][Favicon support] ·
|
||||||
:octicons-milestone-24: Default: [`assets/images/favicon.png`][favicon default]
|
:octicons-milestone-24: Default: [`assets/images/favicon.png`][Favicon default]
|
||||||
|
|
||||||
The favicon can be changed to a path pointing to a user-provided image, which
|
The favicon can be changed to a path pointing to a user-provided image, which
|
||||||
must be located in the `docs` folder. Add the following lines to `mkdocs.yml`:
|
must be located in the `docs` folder. Add the following lines to `mkdocs.yml`:
|
||||||
@ -74,8 +73,8 @@ theme:
|
|||||||
favicon: images/favicon.png
|
favicon: images/favicon.png
|
||||||
```
|
```
|
||||||
|
|
||||||
[favicon support]: https://github.com/squidfunk/mkdocs-material/releases/tag/0.1.0
|
[Favicon support]: https://github.com/squidfunk/mkdocs-material/releases/tag/0.1.0
|
||||||
[favicon default]: https://github.com/squidfunk/mkdocs-material/blob/master/material/assets/images/favicon.png
|
[Favicon default]: https://github.com/squidfunk/mkdocs-material/blob/master/material/assets/images/favicon.png
|
||||||
|
|
||||||
## Customization
|
## Customization
|
||||||
|
|
||||||
|
@ -6,23 +6,23 @@ template: overrides/main.html
|
|||||||
|
|
||||||
Material for MkDocs makes compliance with data privacy regulations very easy,
|
Material for MkDocs makes compliance with data privacy regulations very easy,
|
||||||
as it offers a native [cookie consent] solution to seek explicit consent from
|
as it offers a native [cookie consent] solution to seek explicit consent from
|
||||||
users before setting up [tracking]. Additionally, external assets can be
|
users before setting up [analytics]. Additionally, external assets can be
|
||||||
automatically downloaded for [self-hosting].
|
automatically downloaded for [self-hosting].
|
||||||
|
|
||||||
[cookie consent]: #native-cookie-consent
|
[cookie consent]: #cookie-consent
|
||||||
[tracking]: setting-up-site-analytics.md
|
[analytics]: setting-up-site-analytics.md
|
||||||
[self-hosting]: #built-in-privacy-plugin
|
[self-hosting]: #built-in-privacy-plugin
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
### Cookie consent { #native-cookie-consent }
|
### Cookie consent
|
||||||
|
|
||||||
[:octicons-tag-24: 8.4.0][cookie consent support] ·
|
[:octicons-tag-24: 8.4.0][Cookie consent support] ·
|
||||||
:octicons-milestone-24: Default: _none_ ·
|
:octicons-milestone-24: Default: _none_ ·
|
||||||
:octicons-beaker-24: Experimental
|
:octicons-beaker-24: Experimental
|
||||||
|
|
||||||
Material for MkDocs ships a native and extensible cookie consent form which
|
Material for MkDocs ships a native and extensible cookie consent form which
|
||||||
asks the user for consent prior to sending any data via analytics. Add the
|
asks the user for consent prior to sending requests to third parties. Add the
|
||||||
following to `mkdocs.yml`:
|
following to `mkdocs.yml`:
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
@ -41,25 +41,30 @@ extra:
|
|||||||
|
|
||||||
The following properties are available:
|
The following properties are available:
|
||||||
|
|
||||||
`title`{ #consent-title }
|
[`title`](#+consent.title){ #+consent.title }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: Required –
|
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: __Required__ –
|
||||||
This property sets the title of the cookie consent, which is rendered at the
|
This property sets the title of the cookie consent, which is rendered at the
|
||||||
top of the form and must be set to a non-empty string.
|
top of the form and must be set to a non-empty string.
|
||||||
|
|
||||||
`description`{ #consent-description }
|
[`description`](#+consent.description){ #+consent.description }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: Required –
|
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: __Required__ –
|
||||||
This property sets the description of the cookie consent, is rendered below
|
This property sets the description of the cookie consent, is rendered below
|
||||||
the title, and may include raw HTML (e.g. a links to the terms of service).
|
the title, and may include raw HTML (e.g. a links to the terms of service).
|
||||||
|
|
||||||
`cookies`{ #consent-cookies }
|
[`cookies`](#+consent.cookies){ #+consent.cookies }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: _none_ – This property allows to add custom
|
: :octicons-milestone-24: Default: _none_ – This property allows to add custom
|
||||||
cookies or change the initial `checked` state and name of the `analytics`
|
cookies or change the initial `checked` state and name of built-in cookies.
|
||||||
cookie. Each cookie must receive a unique identifier which is used as a key
|
Currently, the following cookies are built-in:
|
||||||
in the `cookies` map, and can be either set to a string, or to a map
|
|
||||||
defining `name` and `checked` state:
|
- __Google Analytics__ – `analytics` (enabled by default)
|
||||||
|
- __GitHub__ – `github` (enabled by default)
|
||||||
|
|
||||||
|
Each cookie must receive a unique identifier which is used as a key in the
|
||||||
|
`cookies` map, and can be either set to a string, or to a map defining
|
||||||
|
`name` and `checked` state:
|
||||||
|
|
||||||
=== "Custom cookie name"
|
=== "Custom cookie name"
|
||||||
|
|
||||||
@ -95,11 +100,11 @@ The following properties are available:
|
|||||||
the `analytics` cookie must be added back explicitly, or analytics
|
the `analytics` cookie must be added back explicitly, or analytics
|
||||||
won't be triggered.
|
won't be triggered.
|
||||||
|
|
||||||
|
If Google Analytics was configured via `mkdocs.yml`, the cookie consent will
|
||||||
If Google Analytics was configured via `mkdocs.yml`, the cookie consent will automatically include a setting for the user to disable it. [Custom cookies]
|
automatically include a setting for the user to disable it. [Custom cookies]
|
||||||
can be used from JavaScript.
|
can be used from JavaScript.
|
||||||
|
|
||||||
`actions`{ #consent-actions }
|
[`actions`](#+consent.actions){ #+consent.actions }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: `[accept, manage]` – This property defines
|
: :octicons-milestone-24: Default: `[accept, manage]` – This property defines
|
||||||
which buttons are shown and in which order, e.g. to allow the user to accept
|
which buttons are shown and in which order, e.g. to allow the user to accept
|
||||||
@ -121,11 +126,11 @@ The following properties are available:
|
|||||||
|
|
||||||
When a user first visits your site, a cookie consent form is rendered:
|
When a user first visits your site, a cookie consent form is rendered:
|
||||||
|
|
||||||
[![cookie consent enabled]][cookie consent enabled]
|
[![Cookie consent enabled]][Cookie consent enabled]
|
||||||
|
|
||||||
[Custom cookies]: #custom-cookies
|
[Custom cookies]: #custom-cookies
|
||||||
[cookie consent support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.4.0
|
[Cookie consent support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.4.0
|
||||||
[cookie consent enabled]: ../assets/screenshots/consent.png
|
[Cookie consent enabled]: ../assets/screenshots/consent.png
|
||||||
|
|
||||||
#### Change cookie settings
|
#### Change cookie settings
|
||||||
|
|
||||||
@ -168,7 +173,7 @@ plugins:
|
|||||||
|
|
||||||
The following configuration options are available:
|
The following configuration options are available:
|
||||||
|
|
||||||
`enabled`{ #enabled }
|
[`enabled`](#+privacy.enabled){ #+privacy.enabled }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: `true` – This option specifies whether
|
: :octicons-milestone-24: Default: `true` – This option specifies whether
|
||||||
the plugin is enabled when building your project. If you want to switch
|
the plugin is enabled when building your project. If you want to switch
|
||||||
@ -180,7 +185,7 @@ The following configuration options are available:
|
|||||||
enabled: !ENV [PRIVACY, false]
|
enabled: !ENV [PRIVACY, false]
|
||||||
```
|
```
|
||||||
|
|
||||||
`externals`{ #externals }
|
[`externals`](#+privacy.externals){ #+privacy.externals }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: `bundle` – This option specifies what the
|
: :octicons-milestone-24: Default: `bundle` – This option specifies what the
|
||||||
plugin should do when encountering external assets. There are two options:
|
plugin should do when encountering external assets. There are two options:
|
||||||
@ -204,7 +209,7 @@ The following configuration options are available:
|
|||||||
[customization]: ../customization.md
|
[customization]: ../customization.md
|
||||||
[strict mode]: https://www.mkdocs.org/user-guide/configuration/#strict
|
[strict mode]: https://www.mkdocs.org/user-guide/configuration/#strict
|
||||||
|
|
||||||
`externals_dir`{ #externals-dir }
|
[`externals_dir`](#+privacy.externals_dir){ #+privacy.externals_dir }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: `assets/externals` – This option
|
: :octicons-milestone-24: Default: `assets/externals` – This option
|
||||||
specifies where the downloaded [external assets] will be stored. It's
|
specifies where the downloaded [external assets] will be stored. It's
|
||||||
@ -216,7 +221,7 @@ The following configuration options are available:
|
|||||||
externals_dir: assets/externals
|
externals_dir: assets/externals
|
||||||
```
|
```
|
||||||
|
|
||||||
`externals_exclude`{ #externals-exclude }
|
[`externals_exclude`](#+privacy.externals_exclude){ #+privacy.externals_exclude }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: _none_ – This option allows to exclude
|
: :octicons-milestone-24: Default: _none_ – This option allows to exclude
|
||||||
certain external assets from processing by the privacy plugin, so they will
|
certain external assets from processing by the privacy plugin, so they will
|
||||||
@ -440,7 +445,7 @@ If you've customized the [cookie consent] and added a `custom` cookie, the user
|
|||||||
will be prompted to accept your custom cookie. Use [additional JavaScript] to
|
will be prompted to accept your custom cookie. Use [additional JavaScript] to
|
||||||
check whether the user accepted it:
|
check whether the user accepted it:
|
||||||
|
|
||||||
=== ":octicons-file-code-16: docs/javascripts/consent.js"
|
=== ":octicons-file-code-16: `docs/javascripts/consent.js`"
|
||||||
|
|
||||||
``` js
|
``` js
|
||||||
var consent = __md_get("__consent")
|
var consent = __md_get("__consent")
|
||||||
@ -449,7 +454,7 @@ check whether the user accepted it:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: mkdocs.yml"
|
=== ":octicons-file-code-16: `mkdocs.yml`"
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
extra_javascript:
|
extra_javascript:
|
||||||
|
@ -37,7 +37,7 @@ Besides enabling the extension in `mkdocs.yml`, a MathJax configuration and
|
|||||||
the JavaScript runtime need to be included, which can be done with a few lines
|
the JavaScript runtime need to be included, which can be done with a few lines
|
||||||
of [additional JavaScript]:
|
of [additional JavaScript]:
|
||||||
|
|
||||||
=== ":octicons-file-code-16: docs/javascripts/mathjax.js"
|
=== ":octicons-file-code-16: `docs/javascripts/mathjax.js`"
|
||||||
|
|
||||||
``` js
|
``` js
|
||||||
window.MathJax = {
|
window.MathJax = {
|
||||||
@ -58,7 +58,7 @@ of [additional JavaScript]:
|
|||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: mkdocs.yml"
|
=== ":octicons-file-code-16: `mkdocs.yml`"
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
extra_javascript:
|
extra_javascript:
|
||||||
@ -154,7 +154,7 @@ markdown_extensions:
|
|||||||
|
|
||||||
The following configuration options are supported:
|
The following configuration options are supported:
|
||||||
|
|
||||||
`mode`{ #critic-mode }
|
[`mode`](#+pymdownx.critic.mode){ #+pymdownx.critic.mode }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: `view` – This option defines how the markup
|
: :octicons-milestone-24: Default: `view` – This option defines how the markup
|
||||||
should be parsed, i.e. whether to just `view` all suggested changes, or
|
should be parsed, i.e. whether to just `view` all suggested changes, or
|
||||||
@ -237,7 +237,7 @@ markdown_extensions:
|
|||||||
|
|
||||||
The following configuration options are supported:
|
The following configuration options are supported:
|
||||||
|
|
||||||
`emoji_index`{ #emoji-index }
|
[`emoji_index`](#+pymdownx.emoji.emoji_index){ #+pymdownx.emoji.emoji_index }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: `emojione` – This option defines which set
|
: :octicons-milestone-24: Default: `emojione` – This option defines which set
|
||||||
of emojis is used for rendering. Note that the use of `emojione` is not
|
of emojis is used for rendering. Note that the use of `emojione` is not
|
||||||
@ -249,7 +249,7 @@ The following configuration options are supported:
|
|||||||
emoji_index: !!python/name:materialx.emoji.twemoji
|
emoji_index: !!python/name:materialx.emoji.twemoji
|
||||||
```
|
```
|
||||||
|
|
||||||
`emoji_generator`{ #emoji-generator }
|
[`emoji_generator`](#+pymdownx.emoji.emoji_generator){ #+pymdownx.emoji.emoji_generator }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: `to_png` – This option defines how the
|
: :octicons-milestone-24: Default: `to_png` – This option defines how the
|
||||||
resolved emoji or icon shortcode is render. Note that icons can only be
|
resolved emoji or icon shortcode is render. Note that icons can only be
|
||||||
@ -261,7 +261,7 @@ The following configuration options are supported:
|
|||||||
emoji_generator: !!python/name:materialx.emoji.to_svg
|
emoji_generator: !!python/name:materialx.emoji.to_svg
|
||||||
```
|
```
|
||||||
|
|
||||||
`options.custom_icons`{ #custom-icons }
|
[`options.custom_icons`](#+pymdownx.emoji.options.custom_icons){ #+pymdownx.emoji.options.custom_icons }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: _none_ – This option allows to list folders
|
: :octicons-milestone-24: Default: _none_ – This option allows to list folders
|
||||||
with additional icon sets to be used in Markdown or `mkdocs.yml`, which is
|
with additional icon sets to be used in Markdown or `mkdocs.yml`, which is
|
||||||
@ -319,7 +319,7 @@ markdown_extensions:
|
|||||||
|
|
||||||
The following configuration options are supported:
|
The following configuration options are supported:
|
||||||
|
|
||||||
`use_pygments`{ #highlight-use-pygments }
|
[`use_pygments`](#+pymdownx.highlight.use_pygments){ #+pymdownx.highlight.use_pygments }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: `true` – This option allows to control
|
: :octicons-milestone-24: Default: `true` – This option allows to control
|
||||||
whether highlighting should be carried out during build time using
|
whether highlighting should be carried out during build time using
|
||||||
@ -346,7 +346,7 @@ The following configuration options are supported:
|
|||||||
integrated with some [additional JavaScript] and an [additional style
|
integrated with some [additional JavaScript] and an [additional style
|
||||||
sheet] in `mkdocs.yml`:
|
sheet] in `mkdocs.yml`:
|
||||||
|
|
||||||
=== ":octicons-file-code-16: docs/javascripts/highlight.js"
|
=== ":octicons-file-code-16: `docs/javascripts/highlight.js`"
|
||||||
|
|
||||||
``` js
|
``` js
|
||||||
document$.subscribe(() => {
|
document$.subscribe(() => {
|
||||||
@ -354,7 +354,7 @@ The following configuration options are supported:
|
|||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: mkdocs.yml"
|
=== ":octicons-file-code-16: `mkdocs.yml`"
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
extra_javascript:
|
extra_javascript:
|
||||||
@ -371,7 +371,7 @@ The following configuration options are supported:
|
|||||||
syntax highlighting using [Pygments], so they don't apply if `use_pygments`
|
syntax highlighting using [Pygments], so they don't apply if `use_pygments`
|
||||||
is set to `false`.
|
is set to `false`.
|
||||||
|
|
||||||
`auto_title`{ #highlight-auto-title }
|
[`auto_title`](#+pymdownx.highlight.auto_title){ #+pymdownx.highlight.auto_title }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: `false` – This option will automatically
|
: :octicons-milestone-24: Default: `false` – This option will automatically
|
||||||
add a [title] to all code blocks that shows the name of the language being
|
add a [title] to all code blocks that shows the name of the language being
|
||||||
@ -383,7 +383,7 @@ The following configuration options are supported:
|
|||||||
auto_title: true
|
auto_title: true
|
||||||
```
|
```
|
||||||
|
|
||||||
`linenums`{ #highlight-linenums }
|
[`linenums`](#+pymdownx.highlight.linenums){ #+pymdownx.highlight.linenums }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: `false` – This option will add line numbers
|
: :octicons-milestone-24: Default: `false` – This option will add line numbers
|
||||||
to _all_ code blocks. If you wish to add line numbers to _some_, but not all
|
to _all_ code blocks. If you wish to add line numbers to _some_, but not all
|
||||||
@ -397,7 +397,7 @@ The following configuration options are supported:
|
|||||||
linenums: true
|
linenums: true
|
||||||
```
|
```
|
||||||
|
|
||||||
`linenums_style`{ #highlight-linenums-style }
|
[`linenums_style`](#+pymdownx.highlight.linenums_style){ #+pymdownx.highlight.linenums_style }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: `table` – The [Highlight] extension
|
: :octicons-milestone-24: Default: `table` – The [Highlight] extension
|
||||||
provides three ways to add line numbers, two of which are supported by
|
provides three ways to add line numbers, two of which are supported by
|
||||||
@ -415,7 +415,7 @@ The following configuration options are supported:
|
|||||||
copying a code block to the clipboard. Thus, the usage of either `table`
|
copying a code block to the clipboard. Thus, the usage of either `table`
|
||||||
or `pymdownx-inline` is recommended.
|
or `pymdownx-inline` is recommended.
|
||||||
|
|
||||||
`anchor_linenums`{ #highlight-anchor-linenums }
|
[`anchor_linenums`](#+pymdownx.highlight.anchor_linenums){ #+pymdownx.highlight.anchor_linenums }
|
||||||
|
|
||||||
: [:octicons-tag-24: 8.1.0][anchor_linenums support] · :octicons-milestone-24:
|
: [:octicons-tag-24: 8.1.0][anchor_linenums support] · :octicons-milestone-24:
|
||||||
Default: `false` – If a code blocks contains line numbers, enabling this
|
Default: `false` – If a code blocks contains line numbers, enabling this
|
||||||
@ -579,7 +579,7 @@ markdown_extensions:
|
|||||||
|
|
||||||
The following configuration options are supported:
|
The following configuration options are supported:
|
||||||
|
|
||||||
`custom_fences`{ #superfences-custom-fences }
|
[`custom_fences`](#+pymdownx.superfences.custom_fences){ #+pymdownx.superfences.custom_fences }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: _none_ – This option allows to define a
|
: :octicons-milestone-24: Default: _none_ – This option allows to define a
|
||||||
handler for custom fences, e.g. to preserve the definitions of [Mermaid.js]
|
handler for custom fences, e.g. to preserve the definitions of [Mermaid.js]
|
||||||
@ -643,11 +643,11 @@ markdown_extensions:
|
|||||||
|
|
||||||
The following configuration options are supported:
|
The following configuration options are supported:
|
||||||
|
|
||||||
`alternate_style`{ #tabbed-alternate-style }
|
[`alternate_style`](#+pymdownx.tabbed.alternate_style){ #+pymdownx.tabbed:alternate_style }
|
||||||
|
|
||||||
: [:octicons-tag-24: 7.3.1][Tabbed alternate support] ·
|
: [:octicons-tag-24: 7.3.1][Tabbed alternate support] ·
|
||||||
:octicons-milestone-24: Default: `false` · :octicons-alert-24: Required –
|
:octicons-milestone-24: Default: `false` · :octicons-alert-24: __Required__
|
||||||
This option enables the content tabs [alternate style], which has
|
– This option enables the content tabs [alternate style], which has
|
||||||
[better behavior on mobile viewports], and is the only supported style:
|
[better behavior on mobile viewports], and is the only supported style:
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
@ -692,7 +692,7 @@ markdown_extensions:
|
|||||||
|
|
||||||
The following configuration options are supported:
|
The following configuration options are supported:
|
||||||
|
|
||||||
`custom_checkbox`{ #tasklist-custom-checkbox }
|
[`custom_checkbox`](#+pymdownx.tasklist.custom_checkbox){ #+pymdownx.tasklist:custom_checkbox }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: `false` · This option toggles the rendering
|
: :octicons-milestone-24: Default: `false` · This option toggles the rendering
|
||||||
style of checkboxes, replacing native checkbox styles with beautiful icons,
|
style of checkboxes, replacing native checkbox styles with beautiful icons,
|
||||||
@ -704,7 +704,7 @@ The following configuration options are supported:
|
|||||||
custom_checkbox: true
|
custom_checkbox: true
|
||||||
```
|
```
|
||||||
|
|
||||||
`clickable_checkbox`{ #tasklist-clickable-checkbox }
|
[`clickable_checkbox`](#+pymdownx.tasklist.clickable_checkbox){ #+pymdownx.tasklist:clickable_checkbox }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: `false` · This option toggles whether
|
: :octicons-milestone-24: Default: `false` · This option toggles whether
|
||||||
checkboxes are clickable. As the state is not persisted, the use of this
|
checkboxes are clickable. As the state is not persisted, the use of this
|
||||||
|
@ -196,7 +196,7 @@ markdown_extensions:
|
|||||||
|
|
||||||
The following configuration options are supported:
|
The following configuration options are supported:
|
||||||
|
|
||||||
`title`{ #toc-title }
|
[`title`](#+toc.title){ #+toc.title }
|
||||||
|
|
||||||
: [:octicons-tag-24: 7.3.5][title support] ·
|
: [:octicons-tag-24: 7.3.5][title support] ·
|
||||||
:octicons-milestone-24: Default: _automatically set_ – This option sets the
|
:octicons-milestone-24: Default: _automatically set_ – This option sets the
|
||||||
@ -210,7 +210,7 @@ The following configuration options are supported:
|
|||||||
title: On this page
|
title: On this page
|
||||||
```
|
```
|
||||||
|
|
||||||
`permalink`{ #toc-permalink }
|
[`permalink`](#+toc.permalink){ #+toc.permalink }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: `false` – This option adds an anchor link
|
: :octicons-milestone-24: Default: `false` – This option adds an anchor link
|
||||||
containing the paragraph symbol `¶` or another custom symbol at the end of
|
containing the paragraph symbol `¶` or another custom symbol at the end of
|
||||||
@ -233,7 +233,7 @@ The following configuration options are supported:
|
|||||||
permalink: ⚓︎
|
permalink: ⚓︎
|
||||||
```
|
```
|
||||||
|
|
||||||
`permalink_title`{ #toc-permalink-title }
|
[`permalink_title`](#+toc.permalink_title){ #+toc.permalink_title }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: `Permanent link` – This option sets the
|
: :octicons-milestone-24: Default: `Permanent link` – This option sets the
|
||||||
title of the anchor link which is shown on hover and read by screen readers.
|
title of the anchor link which is shown on hover and read by screen readers.
|
||||||
@ -246,7 +246,7 @@ The following configuration options are supported:
|
|||||||
permalink_title: Anchor link to this section for reference
|
permalink_title: Anchor link to this section for reference
|
||||||
```
|
```
|
||||||
|
|
||||||
`slugify`{ #toc-slugify }
|
[`slugify`](#+toc.slugify){ #+toc.slugify }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: `headerid.slugify` – This option allows for
|
: :octicons-milestone-24: Default: `headerid.slugify` – This option allows for
|
||||||
customization of the slug function. For some languages, the default may not
|
customization of the slug function. For some languages, the default may not
|
||||||
@ -269,7 +269,7 @@ The following configuration options are supported:
|
|||||||
slugify: !!python/name:pymdownx.slugs.uslugify_cased
|
slugify: !!python/name:pymdownx.slugs.uslugify_cased
|
||||||
```
|
```
|
||||||
|
|
||||||
`toc_depth`{ #toc-depth }
|
[`toc_depth`](#+toc.toc_depth){ #+toc.toc_depth }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: `6` – Define the range of levels to be
|
: :octicons-milestone-24: Default: `6` – Define the range of levels to be
|
||||||
included in the table of contents. This may be useful for project
|
included in the table of contents. This may be useful for project
|
||||||
|
1219
docs/setup/setting-up-a-blog.md
Normal file
@ -6,19 +6,18 @@ template: overrides/main.html
|
|||||||
|
|
||||||
A clear and concise navigation structure is an important aspect of good project
|
A clear and concise navigation structure is an important aspect of good project
|
||||||
documentation. Material for MkDocs provides a multitude of options to configure
|
documentation. Material for MkDocs provides a multitude of options to configure
|
||||||
the behavior of navigational elements, including [tabs][navigation.tabs] and
|
the behavior of navigational elements, including [tabs] and [sections], and one
|
||||||
[sections][navigation.sections], and its flag-ship feature: [instant loading]
|
of its flag-ship feature: [instant loading].
|
||||||
[navigation.instant].
|
|
||||||
|
|
||||||
[navigation.tabs]: #navigation-tabs
|
[tabs]: #navigation-tabs
|
||||||
[navigation.sections]: #navigation-sections
|
[sections]: #navigation-sections
|
||||||
[navigation.instant]: #instant-loading
|
[instant loading]: #instant-loading
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
### Instant loading
|
### Instant loading
|
||||||
|
|
||||||
[:octicons-tag-24: 5.0.0][navigation.instant support] ·
|
[:octicons-tag-24: 5.0.0][Instant loading support] ·
|
||||||
:octicons-unlock-24: Feature flag
|
:octicons-unlock-24: Feature flag
|
||||||
|
|
||||||
When instant loading is enabled, clicks on all internal links will be
|
When instant loading is enabled, clicks on all internal links will be
|
||||||
@ -36,7 +35,7 @@ are rebound automatically, i.e., __Material for MkDocs now behaves like a Single
|
|||||||
Page Application__. Now, the search index survives navigation, which is
|
Page Application__. Now, the search index survives navigation, which is
|
||||||
especially useful for large documentation sites.
|
especially useful for large documentation sites.
|
||||||
|
|
||||||
[navigation.instant support]: https://github.com/squidfunk/mkdocs-material/releases/tag/5.2.0
|
[Instant loading support]: https://github.com/squidfunk/mkdocs-material/releases/tag/5.2.0
|
||||||
[XHR]: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest
|
[XHR]: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest
|
||||||
|
|
||||||
### Anchor tracking
|
### Anchor tracking
|
||||||
@ -59,7 +58,7 @@ theme:
|
|||||||
|
|
||||||
### Navigation tabs
|
### Navigation tabs
|
||||||
|
|
||||||
[:octicons-tag-24: 1.1.0][navigation.tabs support] ·
|
[:octicons-tag-24: 1.1.0][Navigation tabs support] ·
|
||||||
:octicons-unlock-24: Feature flag
|
:octicons-unlock-24: Feature flag
|
||||||
|
|
||||||
When tabs are enabled, top-level sections are rendered in a menu layer below
|
When tabs are enabled, top-level sections are rendered in a menu layer below
|
||||||
@ -81,21 +80,21 @@ theme:
|
|||||||
- navigation.tabs
|
- navigation.tabs
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-check-circle-fill-16: Enabled"
|
=== "With tabs"
|
||||||
|
|
||||||
[![navigation.tabs enabled]][navigation.tabs enabled]
|
[![Navigation tabs enabled]][Navigation tabs enabled]
|
||||||
|
|
||||||
=== ":octicons-skip-16: Disabled"
|
=== "Without"
|
||||||
|
|
||||||
[![navigation.tabs disabled]][navigation.tabs disabled]
|
[![Navigation tabs disabled]][Navigation tabs disabled]
|
||||||
|
|
||||||
[navigation.tabs support]: https://github.com/squidfunk/mkdocs-material/releases/tag/1.1.0
|
[Navigation tabs support]: https://github.com/squidfunk/mkdocs-material/releases/tag/1.1.0
|
||||||
[navigation.tabs enabled]: ../assets/screenshots/navigation-tabs.png
|
[Navigation tabs enabled]: ../assets/screenshots/navigation-tabs.png
|
||||||
[navigation.tabs disabled]: ../assets/screenshots/navigation.png
|
[Navigation tabs disabled]: ../assets/screenshots/navigation.png
|
||||||
|
|
||||||
#### Sticky navigation tabs
|
#### Sticky navigation tabs
|
||||||
|
|
||||||
[:octicons-tag-24: 7.3.0][navigation.tabs.sticky support] ·
|
[:octicons-tag-24: 7.3.0][Sticky navigation tabs support] ·
|
||||||
:octicons-unlock-24: Feature flag
|
:octicons-unlock-24: Feature flag
|
||||||
|
|
||||||
When sticky tabs are enabled, navigation tabs will lock below the header and
|
When sticky tabs are enabled, navigation tabs will lock below the header and
|
||||||
@ -109,21 +108,21 @@ theme:
|
|||||||
- navigation.tabs.sticky
|
- navigation.tabs.sticky
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-check-circle-fill-16: Enabled"
|
=== "With sticky tabs"
|
||||||
|
|
||||||
[![navigation.tabs.sticky enabled]][navigation.tabs.sticky enabled]
|
[![Sticky navigation tabs enabled]][Sticky navigation tabs enabled]
|
||||||
|
|
||||||
=== ":octicons-skip-16: Disabled"
|
=== "Without"
|
||||||
|
|
||||||
[![navigation.tabs.sticky disabled]][navigation.tabs.sticky disabled]
|
[![Sticky navigation tabs disabled]][Sticky navigation tabs disabled]
|
||||||
|
|
||||||
[navigation.tabs.sticky support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.3.0
|
[Sticky navigation tabs support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.3.0
|
||||||
[navigation.tabs.sticky enabled]: ../assets/screenshots/navigation-tabs-sticky.png
|
[Sticky navigation tabs enabled]: ../assets/screenshots/navigation-tabs-sticky.png
|
||||||
[navigation.tabs.sticky disabled]: ../assets/screenshots/navigation-tabs-collapsed.png
|
[Sticky navigation tabs disabled]: ../assets/screenshots/navigation-tabs-collapsed.png
|
||||||
|
|
||||||
### Navigation sections
|
### Navigation sections
|
||||||
|
|
||||||
[:octicons-tag-24: 6.2.0][navigation.sections support] ·
|
[:octicons-tag-24: 6.2.0][Navigation sections support] ·
|
||||||
:octicons-unlock-24: Feature flag
|
:octicons-unlock-24: Feature flag
|
||||||
|
|
||||||
When sections are enabled, top-level sections are rendered as groups in the
|
When sections are enabled, top-level sections are rendered as groups in the
|
||||||
@ -136,26 +135,25 @@ theme:
|
|||||||
- navigation.sections
|
- navigation.sections
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-check-circle-fill-16: Enabled"
|
=== "With sections"
|
||||||
|
|
||||||
[![navigation.sections enabled]][navigation.sections enabled]
|
[![Navigation sections enabled]][Navigation sections enabled]
|
||||||
|
|
||||||
=== ":octicons-skip-16: Disabled"
|
=== "Without"
|
||||||
|
|
||||||
[![navigation.sections disabled]][navigation.sections disabled]
|
[![Navigation sections disabled]][Navigation sections disabled]
|
||||||
|
|
||||||
[navigation.sections support]: https://github.com/squidfunk/mkdocs-material/releases/tag/6.2.0
|
[Navigation sections support]: https://github.com/squidfunk/mkdocs-material/releases/tag/6.2.0
|
||||||
[navigation.sections enabled]: ../assets/screenshots/navigation-sections.png
|
[Navigation sections enabled]: ../assets/screenshots/navigation-sections.png
|
||||||
[navigation.sections disabled]: ../assets/screenshots/navigation.png
|
[Navigation sections disabled]: ../assets/screenshots/navigation.png
|
||||||
|
|
||||||
Both feature flags, [`navigation.tabs`][navigation.tabs] and
|
Both feature flags, [`navigation.tabs`][tabs] and
|
||||||
[`navigation.sections`][navigation.sections], can be combined with each other.
|
[`navigation.sections`][sections], can be combined with each other. If both
|
||||||
If both feature flags are enabled, sections are rendered for level 2 navigation
|
feature flags are enabled, sections are rendered for level 2 navigation items.
|
||||||
items.
|
|
||||||
|
|
||||||
### Navigation expansion
|
### Navigation expansion
|
||||||
|
|
||||||
[:octicons-tag-24: 6.2.0][navigation.expand support] ·
|
[:octicons-tag-24: 6.2.0][Navigation expansion support] ·
|
||||||
:octicons-unlock-24: Feature flag
|
:octicons-unlock-24: Feature flag
|
||||||
|
|
||||||
When expansion is enabled, the left sidebar will expand all collapsible
|
When expansion is enabled, the left sidebar will expand all collapsible
|
||||||
@ -168,17 +166,17 @@ theme:
|
|||||||
- navigation.expand
|
- navigation.expand
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-check-circle-fill-16: Enabled"
|
=== "With expansion"
|
||||||
|
|
||||||
[![navigation.expand enabled]][navigation.expand enabled]
|
[![Navigation expansion enabled]][Navigation expansion enabled]
|
||||||
|
|
||||||
=== ":octicons-skip-16: Disabled"
|
=== "Without"
|
||||||
|
|
||||||
[![navigation.expand disabled]][navigation.expand disabled]
|
[![Navigation expansion disabled]][Navigation expansion disabled]
|
||||||
|
|
||||||
[navigation.expand support]: https://github.com/squidfunk/mkdocs-material/releases/tag/6.2.0
|
[Navigation expansion support]: https://github.com/squidfunk/mkdocs-material/releases/tag/6.2.0
|
||||||
[navigation.expand enabled]: ../assets/screenshots/navigation-expand.png
|
[Navigation expansion enabled]: ../assets/screenshots/navigation-expand.png
|
||||||
[navigation.expand disabled]: ../assets/screenshots/navigation.png
|
[Navigation expansion disabled]: ../assets/screenshots/navigation.png
|
||||||
|
|
||||||
### Navigation pruning
|
### Navigation pruning
|
||||||
|
|
||||||
@ -205,11 +203,12 @@ This feature flag is especially useful for documentation sites with 100+ or even
|
|||||||
Navigation pruning will replace all expandable sections with links to the first
|
Navigation pruning will replace all expandable sections with links to the first
|
||||||
page in that section (or the section index page).
|
page in that section (or the section index page).
|
||||||
|
|
||||||
|
[Insiders]: ../insiders/index.md
|
||||||
[navigation.expand]: #navigation-expansion
|
[navigation.expand]: #navigation-expansion
|
||||||
|
|
||||||
### Section index pages
|
### Section index pages
|
||||||
|
|
||||||
[:octicons-tag-24: 7.3.0][navigation.indexes support] ·
|
[:octicons-tag-24: 7.3.0][Section index pages support] ·
|
||||||
:octicons-unlock-24: Feature flag
|
:octicons-unlock-24: Feature flag
|
||||||
|
|
||||||
When section index pages are enabled, documents can be directly attached to
|
When section index pages are enabled, documents can be directly attached to
|
||||||
@ -225,13 +224,13 @@ theme:
|
|||||||
1. This feature flag is not compatible with [`toc.integrate`][toc.integrate],
|
1. This feature flag is not compatible with [`toc.integrate`][toc.integrate],
|
||||||
as sections cannot host the table of contents due to missing space.
|
as sections cannot host the table of contents due to missing space.
|
||||||
|
|
||||||
=== ":octicons-check-circle-fill-16: Enabled"
|
=== "With section index pages"
|
||||||
|
|
||||||
[![navigation.indexes enabled]][navigation.indexes enabled]
|
[![Section index pages enabled]][Section index pages enabled]
|
||||||
|
|
||||||
=== ":octicons-skip-16: Disabled"
|
=== "Without"
|
||||||
|
|
||||||
[![navigation.indexes disabled]][navigation.indexes disabled]
|
[![Section index pages disabled]][Section index pages disabled]
|
||||||
|
|
||||||
In order to link a page to a section, create a new document with the name
|
In order to link a page to a section, create a new document with the name
|
||||||
`index.md` in the respective folder, and add it to the beginning of your
|
`index.md` in the respective folder, and add it to the beginning of your
|
||||||
@ -246,17 +245,16 @@ nav:
|
|||||||
- Page n: section/page-n.md
|
- Page n: section/page-n.md
|
||||||
```
|
```
|
||||||
|
|
||||||
[navigation.indexes support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.3.0
|
[Section index pages support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.3.0
|
||||||
[navigation.indexes enabled]: ../assets/screenshots/navigation-index-on.png
|
[Section index pages enabled]: ../assets/screenshots/navigation-index-on.png
|
||||||
[navigation.indexes disabled]: ../assets/screenshots/navigation-index-off.png
|
[Section index pages disabled]: ../assets/screenshots/navigation-index-off.png
|
||||||
[toc.integrate]: #navigation-integration
|
[toc.integrate]: #navigation-integration
|
||||||
|
|
||||||
### Table of contents
|
### Table of contents
|
||||||
|
|
||||||
#### Anchor following
|
#### Anchor following
|
||||||
|
|
||||||
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
|
[:octicons-tag-24: 8.5.0][Anchor following support] ·
|
||||||
[:octicons-tag-24: insiders-4.8.0][Insiders] ·
|
|
||||||
:octicons-beaker-24: Experimental
|
:octicons-beaker-24: Experimental
|
||||||
|
|
||||||
When anchor following for the [table of contents] is enabled, the sidebar is
|
When anchor following for the [table of contents] is enabled, the sidebar is
|
||||||
@ -269,11 +267,11 @@ theme:
|
|||||||
- toc.follow
|
- toc.follow
|
||||||
```
|
```
|
||||||
|
|
||||||
[Insiders]: ../insiders/index.md
|
[Anchor following support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.5.0
|
||||||
|
|
||||||
#### Navigation integration
|
#### Navigation integration
|
||||||
|
|
||||||
[:octicons-tag-24: 6.2.0][toc.integrate support] ·
|
[:octicons-tag-24: 6.2.0][Navigation integration support] ·
|
||||||
:octicons-unlock-24: Feature flag
|
:octicons-unlock-24: Feature flag
|
||||||
|
|
||||||
When navigation integration for the [table of contents] is enabled, it is always
|
When navigation integration for the [table of contents] is enabled, it is always
|
||||||
@ -290,23 +288,23 @@ theme:
|
|||||||
[`navigation.indexes`][navigation.indexes], as sections cannot host the
|
[`navigation.indexes`][navigation.indexes], as sections cannot host the
|
||||||
table of contents due to missing space.
|
table of contents due to missing space.
|
||||||
|
|
||||||
=== ":octicons-check-circle-fill-16: Enabled"
|
=== "With navigation integration"
|
||||||
|
|
||||||
[![toc.integrate enabled]][toc.integrate enabled]
|
[![Navigation integration enabled]][Navigation integration enabled]
|
||||||
|
|
||||||
=== ":octicons-skip-16: Disabled"
|
=== "Without"
|
||||||
|
|
||||||
[![toc.integrate disabled]][toc.integrate disabled]
|
[![Navigation integration disabled]][Navigation integration disabled]
|
||||||
|
|
||||||
[table of contents]: extensions/python-markdown.md#table-of-contents
|
[table of contents]: extensions/python-markdown.md#table-of-contents
|
||||||
[toc.integrate support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.3.0
|
[Navigation integration support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.3.0
|
||||||
[toc.integrate enabled]: ../assets/screenshots/toc-integrate.png
|
[Navigation integration enabled]: ../assets/screenshots/toc-integrate.png
|
||||||
[toc.integrate disabled]: ../assets/screenshots/navigation-tabs.png
|
[Navigation integration disabled]: ../assets/screenshots/navigation-tabs.png
|
||||||
[navigation.indexes]: #section-index-pages
|
[navigation.indexes]: #section-index-pages
|
||||||
|
|
||||||
### Back-to-top button
|
### Back-to-top button
|
||||||
|
|
||||||
[:octicons-tag-24: 7.1.0][navigation.top support] ·
|
[:octicons-tag-24: 7.1.0][Back-to-top button support] ·
|
||||||
:octicons-unlock-24: Feature flag
|
:octicons-unlock-24: Feature flag
|
||||||
|
|
||||||
A back-to-top button can be shown when the user, after scrolling down, starts
|
A back-to-top button can be shown when the user, after scrolling down, starts
|
||||||
@ -319,7 +317,7 @@ theme:
|
|||||||
- navigation.top
|
- navigation.top
|
||||||
```
|
```
|
||||||
|
|
||||||
[navigation.top support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.1.0
|
[Back-to-top button support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.1.0
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
@ -329,7 +327,7 @@ The navigation and/or table of contents sidebars can be hidden for a document
|
|||||||
with the front matter `hide` property. Add the following lines at the top of a
|
with the front matter `hide` property. Add the following lines at the top of a
|
||||||
Markdown file:
|
Markdown file:
|
||||||
|
|
||||||
``` sh
|
``` yaml
|
||||||
---
|
---
|
||||||
hide:
|
hide:
|
||||||
- navigation
|
- navigation
|
||||||
@ -342,19 +340,19 @@ hide:
|
|||||||
|
|
||||||
=== "Hide navigation"
|
=== "Hide navigation"
|
||||||
|
|
||||||
[![hide.navigation enabled]][hide.navigation enabled]
|
[![Hide navigation enabled]][Hide navigation enabled]
|
||||||
|
|
||||||
=== "Hide table of contents"
|
=== "Hide table of contents"
|
||||||
|
|
||||||
[![hide.toc enabled]][hide.toc enabled]
|
[![Hide table of contents enabled]][Hide table of contents enabled]
|
||||||
|
|
||||||
=== "Hide both"
|
=== "Hide both"
|
||||||
|
|
||||||
[![hide.* enabled]][hide.* enabled]
|
[![Hide both enabled]][Hide both enabled]
|
||||||
|
|
||||||
[hide.navigation enabled]: ../assets/screenshots/hide-navigation.png
|
[Hide navigation enabled]: ../assets/screenshots/hide-navigation.png
|
||||||
[hide.toc enabled]: ../assets/screenshots/hide-toc.png
|
[Hide table of contents enabled]: ../assets/screenshots/hide-toc.png
|
||||||
[hide.* enabled]: ../assets/screenshots/hide-navigation-toc.png
|
[Hide both enabled]: ../assets/screenshots/hide-navigation-toc.png
|
||||||
|
|
||||||
## Customization
|
## Customization
|
||||||
|
|
||||||
@ -363,7 +361,7 @@ hide:
|
|||||||
Material for MkDocs includes several keyboard shortcuts that make it possible
|
Material for MkDocs includes several keyboard shortcuts that make it possible
|
||||||
to navigate your project documentation via keyboard. There are two modes:
|
to navigate your project documentation via keyboard. There are two modes:
|
||||||
|
|
||||||
`search`{ #mode-search }
|
[`search`](#mode:search){ #mode:search }
|
||||||
|
|
||||||
: This mode is active when the _search is focused_. It provides several key
|
: This mode is active when the _search is focused_. It provides several key
|
||||||
bindings to make search accessible and navigable via keyboard:
|
bindings to make search accessible and navigable via keyboard:
|
||||||
@ -372,7 +370,7 @@ to navigate your project documentation via keyboard. There are two modes:
|
|||||||
* ++esc++ , ++tab++ : close search dialog
|
* ++esc++ , ++tab++ : close search dialog
|
||||||
* ++enter++ : follow selected result
|
* ++enter++ : follow selected result
|
||||||
|
|
||||||
`global`{ #mode-global }
|
[`global`](#mode:global){ #mode:global }
|
||||||
|
|
||||||
: This mode is active when _search is not focussed_ and when there's no other
|
: This mode is active when _search is not focussed_ and when there's no other
|
||||||
focussed element that is susceptible to keyboard input. The following keys
|
focussed element that is susceptible to keyboard input. The following keys
|
||||||
@ -386,7 +384,7 @@ Let's say you want to bind some action to the ++x++ key. By using [additional
|
|||||||
JavaScript], you can subscribe to the `keyboard$` observable and attach
|
JavaScript], you can subscribe to the `keyboard$` observable and attach
|
||||||
your custom event listener:
|
your custom event listener:
|
||||||
|
|
||||||
=== ":octicons-file-code-16: docs/javascripts/shortcuts.js"
|
=== ":octicons-file-code-16: `docs/javascripts/shortcuts.js`"
|
||||||
|
|
||||||
``` js
|
``` js
|
||||||
keyboard$.subscribe(function(key) {
|
keyboard$.subscribe(function(key) {
|
||||||
@ -401,7 +399,7 @@ your custom event listener:
|
|||||||
underlying event, so the keypress will not propagate further and
|
underlying event, so the keypress will not propagate further and
|
||||||
touch other event listeners.
|
touch other event listeners.
|
||||||
|
|
||||||
=== ":octicons-file-code-16: mkdocs.yml"
|
=== ":octicons-file-code-16: `mkdocs.yml`"
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
extra_javascript:
|
extra_javascript:
|
||||||
@ -421,7 +419,7 @@ stretch to the entire available space.
|
|||||||
This can easily be achieved with an [additional style sheet] and a few lines
|
This can easily be achieved with an [additional style sheet] and a few lines
|
||||||
of CSS:
|
of CSS:
|
||||||
|
|
||||||
=== ":octicons-file-code-16: docs/stylesheets/extra.css"
|
=== ":octicons-file-code-16: `docs/stylesheets/extra.css`"
|
||||||
|
|
||||||
``` css
|
``` css
|
||||||
.md-grid {
|
.md-grid {
|
||||||
@ -438,7 +436,7 @@ of CSS:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: mkdocs.yml"
|
=== ":octicons-file-code-16: `mkdocs.yml`"
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
extra_css:
|
extra_css:
|
||||||
|
@ -10,7 +10,7 @@ MkDocs natively integrates with [Google Analytics] and offers a customizable
|
|||||||
[cookie consent] and a [feedback widget].
|
[cookie consent] and a [feedback widget].
|
||||||
|
|
||||||
[Google Analytics]: https://developers.google.com/analytics
|
[Google Analytics]: https://developers.google.com/analytics
|
||||||
[cookie consent]: ensuring-data-privacy.md#native-cookie-consent
|
[cookie consent]: ensuring-data-privacy.md#cookie-consent
|
||||||
[feedback widget]: #was-this-page-helpful
|
[feedback widget]: #was-this-page-helpful
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
@ -70,7 +70,7 @@ following lines to `mkdocs.yml`:
|
|||||||
|
|
||||||
### Was this page helpful?
|
### Was this page helpful?
|
||||||
|
|
||||||
[:octicons-tag-24: 8.4.0][feedback support] ·
|
[:octicons-tag-24: 8.4.0][Was this page helpful? support] ·
|
||||||
:octicons-milestone-24: Default: _none_ ·
|
:octicons-milestone-24: Default: _none_ ·
|
||||||
:octicons-beaker-24: Experimental
|
:octicons-beaker-24: Experimental
|
||||||
|
|
||||||
@ -169,9 +169,9 @@ integrated with the [cookie consent] feature[^1].
|
|||||||
|
|
||||||
The following properties are available for each rating:
|
The following properties are available for each rating:
|
||||||
|
|
||||||
`icon`{ #feedback-rating-icon }
|
[`icon`](#+analytics.feedback.ratings.icon){ #+analytics.feedback.ratings.icon }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: Required –
|
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: __Required__ –
|
||||||
This property must point to a valid icon path referencing [any icon bundled
|
This property must point to a valid icon path referencing [any icon bundled
|
||||||
with the theme][custom icons], or the build will not succeed. Some popular
|
with the theme][custom icons], or the build will not succeed. Some popular
|
||||||
combinations:
|
combinations:
|
||||||
@ -180,24 +180,24 @@ The following properties are available for each rating:
|
|||||||
* :material-thumb-up-outline: + :material-thumb-down-outline: – `material/thumb-up-outline` + `material/thumb-down-outline`
|
* :material-thumb-up-outline: + :material-thumb-down-outline: – `material/thumb-up-outline` + `material/thumb-down-outline`
|
||||||
* :material-heart: + :material-heart-broken: – `material/heart` + `material/heart-broken`
|
* :material-heart: + :material-heart-broken: – `material/heart` + `material/heart-broken`
|
||||||
|
|
||||||
`name`{ #feedback-rating-name }
|
[`name`](#+analytics.feedback.ratings.name){ #+analytics.feedback.ratings.name }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: Required –
|
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: __Required__ –
|
||||||
The value of this property is shown on user interaction (i.e. keyboard focus
|
The value of this property is shown on user interaction (i.e. keyboard focus
|
||||||
or mouse hover), explaining the meaning of the rating behind the icon.
|
or mouse hover), explaining the meaning of the rating behind the icon.
|
||||||
|
|
||||||
`data`{ #feedback-rating-data }
|
[`data`](#+analytics.feedback.ratings.data){ #+analytics.feedback.ratings.data }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: Required –
|
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: __Required__ –
|
||||||
The value of this property is sent as a data value with the custom event
|
The value of this property is sent as a data value with the custom event
|
||||||
that is transmitted to Google Analytics[^2] (or any custom integration).
|
that is transmitted to Google Analytics[^2] (or any custom integration).
|
||||||
|
|
||||||
[^2]:
|
[^2]:
|
||||||
Note that for Google Analytics, the data value must be an integer.
|
Note that for Google Analytics, the data value must be an integer.
|
||||||
|
|
||||||
`note`{ #feedback-rating-note }
|
[`note`](#+analytics.feedback.ratings.note){ #+analytics.feedback.ratings.note }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: Required –
|
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: __Required__ –
|
||||||
The value of this property is shown after the user selected the rating.
|
The value of this property is shown after the user selected the rating.
|
||||||
It may contain arbitrary HTML tags, which is especially useful to ask the
|
It may contain arbitrary HTML tags, which is especially useful to ask the
|
||||||
user to provide more detailed feedback for the current page through a form.
|
user to provide more detailed feedback for the current page through a form.
|
||||||
@ -221,7 +221,7 @@ The following properties are available for each rating:
|
|||||||
|
|
||||||
An alternative to GitHub issues is [Google Forms].
|
An alternative to GitHub issues is [Google Forms].
|
||||||
|
|
||||||
[feedback support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.4.0
|
[Was this page helpful? support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.4.0
|
||||||
[feedback widget]: #feedback
|
[feedback widget]: #feedback
|
||||||
[analytics]: #google-analytics
|
[analytics]: #google-analytics
|
||||||
[feedback report]: ../assets/screenshots/feedback-report.png
|
[feedback report]: ../assets/screenshots/feedback-report.png
|
||||||
@ -235,7 +235,7 @@ The following properties are available for each rating:
|
|||||||
|
|
||||||
The [feedback widget] can be hidden for a document with the front matter `hide` property. Add the following lines at the top of a Markdown file:
|
The [feedback widget] can be hidden for a document with the front matter `hide` property. Add the following lines at the top of a Markdown file:
|
||||||
|
|
||||||
``` sh
|
``` yaml
|
||||||
---
|
---
|
||||||
hide:
|
hide:
|
||||||
- feedback
|
- feedback
|
||||||
@ -254,7 +254,7 @@ JavaScript-based tracking solution, just follow the guide on [theme extension]
|
|||||||
and create a new partial in the `overrides` folder. The name of the partial is
|
and create a new partial in the `overrides` folder. The name of the partial is
|
||||||
used to configure the custom integration via `mkdocs.yml`:
|
used to configure the custom integration via `mkdocs.yml`:
|
||||||
|
|
||||||
=== ":octicons-file-code-16: overrides/partials/integrations/analytics/custom.html"
|
=== ":octicons-file-code-16: `overrides/partials/integrations/analytics/custom.html`"
|
||||||
|
|
||||||
``` html
|
``` html
|
||||||
<script>
|
<script>
|
||||||
@ -276,7 +276,7 @@ used to configure the custom integration via `mkdocs.yml`:
|
|||||||
observable to listen for navigation events, which always emits the
|
observable to listen for navigation events, which always emits the
|
||||||
current `URL`.
|
current `URL`.
|
||||||
|
|
||||||
=== ":octicons-file-code-16: mkdocs.yml"
|
=== ":octicons-file-code-16: `mkdocs.yml`"
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
extra:
|
extra:
|
||||||
@ -298,7 +298,7 @@ A custom feedback widget integration just needs to process the events that are
|
|||||||
generated by users interacting with the feedback widget with the help of some
|
generated by users interacting with the feedback widget with the help of some
|
||||||
[additional JavaScript]:
|
[additional JavaScript]:
|
||||||
|
|
||||||
=== ":octicons-file-code-16: docs/javascripts/feedback.js"
|
=== ":octicons-file-code-16: `docs/javascripts/feedback.js`"
|
||||||
|
|
||||||
``` js
|
``` js
|
||||||
var feedback = document.forms.feedback
|
var feedback = document.forms.feedback
|
||||||
@ -314,7 +314,7 @@ generated by users interacting with the feedback widget with the help of some
|
|||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: mkdocs.yml"
|
=== ":octicons-file-code-16: `mkdocs.yml`"
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
extra_javascript:
|
extra_javascript:
|
||||||
|
@ -17,7 +17,7 @@ not be compliant with privacy regulations. Moreover, search even works
|
|||||||
|
|
||||||
### Built-in search plugin
|
### Built-in search plugin
|
||||||
|
|
||||||
[:octicons-tag-24: 0.1.0][search support] ·
|
[:octicons-tag-24: 0.1.0][Search support] ·
|
||||||
:octicons-cpu-24: Plugin
|
:octicons-cpu-24: Plugin
|
||||||
|
|
||||||
The built-in search plugin integrates seamlessly with Material for MkDocs,
|
The built-in search plugin integrates seamlessly with Material for MkDocs,
|
||||||
@ -32,7 +32,7 @@ plugins:
|
|||||||
|
|
||||||
The following configuration options are supported:
|
The following configuration options are supported:
|
||||||
|
|
||||||
`lang`{ #search-lang }
|
[`lang`](#+search.lang){ #+search.lang }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: _automatically set_ – This option allows
|
: :octicons-milestone-24: Default: _automatically set_ – This option allows
|
||||||
to include the language-specific stemmers provided by [lunr-languages].
|
to include the language-specific stemmers provided by [lunr-languages].
|
||||||
@ -92,7 +92,7 @@ The following configuration options are supported:
|
|||||||
part of this list by automatically falling back to the stemmer yielding the
|
part of this list by automatically falling back to the stemmer yielding the
|
||||||
best result.
|
best result.
|
||||||
|
|
||||||
`separator`{ #search-separator }
|
[`separator`](#+search.separator){ #+search.separator }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: _automatically set_ – The separator for
|
: :octicons-milestone-24: Default: _automatically set_ – The separator for
|
||||||
indexing and query tokenization can be customized, making it possible to
|
indexing and query tokenization can be customized, making it possible to
|
||||||
@ -112,7 +112,7 @@ The following configuration options are supported:
|
|||||||
|
|
||||||
<div class="mdx-deprecated" markdown>
|
<div class="mdx-deprecated" markdown>
|
||||||
|
|
||||||
`prebuild_index`{ #search-prebuild-index }
|
[`prebuild_index`](#+search.prebuild_index){ #+search.prebuild_index }
|
||||||
|
|
||||||
: [:octicons-tag-24: 5.0.0][prebuilt index support] · :octicons-archive-24:
|
: [:octicons-tag-24: 5.0.0][prebuilt index support] · :octicons-archive-24:
|
||||||
Deprecated · :octicons-trash-24: 8.0.0 · :octicons-milestone-24: Default:
|
Deprecated · :octicons-trash-24: 8.0.0 · :octicons-milestone-24: Default:
|
||||||
@ -135,7 +135,7 @@ The following configuration options are supported:
|
|||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
[search support]: https://github.com/squidfunk/mkdocs-material/releases/tag/0.1.0
|
[Search support]: https://github.com/squidfunk/mkdocs-material/releases/tag/0.1.0
|
||||||
[lunr]: https://lunrjs.com
|
[lunr]: https://lunrjs.com
|
||||||
[lunr-languages]: https://github.com/MihaiValentin/lunr-languages
|
[lunr-languages]: https://github.com/MihaiValentin/lunr-languages
|
||||||
[lunr's default tokenizer]: https://github.com/olivernn/lunr.js/blob/aa5a878f62a6bba1e8e5b95714899e17e8150b38/lunr.js#L413-L456
|
[lunr's default tokenizer]: https://github.com/olivernn/lunr.js/blob/aa5a878f62a6bba1e8e5b95714899e17e8150b38/lunr.js#L413-L456
|
||||||
@ -143,7 +143,7 @@ The following configuration options are supported:
|
|||||||
[tokenizer lookahead]: #tokenizer-lookahead
|
[tokenizer lookahead]: #tokenizer-lookahead
|
||||||
[prebuilt index support]: https://github.com/squidfunk/mkdocs-material/releases/tag/5.0.0
|
[prebuilt index support]: https://github.com/squidfunk/mkdocs-material/releases/tag/5.0.0
|
||||||
[prebuilt index]: https://www.mkdocs.org/user-guide/configuration/#prebuild_index
|
[prebuilt index]: https://www.mkdocs.org/user-guide/configuration/#prebuild_index
|
||||||
[50% smaller]: ../blog/2021/search-better-faster-smaller.md#benchmarks
|
[50% smaller]: ../blog/posts/search-better-faster-smaller.md#benchmarks
|
||||||
|
|
||||||
#### Chinese language support
|
#### Chinese language support
|
||||||
|
|
||||||
@ -163,7 +163,7 @@ If [jieba] is installed, the [built-in search plugin] automatically detects
|
|||||||
Chinese characters and runs them through the segmenter. The following
|
Chinese characters and runs them through the segmenter. The following
|
||||||
configuration options are available:
|
configuration options are available:
|
||||||
|
|
||||||
`jieba_dict`{ #jieba-dict }
|
[`jieba_dict`](#+search.jieba_dict){ #+search.jieba_dict }
|
||||||
|
|
||||||
: [:octicons-tag-24: insiders-4.17.2][Insiders] · :octicons-milestone-24:
|
: [:octicons-tag-24: insiders-4.17.2][Insiders] · :octicons-milestone-24:
|
||||||
Default: _none_ – This option allows for specifying a [custom dictionary]
|
Default: _none_ – This option allows for specifying a [custom dictionary]
|
||||||
@ -180,7 +180,7 @@ configuration options are available:
|
|||||||
- [dict.txt.small] – 占用内存较小的词典文件
|
- [dict.txt.small] – 占用内存较小的词典文件
|
||||||
- [dict.txt.big] – 支持繁体分词更好的词典文件
|
- [dict.txt.big] – 支持繁体分词更好的词典文件
|
||||||
|
|
||||||
`jieba_dict_user`{ #jieba-dict-user }
|
[`jieba_dict_user`](#+search.jieba_dict_user){ #+search.jieba_dict_user }
|
||||||
|
|
||||||
: [:octicons-tag-24: insiders-4.17.2][Insiders] · :octicons-milestone-24:
|
: [:octicons-tag-24: insiders-4.17.2][Insiders] · :octicons-milestone-24:
|
||||||
Default: _none_ – This option allows for specifying an additional
|
Default: _none_ – This option allows for specifying an additional
|
||||||
@ -196,7 +196,7 @@ configuration options are available:
|
|||||||
User dictionaries can be used for tuning the segmenter to preserve
|
User dictionaries can be used for tuning the segmenter to preserve
|
||||||
technical terms.
|
technical terms.
|
||||||
|
|
||||||
[chinese search]: ../blog/2022/chinese-search-support.md
|
[chinese search]: ../blog/posts/chinese-search-support.md
|
||||||
[jieba]: https://pypi.org/project/jieba/
|
[jieba]: https://pypi.org/project/jieba/
|
||||||
[built-in search plugin]: #built-in-search-plugin
|
[built-in search plugin]: #built-in-search-plugin
|
||||||
[custom dictionary]: https://github.com/fxsjy/jieba#%E5%85%B6%E4%BB%96%E8%AF%8D%E5%85%B8
|
[custom dictionary]: https://github.com/fxsjy/jieba#%E5%85%B6%E4%BB%96%E8%AF%8D%E5%85%B8
|
||||||
@ -223,9 +223,9 @@ occurrences inside those blocks:
|
|||||||
![search preview before]
|
![search preview before]
|
||||||
|
|
||||||
[Insiders]: ../insiders/index.md
|
[Insiders]: ../insiders/index.md
|
||||||
[new search plugin]: ../blog/2021/search-better-faster-smaller.md
|
[new search plugin]: ../blog/posts/search-better-faster-smaller.md
|
||||||
[search preview now]: ../blog/2021/search-better-faster-smaller/search-preview-now.png
|
[search preview now]: ../blog/posts/search-better-faster-smaller/search-preview-now.png
|
||||||
[search preview before]: ../blog/2021/search-better-faster-smaller/search-preview-before.png
|
[search preview before]: ../blog/posts/search-better-faster-smaller/search-preview-before.png
|
||||||
|
|
||||||
### Tokenizer lookahead
|
### Tokenizer lookahead
|
||||||
|
|
||||||
@ -290,13 +290,13 @@ The following section explains what can be achieved with tokenizer lookahead:
|
|||||||
|
|
||||||
[separator]: #search-separator
|
[separator]: #search-separator
|
||||||
[words are split at case changes]: ?q=searchHighlight
|
[words are split at case changes]: ?q=searchHighlight
|
||||||
[tokenize case changes]: ../blog/2021/search-better-faster-smaller.md#case-changes
|
[tokenize case changes]: ../blog/posts/search-better-faster-smaller.md#case-changes
|
||||||
[tokenize version numbers]: ../blog/2021/search-better-faster-smaller.md#version-numbers
|
[tokenize version numbers]: ../blog/posts/search-better-faster-smaller.md#version-numbers
|
||||||
[tokenize html-xml tags]: ../blog/2021/search-better-faster-smaller.md#htmlxml-tags
|
[tokenize html-xml tags]: ../blog/posts/search-better-faster-smaller.md#htmlxml-tags
|
||||||
|
|
||||||
### Search suggestions
|
### Search suggestions
|
||||||
|
|
||||||
[:octicons-tag-24: 7.2.0][search.suggest support] ·
|
[:octicons-tag-24: 7.2.0][Search suggestions support] ·
|
||||||
:octicons-unlock-24: Feature flag ·
|
:octicons-unlock-24: Feature flag ·
|
||||||
:octicons-beaker-24: Experimental
|
:octicons-beaker-24: Experimental
|
||||||
|
|
||||||
@ -310,15 +310,15 @@ theme:
|
|||||||
- search.suggest
|
- search.suggest
|
||||||
```
|
```
|
||||||
|
|
||||||
Searching for [:octicons-search-24: search su][search.suggest example] yields
|
Searching for [:octicons-search-24: search su][Search suggestions example]
|
||||||
^^search suggestions^^ as a suggestion.
|
yields ^^search suggestions^^ as a suggestion.
|
||||||
|
|
||||||
[search.suggest support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.2.0
|
[Search suggestions support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.2.0
|
||||||
[search.suggest example]: ?q=search+su
|
[Search suggestions example]: ?q=search+su
|
||||||
|
|
||||||
### Search highlighting
|
### Search highlighting
|
||||||
|
|
||||||
[:octicons-tag-24: 7.2.0][search.highlight support] ·
|
[:octicons-tag-24: 7.2.0][Search highlighting support] ·
|
||||||
:octicons-unlock-24: Feature flag ·
|
:octicons-unlock-24: Feature flag ·
|
||||||
:octicons-beaker-24: Experimental
|
:octicons-beaker-24: Experimental
|
||||||
|
|
||||||
@ -332,15 +332,15 @@ theme:
|
|||||||
- search.highlight
|
- search.highlight
|
||||||
```
|
```
|
||||||
|
|
||||||
Searching for [:octicons-search-24: code blocks][search.highlight example]
|
Searching for [:octicons-search-24: code blocks][Search highlighting example]
|
||||||
highlights all occurrences of both terms.
|
highlights all occurrences of both terms.
|
||||||
|
|
||||||
[search.highlight support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.2.0
|
[Search highlighting support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.2.0
|
||||||
[search.highlight example]: ../reference/code-blocks.md?h=code+blocks
|
[Search highlighting example]: ../reference/code-blocks.md?h=code+blocks
|
||||||
|
|
||||||
### Search sharing
|
### Search sharing
|
||||||
|
|
||||||
[:octicons-tag-24: 7.2.0][search.share support] ·
|
[:octicons-tag-24: 7.2.0][Search sharing support] ·
|
||||||
:octicons-unlock-24: Feature flag ·
|
:octicons-unlock-24: Feature flag ·
|
||||||
:octicons-beaker-24: Experimental
|
:octicons-beaker-24: Experimental
|
||||||
|
|
||||||
@ -357,7 +357,7 @@ theme:
|
|||||||
When a user clicks the share button, the URL is automatically copied to the
|
When a user clicks the share button, the URL is automatically copied to the
|
||||||
clipboard.
|
clipboard.
|
||||||
|
|
||||||
[search.share support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.2.0
|
[Search sharing support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.2.0
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
@ -370,7 +370,7 @@ Pages can be boosted in search with the front matter `search.boost` property,
|
|||||||
which will make them rank higher. Add the following lines at the top of a
|
which will make them rank higher. Add the following lines at the top of a
|
||||||
Markdown file:
|
Markdown file:
|
||||||
|
|
||||||
``` sh
|
``` yaml
|
||||||
---
|
---
|
||||||
search:
|
search:
|
||||||
boost: 2 # (1)!
|
boost: 2 # (1)!
|
||||||
@ -395,7 +395,7 @@ Pages can be excluded from search with the front matter `search.exclude`
|
|||||||
property, removing them from the index. Add the following lines at the top of a
|
property, removing them from the index. Add the following lines at the top of a
|
||||||
Markdown file:
|
Markdown file:
|
||||||
|
|
||||||
``` sh
|
``` yaml
|
||||||
---
|
---
|
||||||
search:
|
search:
|
||||||
exclude: true
|
exclude: true
|
||||||
@ -411,7 +411,7 @@ When [Attribute Lists] is enabled, specific sections of pages can be excluded
|
|||||||
from search by adding the `{ data-search-exclude }` pragma after a Markdown
|
from search by adding the `{ data-search-exclude }` pragma after a Markdown
|
||||||
heading:
|
heading:
|
||||||
|
|
||||||
=== ":octicons-file-code-16: docs/page.md"
|
=== ":octicons-file-code-16: `docs/page.md`"
|
||||||
|
|
||||||
``` markdown
|
``` markdown
|
||||||
# Document title
|
# Document title
|
||||||
@ -425,7 +425,7 @@ heading:
|
|||||||
The content of this section is excluded
|
The content of this section is excluded
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-codescan-16: search_index.json"
|
=== ":octicons-codescan-16: `search_index.json`"
|
||||||
|
|
||||||
``` json
|
``` json
|
||||||
{
|
{
|
||||||
@ -453,7 +453,7 @@ When [Attribute Lists] is enabled, specific sections of pages can be excluded
|
|||||||
from search by adding the `{ data-search-exclude }` pragma after a Markdown
|
from search by adding the `{ data-search-exclude }` pragma after a Markdown
|
||||||
inline- or block-level element:
|
inline- or block-level element:
|
||||||
|
|
||||||
=== ":octicons-file-code-16: docs/page.md"
|
=== ":octicons-file-code-16: `docs/page.md`"
|
||||||
|
|
||||||
``` markdown
|
``` markdown
|
||||||
# Document title
|
# Document title
|
||||||
@ -464,7 +464,7 @@ inline- or block-level element:
|
|||||||
{ data-search-exclude }
|
{ data-search-exclude }
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-codescan-16: search_index.json"
|
=== ":octicons-codescan-16: `search_index.json`"
|
||||||
|
|
||||||
``` json
|
``` json
|
||||||
{
|
{
|
||||||
|
@ -6,8 +6,8 @@ template: overrides/main.html
|
|||||||
|
|
||||||
Social cards, also known as social previews, are images that are displayed when
|
Social cards, also known as social previews, are images that are displayed when
|
||||||
a link to your project documentation is shared on social media. Material for
|
a link to your project documentation is shared on social media. Material for
|
||||||
MkDocs can generate beautiful social cards automatically, using the [colors]
|
MkDocs can generate beautiful social cards automatically, using the [colors],
|
||||||
[palette.primary], [fonts][font.text] and [logo][^1] defined in `mkdocs.yml`,
|
[fonts] and [logo][^1] defined in `mkdocs.yml`,
|
||||||
e.g.:
|
e.g.:
|
||||||
|
|
||||||
<figure markdown>
|
<figure markdown>
|
||||||
@ -28,8 +28,8 @@ The social preview image for the page on [setting up site analytics].
|
|||||||
color used in the header (white or black), which depends on the primary
|
color used in the header (white or black), which depends on the primary
|
||||||
color.
|
color.
|
||||||
|
|
||||||
[palette.primary]: changing-the-colors.md#primary-color
|
[colors]: changing-the-colors.md#primary-color
|
||||||
[font.text]: changing-the-fonts.md#regular-font
|
[fonts]: changing-the-fonts.md#regular-font
|
||||||
[logo]: changing-the-logo-and-icons.md#logo
|
[logo]: changing-the-logo-and-icons.md#logo
|
||||||
[Social cards preview]: ../assets/screenshots/social-cards.png
|
[Social cards preview]: ../assets/screenshots/social-cards.png
|
||||||
[setting up site analytics]: setting-up-site-analytics.md
|
[setting up site analytics]: setting-up-site-analytics.md
|
||||||
@ -39,8 +39,7 @@ The social preview image for the page on [setting up site analytics].
|
|||||||
|
|
||||||
### Built-in social plugin
|
### Built-in social plugin
|
||||||
|
|
||||||
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
|
[:octicons-tag-24: 8.5.0][Social cards support] ·
|
||||||
[:octicons-tag-24: insiders-2.12.0][Insiders] ·
|
|
||||||
:octicons-cpu-24: Plugin ·
|
:octicons-cpu-24: Plugin ·
|
||||||
:octicons-beaker-24: Experimental
|
:octicons-beaker-24: Experimental
|
||||||
|
|
||||||
@ -53,13 +52,9 @@ plugins:
|
|||||||
- social
|
- social
|
||||||
```
|
```
|
||||||
|
|
||||||
> If you need to be able to build your documentation with and without
|
|
||||||
> [Insiders], please refer to the [built-in plugins] section to learn how
|
|
||||||
> shared configurations help to achieve this.
|
|
||||||
|
|
||||||
The following configuration options are available:
|
The following configuration options are available:
|
||||||
|
|
||||||
`cards`{ #cards }
|
[`cards`](#+social.cards){ #+social.cards }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: `true` – This option specifies whether
|
: :octicons-milestone-24: Default: `true` – This option specifies whether
|
||||||
to generate social card images. If you want to switch the plugin off, e.g.
|
to generate social card images. If you want to switch the plugin off, e.g.
|
||||||
@ -71,12 +66,11 @@ The following configuration options are available:
|
|||||||
cards: !ENV [CARDS, false]
|
cards: !ENV [CARDS, false]
|
||||||
```
|
```
|
||||||
|
|
||||||
`cards_color`{ #cards-color }
|
[`cards_color`](#+social.cards_color){ #+social.cards_color }
|
||||||
|
|
||||||
: [:octicons-tag-24: insiders-2.13.0][Insiders] · :octicons-milestone-24:
|
: :octicons-milestone-24: Default: [`theme.palette.primary`][palette.primary]
|
||||||
Default: [`theme.palette.primary`][palette.primary] – This option specifies
|
– This option specifies the colors for the background `fill` and foreground
|
||||||
the colors for the background `fill` and foreground `text` when generating
|
`text` when generating the social card:
|
||||||
the social card:
|
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
plugins:
|
plugins:
|
||||||
@ -89,12 +83,11 @@ The following configuration options are available:
|
|||||||
1. Colors can either be defined as HEX colors, or as [CSS color keywords].
|
1. Colors can either be defined as HEX colors, or as [CSS color keywords].
|
||||||
Note that HEX colors must be enclosed in quotes.
|
Note that HEX colors must be enclosed in quotes.
|
||||||
|
|
||||||
`cards_font`{ #cards-font }
|
[`cards_font`](#+social.cards_font){ #+social.cards_font }
|
||||||
|
|
||||||
: [:octicons-tag-24: insiders-4.3.0][Insiders] · :octicons-milestone-24:
|
: :octicons-milestone-24: Default: [`theme.font.text`][font.text] – This
|
||||||
Default: [`theme.font.text`][font.text] – This option specifies which font
|
option specifies which font to use for rendering the social card, which can
|
||||||
to use for rendering the social card, which can be any font hosted on
|
be any font hosted on [Google Fonts]:
|
||||||
[Google Fonts]:
|
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
plugins:
|
plugins:
|
||||||
@ -102,7 +95,47 @@ The following configuration options are available:
|
|||||||
cards_font: Roboto
|
cards_font: Roboto
|
||||||
```
|
```
|
||||||
|
|
||||||
`cards_dir`{ #cards-dir }
|
!!! question "Why do social cards render boxes for CJK languages?"
|
||||||
|
|
||||||
|
Some fonts do not contain CJK characters, like for example the
|
||||||
|
[default font, `Roboto`][font.text]. In case your `site_name`,
|
||||||
|
`site_description`, or [page title] contain CJK characters, choose
|
||||||
|
another font from [Google Fonts] which comes with CJK characters, e.g.
|
||||||
|
one from the `Noto Sans` font family:
|
||||||
|
|
||||||
|
=== "Chinese (Simplified)"
|
||||||
|
|
||||||
|
``` yaml
|
||||||
|
plugins:
|
||||||
|
- social:
|
||||||
|
cards_font: Noto Sans SC
|
||||||
|
```
|
||||||
|
|
||||||
|
=== "Chinese (Traditional)"
|
||||||
|
|
||||||
|
``` yaml
|
||||||
|
plugins:
|
||||||
|
- social:
|
||||||
|
cards_font: Noto Sans TC
|
||||||
|
```
|
||||||
|
|
||||||
|
=== "Japanese"
|
||||||
|
|
||||||
|
``` yaml
|
||||||
|
plugins:
|
||||||
|
- social:
|
||||||
|
cards_font: Noto Sans JP
|
||||||
|
```
|
||||||
|
|
||||||
|
=== "Korean"
|
||||||
|
|
||||||
|
``` yaml
|
||||||
|
plugins:
|
||||||
|
- social:
|
||||||
|
cards_font: Noto Sans KR
|
||||||
|
```
|
||||||
|
|
||||||
|
[`cards_dir`](#+social.cards_dir){ #+social.cards_dir }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: `assets/images/social` – This option
|
: :octicons-milestone-24: Default: `assets/images/social` – This option
|
||||||
specifies where the generated social card images will be written to. It's
|
specifies where the generated social card images will be written to. It's
|
||||||
@ -111,28 +144,33 @@ The following configuration options are available:
|
|||||||
``` yaml
|
``` yaml
|
||||||
plugins:
|
plugins:
|
||||||
- social:
|
- social:
|
||||||
cards_dir: assets/images/social
|
cards_dir: path/to/folder
|
||||||
```
|
```
|
||||||
|
|
||||||
[Insiders]: ../insiders/index.md
|
[Social cards support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.5.0
|
||||||
[dependencies]: #dependencies
|
[dependencies]: #dependencies
|
||||||
[site_url]: https://www.mkdocs.org/user-guide/configuration/#site_url
|
[site_url]: https://www.mkdocs.org/user-guide/configuration/#site_url
|
||||||
[built-in plugins]: ../insiders/getting-started.md#built-in-plugins
|
[palette.primary]: changing-the-colors.md#primary-color
|
||||||
|
[font.text]: changing-the-fonts.md#regular-font
|
||||||
[environment variable]: https://www.mkdocs.org/user-guide/configuration/#environment-variables
|
[environment variable]: https://www.mkdocs.org/user-guide/configuration/#environment-variables
|
||||||
[CSS color keywords]: https://developer.mozilla.org/en-US/docs/Web/CSS/color_value#color_keywords
|
[CSS color keywords]: https://developer.mozilla.org/en-US/docs/Web/CSS/color_value#color_keywords
|
||||||
[Google Fonts]: https://fonts.google.com
|
[Google Fonts]: https://fonts.google.com
|
||||||
|
[page title]: ../reference/index.md#setting-the-page-title
|
||||||
|
|
||||||
#### Dependencies
|
#### Dependencies
|
||||||
|
|
||||||
Two Python packages are installed alongside Material for MkDocs to generate the
|
Two Python libraries must be installed alongside Material for MkDocs to generate
|
||||||
social preview images, both of which are based on the [Cairo Graphics] library:
|
the social preview images, both of which are based on [Cairo Graphics] –
|
||||||
|
[Pillow] and [CairoSVG]:
|
||||||
|
|
||||||
- [Pillow] – Python imaging library
|
```
|
||||||
- [CairoSVG] – Converter for `*.svg` files
|
pip install pillow cairosvg
|
||||||
|
```
|
||||||
|
|
||||||
The [Docker image] for Insiders comes with all dependencies pre-installed. If
|
Both libraries are built with native extensions which need to be installed as
|
||||||
you don't want to use Docker, see the following section which explains how to
|
well. The [Docker image] comes with all dependencies pre-installed. If you don't
|
||||||
install all dependencies on your system:
|
want to use Docker, see the following section which explains how to install all
|
||||||
|
dependencies on your system:
|
||||||
|
|
||||||
=== ":material-apple: macOS"
|
=== ":material-apple: macOS"
|
||||||
|
|
||||||
@ -177,7 +215,7 @@ install all dependencies on your system:
|
|||||||
[Cairo Graphics]: https://www.cairographics.org/
|
[Cairo Graphics]: https://www.cairographics.org/
|
||||||
[Pillow]: https://pillow.readthedocs.io/
|
[Pillow]: https://pillow.readthedocs.io/
|
||||||
[CairoSVG]: https://cairosvg.org/
|
[CairoSVG]: https://cairosvg.org/
|
||||||
[Docker image]: ../insiders/getting-started.md#with-docker
|
[Docker image]: https://hub.docker.com/r/squidfunk/mkdocs-material/
|
||||||
[Homebrew]: https://brew.sh/
|
[Homebrew]: https://brew.sh/
|
||||||
[installation guide]: https://www.cairographics.org/download/
|
[installation guide]: https://www.cairographics.org/download/
|
||||||
[GTK+]: https://www.gtk.org/docs/installations/windows/
|
[GTK+]: https://www.gtk.org/docs/installations/windows/
|
||||||
|
@ -15,7 +15,7 @@ can help to discover relevant information faster.
|
|||||||
|
|
||||||
### Built-in tags plugin
|
### Built-in tags plugin
|
||||||
|
|
||||||
[:octicons-tag-24: 8.2.0][tags support] ·
|
[:octicons-tag-24: 8.2.0][Tags support] ·
|
||||||
:octicons-cpu-24: Plugin ·
|
:octicons-cpu-24: Plugin ·
|
||||||
:octicons-beaker-24: Experimental
|
:octicons-beaker-24: Experimental
|
||||||
|
|
||||||
@ -30,7 +30,7 @@ plugins:
|
|||||||
|
|
||||||
The following configuration options are available:
|
The following configuration options are available:
|
||||||
|
|
||||||
`tags_file`{ #tags-file }
|
[`tags_file`](#+tags.tags_file){ #+tags.tags_file }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: _none_ – This option specifies which file
|
: :octicons-milestone-24: Default: _none_ – This option specifies which file
|
||||||
should be used to render the tags index. See the section on [adding a tags
|
should be used to render the tags index. See the section on [adding a tags
|
||||||
@ -48,7 +48,7 @@ The following configuration options are available:
|
|||||||
of `mkdocs.yml`. Note, however, that this options is not required – only use
|
of `mkdocs.yml`. Note, however, that this options is not required – only use
|
||||||
it if you want a tags index page.
|
it if you want a tags index page.
|
||||||
|
|
||||||
`tags_extra_files`{ #tags-extra-files } :material-alert-decagram:{ .mdx-pulse title="Added on July 7, 2022" }
|
[`tags_extra_files`](#+tags.tags_extra_files){ #+tags.tags_extra_files } :material-alert-decagram:{ .mdx-pulse title="Added on July 7, 2022" }
|
||||||
|
|
||||||
: [:octicons-tag-24: insiders-4.20.0][Insiders] · :octicons-milestone-24:
|
: [:octicons-tag-24: insiders-4.20.0][Insiders] · :octicons-milestone-24:
|
||||||
Default: _none_ – This option allows to define additional pages to render
|
Default: _none_ – This option allows to define additional pages to render
|
||||||
@ -86,13 +86,13 @@ The following configuration options are available:
|
|||||||
|
|
||||||
See #3864 for additional use cases.
|
See #3864 for additional use cases.
|
||||||
|
|
||||||
[tags support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.2.0
|
[Tags support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.2.0
|
||||||
|
[Insiders]: ../insiders/index.md
|
||||||
[tag identifiers]: #tag-icons
|
[tag identifiers]: #tag-icons
|
||||||
|
|
||||||
### Tag icons
|
### Tag icons
|
||||||
|
|
||||||
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
|
[:octicons-tag-24: 8.5.0][Tag icons support] ·
|
||||||
[:octicons-tag-24: insiders-4.13.0][Insiders] ·
|
|
||||||
:octicons-beaker-24: Experimental
|
:octicons-beaker-24: Experimental
|
||||||
|
|
||||||
Each tag can be associated with an icon, which is then rendered inside the tag.
|
Each tag can be associated with an icon, which is then rendered inside the tag.
|
||||||
@ -118,9 +118,9 @@ extra:
|
|||||||
Identifiers can be reused between tags. Tags which are not explicitly
|
Identifiers can be reused between tags. Tags which are not explicitly
|
||||||
associated will use the default tag icon which is :material-pound:
|
associated will use the default tag icon which is :material-pound:
|
||||||
|
|
||||||
Next, each identifier can be associated with an icon, or even a [custom icon],
|
Next, each identifier can be associated with an icon, even a [custom icon], by
|
||||||
by adding the following lines to `mkdocs.yml` under the `theme.icon`
|
adding the following lines to `mkdocs.yml` under the `theme.icon` configuration
|
||||||
configuration setting:
|
setting:
|
||||||
|
|
||||||
=== "Tag icon"
|
=== "Tag icon"
|
||||||
|
|
||||||
@ -167,7 +167,7 @@ configuration setting:
|
|||||||
CSS: css
|
CSS: css
|
||||||
```
|
```
|
||||||
|
|
||||||
[Insiders]: ../insiders/index.md
|
[Tag icons support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.5.0
|
||||||
[custom icon]: changing-the-logo-and-icons.md#additional-icons
|
[custom icon]: changing-the-logo-and-icons.md#additional-icons
|
||||||
[icon search]: ../reference/icons-emojis.md#search
|
[icon search]: ../reference/icons-emojis.md#search
|
||||||
|
|
||||||
@ -197,7 +197,7 @@ search preview, which now allows to __find pages by tags__.
|
|||||||
|
|
||||||
With the help of the [built-in meta plugin], you can ensure that tags are
|
With the help of the [built-in meta plugin], you can ensure that tags are
|
||||||
set for an entire section and all nested pages, by creating a `.meta.yml`
|
set for an entire section and all nested pages, by creating a `.meta.yml`
|
||||||
in the corresponding folder with the following content:
|
file in the corresponding folder with the following content:
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
tags:
|
tags:
|
||||||
@ -232,10 +232,10 @@ The `[TAGS]` marker specifies the position of the tags index, i.e. it is
|
|||||||
replaced with the actual tags index when the page is rendered. You can include
|
replaced with the actual tags index when the page is rendered. You can include
|
||||||
arbitrary content before and after the marker:
|
arbitrary content before and after the marker:
|
||||||
|
|
||||||
[![Tags index][9]][9]
|
[![Tags index][tags index enabled]][tags index enabled]
|
||||||
|
|
||||||
[tags.tags_file]: #tags-file
|
[tags.tags_file]: #tags-file
|
||||||
[9]: ../assets/screenshots/tags-index.png
|
[tags index enabled]: ../assets/screenshots/tags-index.png
|
||||||
|
|
||||||
### Hiding tags on a page
|
### Hiding tags on a page
|
||||||
|
|
||||||
@ -243,7 +243,7 @@ While the tags are rendered above the main headline, sometimes, it might be
|
|||||||
desirable to hide them for a specific page, which can be achieved with the
|
desirable to hide them for a specific page, which can be achieved with the
|
||||||
front matter `hide` property:
|
front matter `hide` property:
|
||||||
|
|
||||||
``` sh
|
``` yaml
|
||||||
---
|
---
|
||||||
hide:
|
hide:
|
||||||
- tags
|
- tags
|
||||||
|
@ -14,7 +14,7 @@ configure via `mkdocs.yml`.
|
|||||||
|
|
||||||
### Social links
|
### Social links
|
||||||
|
|
||||||
[:octicons-tag-24: 1.0.0][social support] ·
|
[:octicons-tag-24: 1.0.0][Social links support] ·
|
||||||
:octicons-milestone-24: Default: _none_
|
:octicons-milestone-24: Default: _none_
|
||||||
|
|
||||||
Social links are rendered next to the copyright notice as part of the
|
Social links are rendered next to the copyright notice as part of the
|
||||||
@ -41,14 +41,12 @@ extra:
|
|||||||
|
|
||||||
The following properties are available for each link:
|
The following properties are available for each link:
|
||||||
|
|
||||||
`icon`{ #social-icon }
|
[`icon`](#+social.icon){ #+social.icon }
|
||||||
|
|
||||||
: [:octicons-tag-24: 5.0.0][social.icon support] · :octicons-milestone-24:
|
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: __Required__ –
|
||||||
Default: _none_ · :octicons-alert-24: Required – This property must contain
|
This property must contain a valid path to any icon bundled with the theme,
|
||||||
a valid path to any icon bundled with the theme, or the
|
or the build will not succeed. Some popular choices:
|
||||||
build will not succeed. Some popular choices:
|
|
||||||
|
|
||||||
* :fontawesome-brands-behance: – `fontawesome/brands/behance`
|
|
||||||
* :fontawesome-brands-docker: – `fontawesome/brands/docker`
|
* :fontawesome-brands-docker: – `fontawesome/brands/docker`
|
||||||
* :fontawesome-brands-facebook: – `fontawesome/brands/facebook`
|
* :fontawesome-brands-facebook: – `fontawesome/brands/facebook`
|
||||||
* :fontawesome-brands-github: – `fontawesome/brands/github`
|
* :fontawesome-brands-github: – `fontawesome/brands/github`
|
||||||
@ -60,9 +58,9 @@ The following properties are available for each link:
|
|||||||
* :fontawesome-brands-slack: – `fontawesome/brands/slack`
|
* :fontawesome-brands-slack: – `fontawesome/brands/slack`
|
||||||
* :fontawesome-brands-twitter: – `fontawesome/brands/twitter`
|
* :fontawesome-brands-twitter: – `fontawesome/brands/twitter`
|
||||||
|
|
||||||
`link`{ #social-link }
|
[`link`](#+social.link){ #+social.link }
|
||||||
|
|
||||||
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: Required –
|
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: __Required__ –
|
||||||
This property must be set to a relative or absolute URL including the URI
|
This property must be set to a relative or absolute URL including the URI
|
||||||
scheme. All URI schemes are supported, including `mailto` and `bitcoin`:
|
scheme. All URI schemes are supported, including `mailto` and `bitcoin`:
|
||||||
|
|
||||||
@ -84,12 +82,11 @@ The following properties are available for each link:
|
|||||||
link: mailto:<email-address>
|
link: mailto:<email-address>
|
||||||
```
|
```
|
||||||
|
|
||||||
`name`{ #social-name }
|
[`name`](#+social.name){ #+social.name }
|
||||||
|
|
||||||
: [:octicons-tag-24: 5.1.5][social.name support] · :octicons-milestone-24:
|
: :octicons-milestone-24: Default: _domain name from_ `link`_, if available_ –
|
||||||
Default: _domain name from_ `link`_, if available_ – This property is used
|
This property is used as the link's `title` attribute and can be set to a
|
||||||
as the link's `title` attribute and can be set to a discernable name to
|
discernable name to improve accessibility:
|
||||||
improve accessibility:
|
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
extra:
|
extra:
|
||||||
@ -100,9 +97,7 @@ The following properties are available for each link:
|
|||||||
```
|
```
|
||||||
|
|
||||||
[icon search]: ../reference/icons-emojis.md#search
|
[icon search]: ../reference/icons-emojis.md#search
|
||||||
[social support]: https://github.com/squidfunk/mkdocs-material/releases/tag/1.0.0
|
[Social links support]: https://github.com/squidfunk/mkdocs-material/releases/tag/1.0.0
|
||||||
[social.icon support]: https://github.com/squidfunk/mkdocs-material/releases/tag/5.0.0
|
|
||||||
[social.name support]: https://github.com/squidfunk/mkdocs-material/releases/tag/5.1.5
|
|
||||||
|
|
||||||
### Copyright notice
|
### Copyright notice
|
||||||
|
|
||||||
@ -156,7 +151,7 @@ The footer navigation showing links to the previous and next page can be hidden
|
|||||||
with the front matter `hide` property. Add the following lines at the top of a
|
with the front matter `hide` property. Add the following lines at the top of a
|
||||||
Markdown file:
|
Markdown file:
|
||||||
|
|
||||||
``` sh
|
``` yaml
|
||||||
---
|
---
|
||||||
hide:
|
hide:
|
||||||
- footer
|
- footer
|
||||||
@ -174,7 +169,7 @@ hide:
|
|||||||
:octicons-file-symlink-file-24: Customization
|
:octicons-file-symlink-file-24: Customization
|
||||||
|
|
||||||
In order to customize and override the [copyright notice], [extend the theme]
|
In order to customize and override the [copyright notice], [extend the theme]
|
||||||
and [override the `copyright` partial][overriding partials], which normally
|
and [override the `copyright.html` partial][overriding partials], which normally
|
||||||
includes the `copyright` property set in `mkdocs.yml`.
|
includes the `copyright` property set in `mkdocs.yml`.
|
||||||
|
|
||||||
[Custom copyright support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.0.0
|
[Custom copyright support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.0.0
|
||||||
|
@ -15,7 +15,7 @@ documentation remain untouched.
|
|||||||
|
|
||||||
### Versioning
|
### Versioning
|
||||||
|
|
||||||
[:octicons-tag-24: 7.0.0][version support] ·
|
[:octicons-tag-24: 7.0.0][Versioning support] ·
|
||||||
[:octicons-package-24: Utility][mike]
|
[:octicons-package-24: Utility][mike]
|
||||||
|
|
||||||
[mike] makes it easy to deploy multiple versions of your project documentation.
|
[mike] makes it easy to deploy multiple versions of your project documentation.
|
||||||
@ -55,7 +55,7 @@ Check out the versioning example to see it in action –
|
|||||||
to particularly notable versions. This makes it easy to make permalinks to
|
to particularly notable versions. This makes it easy to make permalinks to
|
||||||
whatever version of the documentation you want to direct people to.
|
whatever version of the documentation you want to direct people to.
|
||||||
|
|
||||||
[version support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.0.0
|
[Versioning support]: https://github.com/squidfunk/mkdocs-material/releases/tag/7.0.0
|
||||||
[Version selector preview]: ../assets/screenshots/versioning.png
|
[Version selector preview]: ../assets/screenshots/versioning.png
|
||||||
[version example]: https://squidfunk.github.io/mkdocs-material-example-versioning/
|
[version example]: https://squidfunk.github.io/mkdocs-material-example-versioning/
|
||||||
[Why use mike?]: https://github.com/jimporter/mike#why-use-mike
|
[Why use mike?]: https://github.com/jimporter/mike#why-use-mike
|
||||||
|
@ -133,7 +133,7 @@ matches the new structure:
|
|||||||
- If you've overridden a __template__, check the respective `*.html` file for
|
- If you've overridden a __template__, check the respective `*.html` file for
|
||||||
potential changes
|
potential changes
|
||||||
|
|
||||||
=== ":octicons-file-code-16: base.html"
|
=== ":octicons-file-code-16: `base.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -13,11 +13,6 @@
|
@@ -13,11 +13,6 @@
|
||||||
@ -363,7 +363,7 @@ matches the new structure:
|
|||||||
</div>
|
</div>
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: partials/copyright.html"
|
=== ":octicons-file-code-16: `partials/copyright.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -0,0 +1,16 @@
|
@@ -0,0 +1,16 @@
|
||||||
@ -385,7 +385,7 @@ matches the new structure:
|
|||||||
+</div>
|
+</div>
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: partials/footer.html"
|
=== ":octicons-file-code-16: `partials/footer.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -41,21 +40,10 @@
|
@@ -41,21 +40,10 @@
|
||||||
@ -416,7 +416,7 @@ matches the new structure:
|
|||||||
</footer>
|
</footer>
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: partials/social.html"
|
=== ":octicons-file-code-16: `partials/social.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -4,17 +4,15 @@
|
@@ -4,17 +4,15 @@
|
||||||
@ -492,7 +492,7 @@ matches the new structure:
|
|||||||
- If you've overridden a __template__, check the respective `*.html` file for
|
- If you've overridden a __template__, check the respective `*.html` file for
|
||||||
potential changes
|
potential changes
|
||||||
|
|
||||||
=== ":octicons-file-code-16: base.html"
|
=== ":octicons-file-code-16: `base.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -61,7 +61,7 @@
|
@@ -61,7 +61,7 @@
|
||||||
@ -581,7 +581,7 @@ matches the new structure:
|
|||||||
{% endfor %}
|
{% endfor %}
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: partials/footer.html"
|
=== ":octicons-file-code-16: `partials/footer.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
- <div class="md-footer-nav">
|
- <div class="md-footer-nav">
|
||||||
@ -653,7 +653,7 @@ matches the new structure:
|
|||||||
<div class="md-footer-meta__inner md-grid">
|
<div class="md-footer-meta__inner md-grid">
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: partials/header.html"
|
=== ":octicons-file-code-16: `partials/header.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -6,21 +6,21 @@
|
@@ -6,21 +6,21 @@
|
||||||
@ -725,7 +725,7 @@ matches the new structure:
|
|||||||
{% endif %}
|
{% endif %}
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: partials/source.html"
|
=== ":octicons-file-code-16: `partials/source.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -4,5 +4,5 @@
|
@@ -4,5 +4,5 @@
|
||||||
@ -737,7 +737,7 @@ matches the new structure:
|
|||||||
{% include ".icons/" ~ icon ~ ".svg" %}
|
{% include ".icons/" ~ icon ~ ".svg" %}
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: partials/toc.html"
|
=== ":octicons-file-code-16: `partials/toc.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -12,7 +12,7 @@
|
@@ -12,7 +12,7 @@
|
||||||
@ -808,7 +808,7 @@ matches the new structure:
|
|||||||
- If you've overridden a __template__, check the respective `*.html` file for
|
- If you've overridden a __template__, check the respective `*.html` file for
|
||||||
potential changes
|
potential changes
|
||||||
|
|
||||||
=== ":octicons-file-code-16: base.html"
|
=== ":octicons-file-code-16: `base.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -22,13 +22,6 @@
|
@@ -22,13 +22,6 @@
|
||||||
@ -978,7 +978,7 @@ matches the new structure:
|
|||||||
{%- endfor -%}
|
{%- endfor -%}
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: partials/hero.html"
|
=== ":octicons-file-code-16: `partials/hero.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -1,12 +0,0 @@
|
@@ -1,12 +0,0 @@
|
||||||
@ -996,7 +996,7 @@ matches the new structure:
|
|||||||
-</div>
|
-</div>
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: partials/source-link"
|
=== ":octicons-file-code-16: `partials/source-link`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -1,14 +0,0 @@
|
@@ -1,14 +0,0 @@
|
||||||
@ -1170,7 +1170,7 @@ matches the new structure:
|
|||||||
- If you've overridden a __template__, check the respective `*.html` file for
|
- If you've overridden a __template__, check the respective `*.html` file for
|
||||||
potential changes
|
potential changes
|
||||||
|
|
||||||
=== ":octicons-file-code-16: base.html"
|
=== ":octicons-file-code-16: `base.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -4,7 +4,6 @@
|
@@ -4,7 +4,6 @@
|
||||||
@ -1419,7 +1419,7 @@ matches the new structure:
|
|||||||
{% endfor %}
|
{% endfor %}
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: partials/footer.html"
|
=== ":octicons-file-code-16: `partials/footer.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -5,34 +5,34 @@
|
@@ -5,34 +5,34 @@
|
||||||
@ -1470,7 +1470,7 @@ matches the new structure:
|
|||||||
{% endif %}
|
{% endif %}
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: partials/header.html"
|
=== ":octicons-file-code-16: `partials/header.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -4,51 +4,43 @@
|
@@ -4,51 +4,43 @@
|
||||||
@ -1559,7 +1559,7 @@ matches the new structure:
|
|||||||
</header>
|
</header>
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: partials/hero.html"
|
=== ":octicons-file-code-16: `partials/hero.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -4,9 +4,8 @@
|
@@ -4,9 +4,8 @@
|
||||||
@ -1572,7 +1572,7 @@ matches the new structure:
|
|||||||
<div class="{{ class }}" data-md-component="hero">
|
<div class="{{ class }}" data-md-component="hero">
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: partials/language.html"
|
=== ":octicons-file-code-16: `partials/language.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -4,12 +4,4 @@
|
@@ -4,12 +4,4 @@
|
||||||
@ -1590,7 +1590,7 @@ matches the new structure:
|
|||||||
+{% macro t(key) %}{{ lang.t(key) | default(fallback.t(key)) }}{% endmacro %}
|
+{% macro t(key) %}{{ lang.t(key) | default(fallback.t(key)) }}{% endmacro %}
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: partials/logo.html"
|
=== ":octicons-file-code-16: `partials/logo.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -0,0 +1,9 @@
|
@@ -0,0 +1,9 @@
|
||||||
@ -1605,7 +1605,7 @@ matches the new structure:
|
|||||||
+{% endif %}
|
+{% endif %}
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: partials/nav-item.html"
|
=== ":octicons-file-code-16: `partials/nav-item.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -14,9 +14,15 @@
|
@@ -14,9 +14,15 @@
|
||||||
@ -1637,7 +1637,7 @@ matches the new structure:
|
|||||||
<a href="{{ nav_item.url | url }}" title="{{ nav_item.title | striptags }}" class="md-nav__link md-nav__link--active">
|
<a href="{{ nav_item.url | url }}" title="{{ nav_item.title | striptags }}" class="md-nav__link md-nav__link--active">
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: partials/nav.html"
|
=== ":octicons-file-code-16: `partials/nav.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -4,14 +4,10 @@
|
@@ -4,14 +4,10 @@
|
||||||
@ -1658,7 +1658,7 @@ matches the new structure:
|
|||||||
</label>
|
</label>
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: partials/search.html"
|
=== ":octicons-file-code-16: `partials/search.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -6,15 +6,18 @@
|
@@ -6,15 +6,18 @@
|
||||||
@ -1686,7 +1686,7 @@ matches the new structure:
|
|||||||
</div>
|
</div>
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: partials/social.html"
|
=== ":octicons-file-code-16: `partials/social.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -4,9 +4,12 @@
|
@@ -4,9 +4,12 @@
|
||||||
@ -1705,7 +1705,7 @@ matches the new structure:
|
|||||||
{% endif %}
|
{% endif %}
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: partials/source-date.html"
|
=== ":octicons-file-code-16: `partials/source-date.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -0,0 +1,15 @@
|
@@ -0,0 +1,15 @@
|
||||||
@ -1726,7 +1726,7 @@ matches the new structure:
|
|||||||
+</div>
|
+</div>
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: partials/source-link.html"
|
=== ":octicons-file-code-16: `partials/source-link.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -0,0 +1,13 @@
|
@@ -0,0 +1,13 @@
|
||||||
@ -1745,7 +1745,7 @@ matches the new structure:
|
|||||||
+</a>
|
+</a>
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: partials/source.html"
|
=== ":octicons-file-code-16: `partials/source.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -4,24 +4,11 @@
|
@@ -4,24 +4,11 @@
|
||||||
@ -1778,7 +1778,7 @@ matches the new structure:
|
|||||||
</div>
|
</div>
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: partials/tabs-item.html"
|
=== ":octicons-file-code-16: `partials/tabs-item.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -4,7 +4,7 @@
|
@@ -4,7 +4,7 @@
|
||||||
@ -1789,7 +1789,7 @@ matches the new structure:
|
|||||||
<a href="{{ nav_item.url | url }}" class="md-tabs__link md-tabs__link--active">
|
<a href="{{ nav_item.url | url }}" class="md-tabs__link md-tabs__link--active">
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: partials/tabs.html"
|
=== ":octicons-file-code-16: `partials/tabs.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -5,7 +5,7 @@
|
@@ -5,7 +5,7 @@
|
||||||
@ -1803,7 +1803,7 @@ matches the new structure:
|
|||||||
{% for nav_item in nav %}
|
{% for nav_item in nav %}
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: partials/toc-item.html"
|
=== ":octicons-file-code-16: `partials/toc-item.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -6,7 +6,7 @@
|
@@ -6,7 +6,7 @@
|
||||||
@ -1817,7 +1817,7 @@ matches the new structure:
|
|||||||
{% include "partials/toc-item.html" %}
|
{% include "partials/toc-item.html" %}
|
||||||
```
|
```
|
||||||
|
|
||||||
=== ":octicons-file-code-16: partials/toc.html"
|
=== ":octicons-file-code-16: `partials/toc.html`"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -4,35 +4,22 @@
|
@@ -4,35 +4,22 @@
|
||||||
|
@ -1 +1 @@
|
|||||||
<svg viewBox="0 0 640 512" xmlns="http://www.w3.org/2000/svg"><!--! Font Awesome Free 6.1.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M320 96v320a160.019 160.019 0 0 0 113.138-46.862 160.019 160.019 0 0 0 34.683-174.367 160.006 160.006 0 0 0-86.591-86.592A160.019 160.019 0 0 0 320 96ZM0 256l160.002 160 160.001-160L160.002 96 0 256Zm480 0a160 160 0 0 0 160 160V96a160.002 160.002 0 0 0-160 160Z"/></svg>
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M320 96v320a160.019 160.019 0 0 0 113.138-46.862 160.019 160.019 0 0 0 34.683-174.367 160.006 160.006 0 0 0-86.591-86.592A160.019 160.019 0 0 0 320 96ZM0 256l160.002 160 160.001-160L160.002 96 0 256Zm480 0a160 160 0 0 0 160 160V96a160.002 160.002 0 0 0-160 160Z"/></svg>
|
Before Width: | Height: | Size: 551 B After Width: | Height: | Size: 551 B |
@ -1 +1 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.1.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M103.3 344.3c-6.5-14.2-6.9-18.3 7.4-23.1 25.6-8 8 9.2 43.2 49.2h.3v-93.9c1.2-50.2 44-92.2 97.7-92.2 53.9 0 97.7 43.5 97.7 96.8 0 63.4-60.8 113.2-128.5 93.3-10.5-4.2-2.1-31.7 8.5-28.6 53 0 89.4-10.1 89.4-64.4 0-61-77.1-89.6-116.9-44.6-23.5 26.4-17.6 42.1-17.6 157.6 50.7 31 118.3 22 160.4-20.1 24.8-24.8 38.5-58 38.5-93 0-35.2-13.8-68.2-38.8-93.3-24.8-24.8-57.8-38.5-93.3-38.5s-68.8 13.8-93.5 38.5c-.3.3-16 16.5-21.2 23.9l-.5.6c-3.3 4.7-6.3 9.1-20.1 6.1-6.9-1.7-14.3-5.8-14.3-11.8V20c0-5 3.9-10.5 10.5-10.5h241.3c8.3 0 8.3 11.6 8.3 15.1 0 3.9 0 15.1-8.3 15.1H130.3v132.9h.3c104.2-109.8 282.8-36 282.8 108.9 0 178.1-244.8 220.3-310.1 62.8zm63.3-260.8c-.5 4.2 4.6 24.5 14.6 20.6C306 56.6 384 144.5 390.6 144.5c4.8 0 22.8-15.3 14.3-22.8-93.2-89-234.5-57-238.3-38.2zM393 414.7C283 524.6 94 475.5 61 310.5c0-12.2-30.4-7.4-28.9 3.3 24 173.4 246 256.9 381.6 121.3 6.9-7.8-12.6-28.4-20.7-20.4zM213.6 306.6c0 4 4.3 7.3 5.5 8.5 3 3 6.1 4.4 8.5 4.4 3.8 0 2.6.2 22.3-19.5 19.6 19.3 19.1 19.5 22.3 19.5 5.4 0 18.5-10.4 10.7-18.2L265.6 284l18.2-18.2c6.3-6.8-10.1-21.8-16.2-15.7L249.7 268c-18.6-18.8-18.4-19.5-21.5-19.5-5 0-18 11.7-12.4 17.3L234 284c-18.1 17.9-20.4 19.2-20.4 22.6z"/></svg>
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M103.3 344.3c-6.5-14.2-6.9-18.3 7.4-23.1 25.6-8 8 9.2 43.2 49.2h.3v-93.9c1.2-50.2 44-92.2 97.7-92.2 53.9 0 97.7 43.5 97.7 96.8 0 63.4-60.8 113.2-128.5 93.3-10.5-4.2-2.1-31.7 8.5-28.6 53 0 89.4-10.1 89.4-64.4 0-61-77.1-89.6-116.9-44.6-23.5 26.4-17.6 42.1-17.6 157.6 50.7 31 118.3 22 160.4-20.1 24.8-24.8 38.5-58 38.5-93 0-35.2-13.8-68.2-38.8-93.3-24.8-24.8-57.8-38.5-93.3-38.5s-68.8 13.8-93.5 38.5c-.3.3-16 16.5-21.2 23.9l-.5.6c-3.3 4.7-6.3 9.1-20.1 6.1-6.9-1.7-14.3-5.8-14.3-11.8V20c0-5 3.9-10.5 10.5-10.5h241.3c8.3 0 8.3 11.6 8.3 15.1 0 3.9 0 15.1-8.3 15.1H130.3v132.9h.3c104.2-109.8 282.8-36 282.8 108.9 0 178.1-244.8 220.3-310.1 62.8zm63.3-260.8c-.5 4.2 4.6 24.5 14.6 20.6C306 56.6 384 144.5 390.6 144.5c4.8 0 22.8-15.3 14.3-22.8-93.2-89-234.5-57-238.3-38.2zM393 414.7C283 524.6 94 475.5 61 310.5c0-12.2-30.4-7.4-28.9 3.3 24 173.4 246 256.9 381.6 121.3 6.9-7.8-12.6-28.4-20.7-20.4zM213.6 306.6c0 4 4.3 7.3 5.5 8.5 3 3 6.1 4.4 8.5 4.4 3.8 0 2.6.2 22.3-19.5 19.6 19.3 19.1 19.5 22.3 19.5 5.4 0 18.5-10.4 10.7-18.2L265.6 284l18.2-18.2c6.3-6.8-10.1-21.8-16.2-15.7L249.7 268c-18.6-18.8-18.4-19.5-21.5-19.5-5 0-18 11.7-12.4 17.3L234 284c-18.1 17.9-20.4 19.2-20.4 22.6z"/></svg>
|
Before Width: | Height: | Size: 1.4 KiB After Width: | Height: | Size: 1.4 KiB |
@ -1 +1 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.1.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M423.9 255.8 411 413.1c-3.3 40.7-63.9 35.1-60.6-4.9l10-122.5-41.1 2.3c10.1 20.7 15.8 43.9 15.8 68.5 0 41.2-16.1 78.7-42.3 106.5l-39.3-39.3c57.9-63.7 13.1-167.2-74-167.2-25.9 0-49.5 9.9-67.2 26L73 243.2c22-20.7 50.1-35.1 81.4-40.2l75.3-85.7-42.6-24.8-51.6 46c-30 26.8-70.6-18.5-40.5-45.4l68-60.7c9.8-8.8 24.1-10.2 35.5-3.6 0 0 139.3 80.9 139.5 81.1 16.2 10.1 20.7 36 6.1 52.6L285.7 229l106.1-5.9c18.5-1.1 33.6 14.4 32.1 32.7zm-64.9-154c28.1 0 50.9-22.8 50.9-50.9C409.9 22.8 387.1 0 359 0c-28.1 0-50.9 22.8-50.9 50.9 0 28.1 22.8 50.9 50.9 50.9zM179.6 456.5c-80.6 0-127.4-90.6-82.7-156.1l-39.7-39.7C36.4 287 24 320.3 24 356.4c0 130.7 150.7 201.4 251.4 122.5l-39.7-39.7c-16 10.9-35.3 17.3-56.1 17.3z"/></svg>
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M423.9 255.8 411 413.1c-3.3 40.7-63.9 35.1-60.6-4.9l10-122.5-41.1 2.3c10.1 20.7 15.8 43.9 15.8 68.5 0 41.2-16.1 78.7-42.3 106.5l-39.3-39.3c57.9-63.7 13.1-167.2-74-167.2-25.9 0-49.5 9.9-67.2 26L73 243.2c22-20.7 50.1-35.1 81.4-40.2l75.3-85.7-42.6-24.8-51.6 46c-30 26.8-70.6-18.5-40.5-45.4l68-60.7c9.8-8.8 24.1-10.2 35.5-3.6 0 0 139.3 80.9 139.5 81.1 16.2 10.1 20.7 36 6.1 52.6L285.7 229l106.1-5.9c18.5-1.1 33.6 14.4 32.1 32.7zm-64.9-154c28.1 0 50.9-22.8 50.9-50.9C409.9 22.8 387.1 0 359 0c-28.1 0-50.9 22.8-50.9 50.9 0 28.1 22.8 50.9 50.9 50.9zM179.6 456.5c-80.6 0-127.4-90.6-82.7-156.1l-39.7-39.7C36.4 287 24 320.3 24 356.4c0 130.7 150.7 201.4 251.4 122.5l-39.7-39.7c-16 10.9-35.3 17.3-56.1 17.3z"/></svg>
|
Before Width: | Height: | Size: 985 B After Width: | Height: | Size: 985 B |
@ -1 +1 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.1.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M322.1 252v-1l-51.2-65.8s-12 1.6-25 15.1c-9 9.3-242.1 239.1-243.4 240.9-7 10 1.6 6.8 15.7 1.7.8 0 114.5-36.6 114.5-36.6.5-.6-.1-.1.6-.6-.4-5.1-.8-26.2-1-27.7-.6-5.2 2.2-6.9 7-8.9l92.6-33.8c.6-.8 88.5-81.7 90.2-83.3zm160.1 120.1c13.3 16.1 20.7 13.3 30.8 9.3 3.2-1.2 115.4-47.6 117.8-48.9 8-4.3-1.7-16.7-7.2-23.4-2.1-2.5-205.1-245.6-207.2-248.3-9.7-12.2-14.3-12.9-38.4-12.8-10.2 0-106.8.5-116.5.6-19.2.1-32.9-.3-19.2 16.9C250 75 476.5 365.2 482.2 372.1zm152.7 1.6c-2.3-.3-24.6-4.7-38-7.2 0 0-115 50.4-117.5 51.6-16 7.3-26.9-3.2-36.7-14.6l-57.1-74c-5.4-.9-60.4-9.6-65.3-9.3-3.1.2-9.6.8-14.4 2.9-4.9 2.1-145.2 52.8-150.2 54.7-5.1 2-11.4 3.6-11.1 7.6.2 2.5 2 2.6 4.6 3.5 2.7.8 300.9 67.6 308 69.1 15.6 3.3 38.5 10.5 53.6 1.7 2.1-1.2 123.8-76.4 125.8-77.8 5.4-4 4.3-6.8-1.7-8.2z"/></svg>
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M322.1 252v-1l-51.2-65.8s-12 1.6-25 15.1c-9 9.3-242.1 239.1-243.4 240.9-7 10 1.6 6.8 15.7 1.7.8 0 114.5-36.6 114.5-36.6.5-.6-.1-.1.6-.6-.4-5.1-.8-26.2-1-27.7-.6-5.2 2.2-6.9 7-8.9l92.6-33.8c.6-.8 88.5-81.7 90.2-83.3zm160.1 120.1c13.3 16.1 20.7 13.3 30.8 9.3 3.2-1.2 115.4-47.6 117.8-48.9 8-4.3-1.7-16.7-7.2-23.4-2.1-2.5-205.1-245.6-207.2-248.3-9.7-12.2-14.3-12.9-38.4-12.8-10.2 0-106.8.5-116.5.6-19.2.1-32.9-.3-19.2 16.9C250 75 476.5 365.2 482.2 372.1zm152.7 1.6c-2.3-.3-24.6-4.7-38-7.2 0 0-115 50.4-117.5 51.6-16 7.3-26.9-3.2-36.7-14.6l-57.1-74c-5.4-.9-60.4-9.6-65.3-9.3-3.1.2-9.6.8-14.4 2.9-4.9 2.1-145.2 52.8-150.2 54.7-5.1 2-11.4 3.6-11.1 7.6.2 2.5 2 2.6 4.6 3.5 2.7.8 300.9 67.6 308 69.1 15.6 3.3 38.5 10.5 53.6 1.7 2.1-1.2 123.8-76.4 125.8-77.8 5.4-4 4.3-6.8-1.7-8.2z"/></svg>
|
Before Width: | Height: | Size: 1.0 KiB After Width: | Height: | Size: 1.0 KiB |
@ -1 +1 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.1.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="m248 167.5 64.9 98.8H183.1l64.9-98.8zM496 256c0 136.9-111.1 248-248 248S0 392.9 0 256 111.1 8 248 8s248 111.1 248 248zm-99.8 82.7L248 115.5 99.8 338.7h30.4l33.6-51.7h168.6l33.6 51.7h30.2z"/></svg>
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="m248 167.5 64.9 98.8H183.1l64.9-98.8zM496 256c0 136.9-111.1 248-248 248S0 392.9 0 256 111.1 8 248 8s248 111.1 248 248zm-99.8 82.7L248 115.5 99.8 338.7h30.4l33.6-51.7h168.6l33.6 51.7h30.2z"/></svg>
|
Before Width: | Height: | Size: 477 B After Width: | Height: | Size: 477 B |
@ -1 +1 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.1.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M482.1 32H28.7C5.8 32 0 37.9 0 60.9v390.2C0 474.4 5.8 480 28.7 480h453.4c24.4 0 29.9-5.2 29.9-29.7V62.2c0-24.6-5.4-30.2-29.9-30.2zM178.4 220.3c-27.5-20.2-72.1-8.7-84.2 23.4-4.3 11.1-9.3 9.5-17.5 8.3-9.7-1.5-17.2-3.2-22.5-5.5-28.8-11.4 8.6-55.3 24.9-64.3 41.1-21.4 83.4-22.2 125.3-4.8 40.9 16.8 34.5 59.2 34.5 128.5 2.7 25.8-4.3 58.3 9.3 88.8 1.9 4.4.4 7.9-2.7 10.7-8.4 6.7-39.3 2.2-46.6-7.4-1.9-2.2-1.8-3.6-3.9-6.2-3.6-3.9-7.3-2.2-11.9 1-57.4 36.4-140.3 21.4-147-43.3-3.1-29.3 12.4-57.1 39.6-71 38.2-19.5 112.2-11.8 114-30.9 1.1-10.2-1.9-20.1-11.3-27.3zm286.7 222c0 15.1-11.1 9.9-17.8 9.9H52.4c-7.4 0-18.2 4.8-17.8-10.7.4-13.9 10.5-9.1 17.1-9.1 132.3-.4 264.5-.4 396.8 0 6.8 0 16.6-4.4 16.6 9.9zm3.8-340.5v291c0 5.7-.7 13.9-8.1 13.9-12.4-.4-27.5 7.1-36.1-5.6-5.8-8.7-7.8-4-12.4-1.2-53.4 29.7-128.1 7.1-144.4-85.2-6.1-33.4-.7-67.1 15.7-100 11.8-23.9 56.9-76.1 136.1-30.5v-71c0-26.2-.1-26.2 26-26.2 3.1 0 6.6.4 9.7 0 10.1-.8 13.6 4.4 13.6 14.3-.1.2-.1.3-.1.5zm-51.5 232.3c-19.5 47.6-72.9 43.3-90 5.2-15.1-33.3-15.5-68.2.4-101.5 16.3-34.1 59.7-35.7 81.5-4.8 20.6 28.8 14.9 84.6 8.1 101.1zm-294.8 35.3c-7.5-1.3-33-3.3-33.7-27.8-.4-13.9 7.8-23 19.8-25.8 24.4-5.9 49.3-9.9 73.7-14.7 8.9-2 7.4 4.4 7.8 9.5 1.4 33-26.1 59.2-67.6 58.8z"/></svg>
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M482.1 32H28.7C5.8 32 0 37.9 0 60.9v390.2C0 474.4 5.8 480 28.7 480h453.4c24.4 0 29.9-5.2 29.9-29.7V62.2c0-24.6-5.4-30.2-29.9-30.2zM178.4 220.3c-27.5-20.2-72.1-8.7-84.2 23.4-4.3 11.1-9.3 9.5-17.5 8.3-9.7-1.5-17.2-3.2-22.5-5.5-28.8-11.4 8.6-55.3 24.9-64.3 41.1-21.4 83.4-22.2 125.3-4.8 40.9 16.8 34.5 59.2 34.5 128.5 2.7 25.8-4.3 58.3 9.3 88.8 1.9 4.4.4 7.9-2.7 10.7-8.4 6.7-39.3 2.2-46.6-7.4-1.9-2.2-1.8-3.6-3.9-6.2-3.6-3.9-7.3-2.2-11.9 1-57.4 36.4-140.3 21.4-147-43.3-3.1-29.3 12.4-57.1 39.6-71 38.2-19.5 112.2-11.8 114-30.9 1.1-10.2-1.9-20.1-11.3-27.3zm286.7 222c0 15.1-11.1 9.9-17.8 9.9H52.4c-7.4 0-18.2 4.8-17.8-10.7.4-13.9 10.5-9.1 17.1-9.1 132.3-.4 264.5-.4 396.8 0 6.8 0 16.6-4.4 16.6 9.9zm3.8-340.5v291c0 5.7-.7 13.9-8.1 13.9-12.4-.4-27.5 7.1-36.1-5.6-5.8-8.7-7.8-4-12.4-1.2-53.4 29.7-128.1 7.1-144.4-85.2-6.1-33.4-.7-67.1 15.7-100 11.8-23.9 56.9-76.1 136.1-30.5v-71c0-26.2-.1-26.2 26-26.2 3.1 0 6.6.4 9.7 0 10.1-.8 13.6 4.4 13.6 14.3-.1.2-.1.3-.1.5zm-51.5 232.3c-19.5 47.6-72.9 43.3-90 5.2-15.1-33.3-15.5-68.2.4-101.5 16.3-34.1 59.7-35.7 81.5-4.8 20.6 28.8 14.9 84.6 8.1 101.1zm-294.8 35.3c-7.5-1.3-33-3.3-33.7-27.8-.4-13.9 7.8-23 19.8-25.8 24.4-5.9 49.3-9.9 73.7-14.7 8.9-2 7.4 4.4 7.8 9.5 1.4 33-26.1 59.2-67.6 58.8z"/></svg>
|
Before Width: | Height: | Size: 1.5 KiB After Width: | Height: | Size: 1.5 KiB |
@ -1 +1 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.1.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M159.7 237.4C108.4 308.3 43.1 348.2 14 326.6-15.2 304.9 2.8 230 54.2 159.1c51.3-70.9 116.6-110.8 145.7-89.2 29.1 21.6 11.1 96.6-40.2 167.5zm351.2-57.3C437.1 303.5 319 367.8 246.4 323.7c-25-15.2-41.3-41.2-49-73.8-33.6 64.8-92.8 113.8-164.1 133.2 49.8 59.3 124.1 96.9 207 96.9 150 0 271.6-123.1 271.6-274.9.1-8.5-.3-16.8-1-25z"/></svg>
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M159.7 237.4C108.4 308.3 43.1 348.2 14 326.6-15.2 304.9 2.8 230 54.2 159.1c51.3-70.9 116.6-110.8 145.7-89.2 29.1 21.6 11.1 96.6-40.2 167.5zm351.2-57.3C437.1 303.5 319 367.8 246.4 323.7c-25-15.2-41.3-41.2-49-73.8-33.6 64.8-92.8 113.8-164.1 133.2 49.8 59.3 124.1 96.9 207 96.9 150 0 271.6-123.1 271.6-274.9.1-8.5-.3-16.8-1-25z"/></svg>
|
Before Width: | Height: | Size: 614 B After Width: | Height: | Size: 614 B |
@ -1 +1 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.1.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M224 373.12c-25.24-31.67-40.08-59.43-45-83.18-22.55-88 112.61-88 90.06 0-5.45 24.25-20.29 52-45 83.18zm138.15 73.23c-42.06 18.31-83.67-10.88-119.3-50.47 103.9-130.07 46.11-200-18.85-200-54.92 0-85.16 46.51-73.28 100.5 6.93 29.19 25.23 62.39 54.43 99.5-32.53 36.05-60.55 52.69-85.15 54.92-50 7.43-89.11-41.06-71.3-91.09 15.1-39.16 111.72-231.18 115.87-241.56 15.75-30.07 25.56-57.4 59.38-57.4 32.34 0 43.4 25.94 60.37 59.87 36 70.62 89.35 177.48 114.84 239.09 13.17 33.07-1.37 71.29-37.01 86.64zm47-136.12C280.27 35.93 273.13 32 224 32c-45.52 0-64.87 31.67-84.66 72.79C33.18 317.1 22.89 347.19 22 349.81-3.22 419.14 48.74 480 111.63 480c21.71 0 60.61-6.06 112.37-62.4 58.68 63.78 101.26 62.4 112.37 62.4 62.89.05 114.85-60.86 89.61-130.19.02-3.89-16.82-38.9-16.82-39.58z"/></svg>
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M224 373.12c-25.24-31.67-40.08-59.43-45-83.18-22.55-88 112.61-88 90.06 0-5.45 24.25-20.29 52-45 83.18zm138.15 73.23c-42.06 18.31-83.67-10.88-119.3-50.47 103.9-130.07 46.11-200-18.85-200-54.92 0-85.16 46.51-73.28 100.5 6.93 29.19 25.23 62.39 54.43 99.5-32.53 36.05-60.55 52.69-85.15 54.92-50 7.43-89.11-41.06-71.3-91.09 15.1-39.16 111.72-231.18 115.87-241.56 15.75-30.07 25.56-57.4 59.38-57.4 32.34 0 43.4 25.94 60.37 59.87 36 70.62 89.35 177.48 114.84 239.09 13.17 33.07-1.37 71.29-37.01 86.64zm47-136.12C280.27 35.93 273.13 32 224 32c-45.52 0-64.87 31.67-84.66 72.79C33.18 317.1 22.89 347.19 22 349.81-3.22 419.14 48.74 480 111.63 480c21.71 0 60.61-6.06 112.37-62.4 58.68 63.78 101.26 62.4 112.37 62.4 62.89.05 114.85-60.86 89.61-130.19.02-3.89-16.82-38.9-16.82-39.58z"/></svg>
|
Before Width: | Height: | Size: 1.0 KiB After Width: | Height: | Size: 1.0 KiB |
@ -1 +1 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.1.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M229.3 182.6c-49.3 0-89.2 39.9-89.2 89.2 0 49.3 39.9 89.2 89.2 89.2s89.2-39.9 89.2-89.2c0-49.3-40-89.2-89.2-89.2zm62.7 56.6-58.9 30.6c-1.8.9-3.8-.4-3.8-2.3V201c0-1.5 1.3-2.7 2.7-2.6 26.2 1 48.9 15.7 61.1 37.1.7 1.3.2 3-1.1 3.7zM389.1 32H58.9C26.4 32 0 58.4 0 90.9V421c0 32.6 26.4 59 58.9 59H389c32.6 0 58.9-26.4 58.9-58.9V90.9C448 58.4 421.6 32 389.1 32zm-202.6 84.7c0-10.8 8.7-19.5 19.5-19.5h45.3c10.8 0 19.5 8.7 19.5 19.5v15.4c0 1.8-1.7 3-3.3 2.5-12.3-3.4-25.1-5.1-38.1-5.1-13.5 0-26.7 1.8-39.4 5.5-1.7.5-3.4-.8-3.4-2.5v-15.8zm-84.4 37 9.2-9.2c7.6-7.6 19.9-7.6 27.5 0l7.7 7.7c1.1 1.1 1 3-.3 4-6.2 4.5-12.1 9.4-17.6 14.9-5.4 5.4-10.4 11.3-14.8 17.4-1 1.3-2.9 1.5-4 .3l-7.7-7.7c-7.6-7.5-7.6-19.8 0-27.4zm127.2 244.8c-70 0-126.6-56.7-126.6-126.6s56.7-126.6 126.6-126.6c70 0 126.6 56.6 126.6 126.6 0 69.8-56.7 126.6-126.6 126.6z"/></svg>
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M229.3 182.6c-49.3 0-89.2 39.9-89.2 89.2 0 49.3 39.9 89.2 89.2 89.2s89.2-39.9 89.2-89.2c0-49.3-40-89.2-89.2-89.2zm62.7 56.6-58.9 30.6c-1.8.9-3.8-.4-3.8-2.3V201c0-1.5 1.3-2.7 2.7-2.6 26.2 1 48.9 15.7 61.1 37.1.7 1.3.2 3-1.1 3.7zM389.1 32H58.9C26.4 32 0 58.4 0 90.9V421c0 32.6 26.4 59 58.9 59H389c32.6 0 58.9-26.4 58.9-58.9V90.9C448 58.4 421.6 32 389.1 32zm-202.6 84.7c0-10.8 8.7-19.5 19.5-19.5h45.3c10.8 0 19.5 8.7 19.5 19.5v15.4c0 1.8-1.7 3-3.3 2.5-12.3-3.4-25.1-5.1-38.1-5.1-13.5 0-26.7 1.8-39.4 5.5-1.7.5-3.4-.8-3.4-2.5v-15.8zm-84.4 37 9.2-9.2c7.6-7.6 19.9-7.6 27.5 0l7.7 7.7c1.1 1.1 1 3-.3 4-6.2 4.5-12.1 9.4-17.6 14.9-5.4 5.4-10.4 11.3-14.8 17.4-1 1.3-2.9 1.5-4 .3l-7.7-7.7c-7.6-7.5-7.6-19.8 0-27.4zm127.2 244.8c-70 0-126.6-56.7-126.6-126.6s56.7-126.6 126.6-126.6c70 0 126.6 56.6 126.6 126.6 0 69.8-56.7 126.6-126.6 126.6z"/></svg>
|
Before Width: | Height: | Size: 1.1 KiB After Width: | Height: | Size: 1.1 KiB |
@ -1 +1 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.1.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M377.74 32H70.26C31.41 32 0 63.41 0 102.26v307.48C0 448.59 31.41 480 70.26 480h307.48c38.52 0 69.76-31.08 70.26-69.6-45.96-25.62-110.59-60.34-171.6-88.44-32.07 43.97-84.14 81-148.62 81-70.59 0-93.73-45.3-97.04-76.37-3.97-39.01 14.88-81.5 99.52-81.5 35.38 0 79.35 10.25 127.13 24.96 16.53-30.09 26.45-60.34 26.45-60.34h-178.2v-16.7h92.08v-31.24H88.28v-19.01h109.44V92.34h50.92v50.42h109.44v19.01H248.63v31.24h88.77s-15.21 46.62-38.35 90.92c48.93 16.7 100.01 36.04 148.62 52.74V102.26C447.83 63.57 416.43 32 377.74 32zM47.28 322.95c.99 20.17 10.25 53.73 69.93 53.73 52.07 0 92.58-39.68 117.87-72.9-44.63-18.68-84.48-31.41-109.44-31.41-67.45 0-79.35 33.06-78.36 50.58z"/></svg>
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M377.74 32H70.26C31.41 32 0 63.41 0 102.26v307.48C0 448.59 31.41 480 70.26 480h307.48c38.52 0 69.76-31.08 70.26-69.6-45.96-25.62-110.59-60.34-171.6-88.44-32.07 43.97-84.14 81-148.62 81-70.59 0-93.73-45.3-97.04-76.37-3.97-39.01 14.88-81.5 99.52-81.5 35.38 0 79.35 10.25 127.13 24.96 16.53-30.09 26.45-60.34 26.45-60.34h-178.2v-16.7h92.08v-31.24H88.28v-19.01h109.44V92.34h50.92v50.42h109.44v19.01H248.63v31.24h88.77s-15.21 46.62-38.35 90.92c48.93 16.7 100.01 36.04 148.62 52.74V102.26C447.83 63.57 416.43 32 377.74 32zM47.28 322.95c.99 20.17 10.25 53.73 69.93 53.73 52.07 0 92.58-39.68 117.87-72.9-44.63-18.68-84.48-31.41-109.44-31.41-67.45 0-79.35 33.06-78.36 50.58z"/></svg>
|
Before Width: | Height: | Size: 955 B After Width: | Height: | Size: 955 B |
@ -1 +1 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.1.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M14 325.3c2.3-4.2 5.2-4.9 9.7-2.5 10.4 5.6 20.6 11.4 31.2 16.7a595.88 595.88 0 0 0 127.4 46.3 616.61 616.61 0 0 0 63.2 11.8 603.33 603.33 0 0 0 95 5.2c17.4-.4 34.8-1.8 52.1-3.8a603.66 603.66 0 0 0 163.3-42.8c2.9-1.2 5.9-2 9.1-1.2 6.7 1.8 9 9 4.1 13.9a70 70 0 0 1-9.6 7.4c-30.7 21.1-64.2 36.4-99.6 47.9a473.31 473.31 0 0 1-75.1 17.6 431 431 0 0 1-53.2 4.8 21.3 21.3 0 0 0-2.5.3H308a21.3 21.3 0 0 0-2.5-.3c-3.6-.2-7.2-.3-10.7-.4a426.3 426.3 0 0 1-50.4-5.3A448.4 448.4 0 0 1 164 420a443.33 443.33 0 0 1-145.6-87c-1.8-1.6-3-3.8-4.4-5.7zM172 65.1l-4.3.6a80.92 80.92 0 0 0-38 15.1c-2.4 1.7-4.6 3.5-7.1 5.4a4.29 4.29 0 0 1-.4-1.4c-.4-2.7-.8-5.5-1.3-8.2-.7-4.6-3-6.6-7.6-6.6h-11.5c-6.9 0-8.2 1.3-8.2 8.2v209.3c0 1 0 2 .1 3 .2 3 2 4.9 4.9 5 7 .1 14.1.1 21.1 0 2.9 0 4.7-2 5-5 .1-1 .1-2 .1-3v-72.4c1.1.9 1.7 1.4 2.2 1.9 17.9 14.9 38.5 19.8 61 15.4 20.4-4 34.6-16.5 43.8-34.9 7-13.9 9.9-28.7 10.3-44.1.5-17.1-1.2-33.9-8.1-49.8-8.5-19.6-22.6-32.5-43.9-36.9-3.2-.7-6.5-1-9.8-1.5-2.8-.1-5.5-.1-8.3-.1zM124.6 107a3.48 3.48 0 0 1 1.7-3.3c13.7-9.5 28.8-14.5 45.6-13.2 14.9 1.1 27.1 8.4 33.5 25.9 3.9 10.7 4.9 21.8 4.9 33 0 10.4-.8 20.6-4 30.6-6.8 21.3-22.4 29.4-42.6 28.5-14-.6-26.2-6-37.4-13.9a3.57 3.57 0 0 1-1.7-3.3c.1-14.1 0-28.1 0-42.2s.1-28 0-42.1zm205.7-41.9c-1 .1-2 .3-2.9.4a148 148 0 0 0-28.9 4.1c-6.1 1.6-12 3.8-17.9 5.8-3.6 1.2-5.4 3.8-5.3 7.7.1 3.3-.1 6.6 0 9.9.1 4.8 2.1 6.1 6.8 4.9 7.8-2 15.6-4.2 23.5-5.7 12.3-2.3 24.7-3.3 37.2-1.4 6.5 1 12.6 2.9 16.8 8.4 3.7 4.8 5.1 10.5 5.3 16.4.3 8.3.2 16.6.3 24.9a7.84 7.84 0 0 1-.2 1.4c-.5-.1-.9 0-1.3-.1a180.56 180.56 0 0 0-32-4.9c-11.3-.6-22.5.1-33.3 3.9-12.9 4.5-23.3 12.3-29.4 24.9-4.7 9.8-5.4 20.2-3.9 30.7 2 14 9 24.8 21.4 31.7 11.9 6.6 24.8 7.4 37.9 5.4 15.1-2.3 28.5-8.7 40.3-18.4a7.36 7.36 0 0 1 1.6-1.1c.6 3.8 1.1 7.4 1.8 11 .6 3.1 2.5 5.1 5.4 5.2 5.4.1 10.9.1 16.3 0a4.84 4.84 0 0 0 4.8-4.7 26.2 26.2 0 0 0 .1-2.8v-106a80 80 0 0 0-.9-12.9c-1.9-12.9-7.4-23.5-19-30.4-6.7-4-14.1-6-21.8-7.1-3.6-.5-7.2-.8-10.8-1.3-3.9.1-7.9.1-11.9.1zm35 127.7a3.33 3.33 0 0 1-1.5 3c-11.2 8.1-23.5 13.5-37.4 14.9-5.7.6-11.4.4-16.8-1.8a20.08 20.08 0 0 1-12.4-13.3 32.9 32.9 0 0 1-.1-19.4c2.5-8.3 8.4-13 16.4-15.6a61.33 61.33 0 0 1 24.8-2.2c8.4.7 16.6 2.3 25 3.4 1.6.2 2.1 1 2.1 2.6-.1 4.8 0 9.5 0 14.3s-.2 9.4-.1 14.1zm259.9 129.4c-1-5-4.8-6.9-9.1-8.3a88.42 88.42 0 0 0-21-3.9 147.32 147.32 0 0 0-39.2 1.9c-14.3 2.7-27.9 7.3-40 15.6a13.75 13.75 0 0 0-3.7 3.5 5.11 5.11 0 0 0-.5 4c.4 1.5 2.1 1.9 3.6 1.8a16.2 16.2 0 0 0 2.2-.1c7.8-.8 15.5-1.7 23.3-2.5 11.4-1.1 22.9-1.8 34.3-.9a71.64 71.64 0 0 1 14.4 2.7c5.1 1.4 7.4 5.2 7.6 10.4.4 8-1.4 15.7-3.5 23.3-4.1 15.4-10 30.3-15.8 45.1a17.6 17.6 0 0 0-1 3c-.5 2.9 1.2 4.8 4.1 4.1a10.56 10.56 0 0 0 4.8-2.5 145.91 145.91 0 0 0 12.7-13.4c12.8-16.4 20.3-35.3 24.7-55.6.8-3.6 1.4-7.3 2.1-10.9v-17.3zM493.1 199q-19.35-53.55-38.7-107.2c-2-5.7-4.2-11.3-6.3-16.9-1.1-2.9-3.2-4.8-6.4-4.8-7.6-.1-15.2-.2-22.9-.1-2.5 0-3.7 2-3.2 4.5a43.1 43.1 0 0 0 1.9 6.1q29.4 72.75 59.1 145.5c1.7 4.1 2.1 7.6.2 11.8-3.3 7.3-5.9 15-9.3 22.3-3 6.5-8 11.4-15.2 13.3a42.13 42.13 0 0 1-15.4 1.1c-2.5-.2-5-.8-7.5-1-3.4-.2-5.1 1.3-5.2 4.8q-.15 5 0 9.9c.1 5.5 2 8 7.4 8.9a108.18 108.18 0 0 0 16.9 2c17.1.4 30.7-6.5 39.5-21.4a131.63 131.63 0 0 0 9.2-18.4q35.55-89.7 70.6-179.6a26.62 26.62 0 0 0 1.6-5.5c.4-2.8-.9-4.4-3.7-4.4-6.6-.1-13.3 0-19.9 0a7.54 7.54 0 0 0-7.7 5.2c-.5 1.4-1.1 2.7-1.6 4.1l-34.8 100c-2.5 7.2-5.1 14.5-7.7 22.2-.4-1.1-.6-1.7-.9-2.4z"/></svg>
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M14 325.3c2.3-4.2 5.2-4.9 9.7-2.5 10.4 5.6 20.6 11.4 31.2 16.7a595.88 595.88 0 0 0 127.4 46.3 616.61 616.61 0 0 0 63.2 11.8 603.33 603.33 0 0 0 95 5.2c17.4-.4 34.8-1.8 52.1-3.8a603.66 603.66 0 0 0 163.3-42.8c2.9-1.2 5.9-2 9.1-1.2 6.7 1.8 9 9 4.1 13.9a70 70 0 0 1-9.6 7.4c-30.7 21.1-64.2 36.4-99.6 47.9a473.31 473.31 0 0 1-75.1 17.6 431 431 0 0 1-53.2 4.8 21.3 21.3 0 0 0-2.5.3H308a21.3 21.3 0 0 0-2.5-.3c-3.6-.2-7.2-.3-10.7-.4a426.3 426.3 0 0 1-50.4-5.3A448.4 448.4 0 0 1 164 420a443.33 443.33 0 0 1-145.6-87c-1.8-1.6-3-3.8-4.4-5.7zM172 65.1l-4.3.6a80.92 80.92 0 0 0-38 15.1c-2.4 1.7-4.6 3.5-7.1 5.4a4.29 4.29 0 0 1-.4-1.4c-.4-2.7-.8-5.5-1.3-8.2-.7-4.6-3-6.6-7.6-6.6h-11.5c-6.9 0-8.2 1.3-8.2 8.2v209.3c0 1 0 2 .1 3 .2 3 2 4.9 4.9 5 7 .1 14.1.1 21.1 0 2.9 0 4.7-2 5-5 .1-1 .1-2 .1-3v-72.4c1.1.9 1.7 1.4 2.2 1.9 17.9 14.9 38.5 19.8 61 15.4 20.4-4 34.6-16.5 43.8-34.9 7-13.9 9.9-28.7 10.3-44.1.5-17.1-1.2-33.9-8.1-49.8-8.5-19.6-22.6-32.5-43.9-36.9-3.2-.7-6.5-1-9.8-1.5-2.8-.1-5.5-.1-8.3-.1zM124.6 107a3.48 3.48 0 0 1 1.7-3.3c13.7-9.5 28.8-14.5 45.6-13.2 14.9 1.1 27.1 8.4 33.5 25.9 3.9 10.7 4.9 21.8 4.9 33 0 10.4-.8 20.6-4 30.6-6.8 21.3-22.4 29.4-42.6 28.5-14-.6-26.2-6-37.4-13.9a3.57 3.57 0 0 1-1.7-3.3c.1-14.1 0-28.1 0-42.2s.1-28 0-42.1zm205.7-41.9c-1 .1-2 .3-2.9.4a148 148 0 0 0-28.9 4.1c-6.1 1.6-12 3.8-17.9 5.8-3.6 1.2-5.4 3.8-5.3 7.7.1 3.3-.1 6.6 0 9.9.1 4.8 2.1 6.1 6.8 4.9 7.8-2 15.6-4.2 23.5-5.7 12.3-2.3 24.7-3.3 37.2-1.4 6.5 1 12.6 2.9 16.8 8.4 3.7 4.8 5.1 10.5 5.3 16.4.3 8.3.2 16.6.3 24.9a7.84 7.84 0 0 1-.2 1.4c-.5-.1-.9 0-1.3-.1a180.56 180.56 0 0 0-32-4.9c-11.3-.6-22.5.1-33.3 3.9-12.9 4.5-23.3 12.3-29.4 24.9-4.7 9.8-5.4 20.2-3.9 30.7 2 14 9 24.8 21.4 31.7 11.9 6.6 24.8 7.4 37.9 5.4 15.1-2.3 28.5-8.7 40.3-18.4a7.36 7.36 0 0 1 1.6-1.1c.6 3.8 1.1 7.4 1.8 11 .6 3.1 2.5 5.1 5.4 5.2 5.4.1 10.9.1 16.3 0a4.84 4.84 0 0 0 4.8-4.7 26.2 26.2 0 0 0 .1-2.8v-106a80 80 0 0 0-.9-12.9c-1.9-12.9-7.4-23.5-19-30.4-6.7-4-14.1-6-21.8-7.1-3.6-.5-7.2-.8-10.8-1.3-3.9.1-7.9.1-11.9.1zm35 127.7a3.33 3.33 0 0 1-1.5 3c-11.2 8.1-23.5 13.5-37.4 14.9-5.7.6-11.4.4-16.8-1.8a20.08 20.08 0 0 1-12.4-13.3 32.9 32.9 0 0 1-.1-19.4c2.5-8.3 8.4-13 16.4-15.6a61.33 61.33 0 0 1 24.8-2.2c8.4.7 16.6 2.3 25 3.4 1.6.2 2.1 1 2.1 2.6-.1 4.8 0 9.5 0 14.3s-.2 9.4-.1 14.1zm259.9 129.4c-1-5-4.8-6.9-9.1-8.3a88.42 88.42 0 0 0-21-3.9 147.32 147.32 0 0 0-39.2 1.9c-14.3 2.7-27.9 7.3-40 15.6a13.75 13.75 0 0 0-3.7 3.5 5.11 5.11 0 0 0-.5 4c.4 1.5 2.1 1.9 3.6 1.8a16.2 16.2 0 0 0 2.2-.1c7.8-.8 15.5-1.7 23.3-2.5 11.4-1.1 22.9-1.8 34.3-.9a71.64 71.64 0 0 1 14.4 2.7c5.1 1.4 7.4 5.2 7.6 10.4.4 8-1.4 15.7-3.5 23.3-4.1 15.4-10 30.3-15.8 45.1a17.6 17.6 0 0 0-1 3c-.5 2.9 1.2 4.8 4.1 4.1a10.56 10.56 0 0 0 4.8-2.5 145.91 145.91 0 0 0 12.7-13.4c12.8-16.4 20.3-35.3 24.7-55.6.8-3.6 1.4-7.3 2.1-10.9v-17.3zM493.1 199q-19.35-53.55-38.7-107.2c-2-5.7-4.2-11.3-6.3-16.9-1.1-2.9-3.2-4.8-6.4-4.8-7.6-.1-15.2-.2-22.9-.1-2.5 0-3.7 2-3.2 4.5a43.1 43.1 0 0 0 1.9 6.1q29.4 72.75 59.1 145.5c1.7 4.1 2.1 7.6.2 11.8-3.3 7.3-5.9 15-9.3 22.3-3 6.5-8 11.4-15.2 13.3a42.13 42.13 0 0 1-15.4 1.1c-2.5-.2-5-.8-7.5-1-3.4-.2-5.1 1.3-5.2 4.8q-.15 5 0 9.9c.1 5.5 2 8 7.4 8.9a108.18 108.18 0 0 0 16.9 2c17.1.4 30.7-6.5 39.5-21.4a131.63 131.63 0 0 0 9.2-18.4q35.55-89.7 70.6-179.6a26.62 26.62 0 0 0 1.6-5.5c.4-2.8-.9-4.4-3.7-4.4-6.6-.1-13.3 0-19.9 0a7.54 7.54 0 0 0-7.7 5.2c-.5 1.4-1.1 2.7-1.6 4.1l-34.8 100c-2.5 7.2-5.1 14.5-7.7 22.2-.4-1.1-.6-1.7-.9-2.4z"/></svg>
|
Before Width: | Height: | Size: 3.6 KiB After Width: | Height: | Size: 3.6 KiB |
@ -1 +1 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.1.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M257.2 162.7c-48.7 1.8-169.5 15.5-169.5 117.5 0 109.5 138.3 114 183.5 43.2 6.5 10.2 35.4 37.5 45.3 46.8l56.8-56S341 288.9 341 261.4V114.3C341 89 316.5 32 228.7 32 140.7 32 94 87 94 136.3l73.5 6.8c16.3-49.5 54.2-49.5 54.2-49.5 40.7-.1 35.5 29.8 35.5 69.1zm0 86.8c0 80-84.2 68-84.2 17.2 0-47.2 50.5-56.7 84.2-57.8v40.6zm136 163.5c-7.7 10-70 67-174.5 67S34.2 408.5 9.7 379c-6.8-7.7 1-11.3 5.5-8.3C88.5 415.2 203 488.5 387.7 401c7.5-3.7 13.3 2 5.5 12zm39.8 2.2c-6.5 15.8-16 26.8-21.2 31-5.5 4.5-9.5 2.7-6.5-3.8s19.3-46.5 12.7-55c-6.5-8.3-37-4.3-48-3.2-10.8 1-13 2-14-.3-2.3-5.7 21.7-15.5 37.5-17.5 15.7-1.8 41-.8 46 5.7 3.7 5.1 0 27.1-6.5 43.1z"/></svg>
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M257.2 162.7c-48.7 1.8-169.5 15.5-169.5 117.5 0 109.5 138.3 114 183.5 43.2 6.5 10.2 35.4 37.5 45.3 46.8l56.8-56S341 288.9 341 261.4V114.3C341 89 316.5 32 228.7 32 140.7 32 94 87 94 136.3l73.5 6.8c16.3-49.5 54.2-49.5 54.2-49.5 40.7-.1 35.5 29.8 35.5 69.1zm0 86.8c0 80-84.2 68-84.2 17.2 0-47.2 50.5-56.7 84.2-57.8v40.6zm136 163.5c-7.7 10-70 67-174.5 67S34.2 408.5 9.7 379c-6.8-7.7 1-11.3 5.5-8.3C88.5 415.2 203 488.5 387.7 401c7.5-3.7 13.3 2 5.5 12zm39.8 2.2c-6.5 15.8-16 26.8-21.2 31-5.5 4.5-9.5 2.7-6.5-3.8s19.3-46.5 12.7-55c-6.5-8.3-37-4.3-48-3.2-10.8 1-13 2-14-.3-2.3-5.7 21.7-15.5 37.5-17.5 15.7-1.8 41-.8 46 5.7 3.7 5.1 0 27.1-6.5 43.1z"/></svg>
|
Before Width: | Height: | Size: 930 B After Width: | Height: | Size: 930 B |
@ -1 +1 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.1.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M240.1 32c-61.9 0-131.5 16.9-184.2 55.4-5.1 3.1-9.1 9.2-7.2 19.4 1.1 5.1 5.1 27.4 10.2 39.6 4.1 10.2 14.2 10.2 20.3 6.1 32.5-22.3 96.5-47.7 152.3-47.7 57.9 0 58.9 28.4 58.9 73.1v38.5C203 227.7 78.2 251 46.7 264.2 11.2 280.5 16.3 357.7 16.3 376s15.2 104 124.9 104c47.8 0 113.7-20.7 153.3-42.1v25.4c0 3 2.1 8.2 6.1 9.1 3.1 1 50.7 2 59.9 2s62.5.3 66.5-.7c4.1-1 5.1-6.1 5.1-9.1V168c-.1-80.3-57.9-136-192-136zm50.2 348c-21.4 13.2-48.7 24.4-79.1 24.4-52.8 0-58.9-33.5-59-44.7 0-12.2-3-42.7 18.3-52.9 24.3-13.2 75.1-29.4 119.8-33.5z"/></svg>
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M240.1 32c-61.9 0-131.5 16.9-184.2 55.4-5.1 3.1-9.1 9.2-7.2 19.4 1.1 5.1 5.1 27.4 10.2 39.6 4.1 10.2 14.2 10.2 20.3 6.1 32.5-22.3 96.5-47.7 152.3-47.7 57.9 0 58.9 28.4 58.9 73.1v38.5C203 227.7 78.2 251 46.7 264.2 11.2 280.5 16.3 357.7 16.3 376s15.2 104 124.9 104c47.8 0 113.7-20.7 153.3-42.1v25.4c0 3 2.1 8.2 6.1 9.1 3.1 1 50.7 2 59.9 2s62.5.3 66.5-.7c4.1-1 5.1-6.1 5.1-9.1V168c-.1-80.3-57.9-136-192-136zm50.2 348c-21.4 13.2-48.7 24.4-79.1 24.4-52.8 0-58.9-33.5-59-44.7 0-12.2-3-42.7 18.3-52.9 24.3-13.2 75.1-29.4 119.8-33.5z"/></svg>
|
Before Width: | Height: | Size: 815 B After Width: | Height: | Size: 815 B |
@ -1 +1 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.1.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M420.55 301.93a24 24 0 1 1 24-24 24 24 0 0 1-24 24m-265.1 0a24 24 0 1 1 24-24 24 24 0 0 1-24 24m273.7-144.48 47.94-83a10 10 0 1 0-17.27-10l-48.54 84.07a301.25 301.25 0 0 0-246.56 0l-48.54-84.07a10 10 0 1 0-17.27 10l47.94 83C64.53 202.22 8.24 285.55 0 384h576c-8.24-98.45-64.54-181.78-146.85-226.55"/></svg>
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M420.55 301.93a24 24 0 1 1 24-24 24 24 0 0 1-24 24m-265.1 0a24 24 0 1 1 24-24 24 24 0 0 1-24 24m273.7-144.48 47.94-83a10 10 0 1 0-17.27-10l-48.54 84.07a301.25 301.25 0 0 0-246.56 0l-48.54-84.07a10 10 0 1 0-17.27 10l47.94 83C64.53 202.22 8.24 285.55 0 384h576c-8.24-98.45-64.54-181.78-146.85-226.55"/></svg>
|
Before Width: | Height: | Size: 587 B After Width: | Height: | Size: 587 B |
@ -1 +1 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.1.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M347.1 215.4c11.7-32.6 45.4-126.9 45.4-157.1 0-26.6-15.7-48.9-43.7-48.9-44.6 0-84.6 131.7-97.1 163.1C242 144 196.6 0 156.6 0c-31.1 0-45.7 22.9-45.7 51.7 0 35.3 34.2 126.8 46.6 162-6.3-2.3-13.1-4.3-20-4.3-23.4 0-48.3 29.1-48.3 52.6 0 8.9 4.9 21.4 8 29.7-36.9 10-51.1 34.6-51.1 71.7C46 435.6 114.4 512 210.6 512c118 0 191.4-88.6 191.4-202.9 0-43.1-6.9-82-54.9-93.7zM311.7 108c4-12.3 21.1-64.3 37.1-64.3 8.6 0 10.9 8.9 10.9 16 0 19.1-38.6 124.6-47.1 148l-34-6 33.1-93.7zM142.3 48.3c0-11.9 14.5-45.7 46.3 47.1l34.6 100.3c-15.6-1.3-27.7-3-35.4 1.4-10.9-28.8-45.5-119.7-45.5-148.8zM140 244c29.3 0 67.1 94.6 67.1 107.4 0 5.1-4.9 11.4-10.6 11.4-20.9 0-76.9-76.9-76.9-97.7.1-7.7 12.7-21.1 20.4-21.1zm184.3 186.3c-29.1 32-66.3 48.6-109.7 48.6-59.4 0-106.3-32.6-128.9-88.3-17.1-43.4 3.8-68.3 20.6-68.3 11.4 0 54.3 60.3 54.3 73.1 0 4.9-7.7 8.3-11.7 8.3-16.1 0-22.4-15.5-51.1-51.4-29.7 29.7 20.5 86.9 58.3 86.9 26.1 0 43.1-24.2 38-42 3.7 0 8.3.3 11.7-.6 1.1 27.1 9.1 59.4 41.7 61.7 0-.9 2-7.1 2-7.4 0-17.4-10.6-32.6-10.6-50.3 0-28.3 21.7-55.7 43.7-71.7 8-6 17.7-9.7 27.1-13.1 9.7-3.7 20-8 27.4-15.4-1.1-11.2-5.7-21.1-16.9-21.1-27.7 0-120.6 4-120.6-39.7 0-6.7.1-13.1 17.4-13.1 32.3 0 114.3 8 138.3 29.1 18.1 16.1 24.3 113.2-31 174.7zm-98.6-126c9.7 3.1 19.7 4 29.7 6-7.4 5.4-14 12-20.3 19.1-2.8-8.5-6.2-16.8-9.4-25.1z"/></svg>
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M347.1 215.4c11.7-32.6 45.4-126.9 45.4-157.1 0-26.6-15.7-48.9-43.7-48.9-44.6 0-84.6 131.7-97.1 163.1C242 144 196.6 0 156.6 0c-31.1 0-45.7 22.9-45.7 51.7 0 35.3 34.2 126.8 46.6 162-6.3-2.3-13.1-4.3-20-4.3-23.4 0-48.3 29.1-48.3 52.6 0 8.9 4.9 21.4 8 29.7-36.9 10-51.1 34.6-51.1 71.7C46 435.6 114.4 512 210.6 512c118 0 191.4-88.6 191.4-202.9 0-43.1-6.9-82-54.9-93.7zM311.7 108c4-12.3 21.1-64.3 37.1-64.3 8.6 0 10.9 8.9 10.9 16 0 19.1-38.6 124.6-47.1 148l-34-6 33.1-93.7zM142.3 48.3c0-11.9 14.5-45.7 46.3 47.1l34.6 100.3c-15.6-1.3-27.7-3-35.4 1.4-10.9-28.8-45.5-119.7-45.5-148.8zM140 244c29.3 0 67.1 94.6 67.1 107.4 0 5.1-4.9 11.4-10.6 11.4-20.9 0-76.9-76.9-76.9-97.7.1-7.7 12.7-21.1 20.4-21.1zm184.3 186.3c-29.1 32-66.3 48.6-109.7 48.6-59.4 0-106.3-32.6-128.9-88.3-17.1-43.4 3.8-68.3 20.6-68.3 11.4 0 54.3 60.3 54.3 73.1 0 4.9-7.7 8.3-11.7 8.3-16.1 0-22.4-15.5-51.1-51.4-29.7 29.7 20.5 86.9 58.3 86.9 26.1 0 43.1-24.2 38-42 3.7 0 8.3.3 11.7-.6 1.1 27.1 9.1 59.4 41.7 61.7 0-.9 2-7.1 2-7.4 0-17.4-10.6-32.6-10.6-50.3 0-28.3 21.7-55.7 43.7-71.7 8-6 17.7-9.7 27.1-13.1 9.7-3.7 20-8 27.4-15.4-1.1-11.2-5.7-21.1-16.9-21.1-27.7 0-120.6 4-120.6-39.7 0-6.7.1-13.1 17.4-13.1 32.3 0 114.3 8 138.3 29.1 18.1 16.1 24.3 113.2-31 174.7zm-98.6-126c9.7 3.1 19.7 4 29.7 6-7.4 5.4-14 12-20.3 19.1-2.8-8.5-6.2-16.8-9.4-25.1z"/></svg>
|
Before Width: | Height: | Size: 1.6 KiB After Width: | Height: | Size: 1.6 KiB |
@ -1 +1 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.1.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="m640 238.2-3.2 28.2-34.5 2.3-2 18.1 34.5-2.3-3.2 28.2-34.4 2.2-2.3 20.1 34.4-2.2-3 26.1-64.7 4.1 12.7-113.2L527 365.2l-31.9 2-23.8-117.8 30.3-2 13.6 79.4 31.7-82.4 93.1-6.2zM426.8 371.5l28.3-1.8L468 249.6l-28.4 1.9-12.8 120zM162 388.1l-19.4-36-3.5 37.4-28.2 1.7 2.7-29.1c-11 18-32 34.3-56.9 35.8C23.9 399.9-3 377 .3 339.7c2.6-29.3 26.7-62.8 67.5-65.4 37.7-2.4 47.6 23.2 51.3 28.8l2.8-30.8 38.9-2.5c20.1-1.3 38.7 3.7 42.5 23.7l2.6-26.6 64.8-4.2-2.7 27.9-36.4 2.4-1.7 17.9 36.4-2.3-2.7 27.9-36.4 2.3-1.9 19.9 36.3-2.3-2.1 20.8 55-117.2 23.8-1.6L370.4 369l8.9-85.6-22.3 1.4 2.9-27.9 75-4.9-3 28-24.3 1.6-9.7 91.9-58 3.7-4.3-15.6-39.4 2.5-8 16.3-126.2 7.7zm-44.3-70.2-26.4 1.7C84.6 307.2 76.9 303 65 303.8c-19 1.2-33.3 17.5-34.6 33.3-1.4 16 7.3 32.5 28.7 31.2 12.8-.8 21.3-8.6 28.9-18.9l27-1.7 2.7-29.8zm56.1-7.7c1.2-12.9-7.6-13.6-26.1-12.4l-2.7 28.5c14.2-.9 27.5-2.1 28.8-16.1zm21.1 70.8 5.8-60c-5 13.5-14.7 21.1-27.9 26.6l22.1 33.4zm135.4-45-7.9-37.8-15.8 39.3 23.7-1.5zm-170.1-74.6-4.3-17.5-39.6 2.6-8.1 18.2-31.9 2.1 57-121.9 23.9-1.6 30.7 102 9.9-104.7 27-1.8 37.8 63.6 6.5-66.6 28.5-1.9-4 41.2c7.4-13.5 22.9-44.7 63.6-47.5 40.5-2.8 52.4 29.3 53.4 30.3l3.3-32 39.3-2.7c12.7-.9 27.8.3 36.3 9.7l-4.4-11.9 32.2-2.2 12.9 43.2 23-45.7 31-2.2-43.6 78.4-4.8 44.3-28.4 1.9 4.8-44.3-15.8-43c1 22.3-9.2 40.1-32 49.6l25.2 38.8-36.4 2.4-19.2-36.8-4 38.3-28.4 1.9 3.3-31.5c-6.7 9.3-19.7 35.4-59.6 38-26.2 1.7-45.6-10.3-55.4-39.2l-4 40.3-25 1.6-37.6-63.3-6.3 66.2-56.8 3.7zm276.6-82.1c10.2-.7 17.5-2.1 21.6-4.3 4.5-2.4 7-6.4 7.6-12.1.6-5.3-.6-8.8-3.4-10.4-3.6-2.1-10.6-2.8-22.9-2l-2.9 28.8zM327.7 214c5.6 5.9 12.7 8.5 21.3 7.9 4.7-.3 9.1-1.8 13.3-4.1 5.5-3 10.6-8 15.1-14.3l-34.2 2.3 2.4-23.9 63.1-4.3 1.2-12-31.2 2.1c-4.1-3.7-7.8-6.6-11.1-8.1-4-1.7-8.1-2.8-12.2-2.5-8 .5-15.3 3.6-22 9.2-7.7 6.4-12 14.5-12.9 24.4-1.1 9.6 1.4 17.3 7.2 23.3zm-201.3 8.2 23.8-1.6-8.3-37.6-15.5 39.2z"/></svg>
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="m640 238.2-3.2 28.2-34.5 2.3-2 18.1 34.5-2.3-3.2 28.2-34.4 2.2-2.3 20.1 34.4-2.2-3 26.1-64.7 4.1 12.7-113.2L527 365.2l-31.9 2-23.8-117.8 30.3-2 13.6 79.4 31.7-82.4 93.1-6.2zM426.8 371.5l28.3-1.8L468 249.6l-28.4 1.9-12.8 120zM162 388.1l-19.4-36-3.5 37.4-28.2 1.7 2.7-29.1c-11 18-32 34.3-56.9 35.8C23.9 399.9-3 377 .3 339.7c2.6-29.3 26.7-62.8 67.5-65.4 37.7-2.4 47.6 23.2 51.3 28.8l2.8-30.8 38.9-2.5c20.1-1.3 38.7 3.7 42.5 23.7l2.6-26.6 64.8-4.2-2.7 27.9-36.4 2.4-1.7 17.9 36.4-2.3-2.7 27.9-36.4 2.3-1.9 19.9 36.3-2.3-2.1 20.8 55-117.2 23.8-1.6L370.4 369l8.9-85.6-22.3 1.4 2.9-27.9 75-4.9-3 28-24.3 1.6-9.7 91.9-58 3.7-4.3-15.6-39.4 2.5-8 16.3-126.2 7.7zm-44.3-70.2-26.4 1.7C84.6 307.2 76.9 303 65 303.8c-19 1.2-33.3 17.5-34.6 33.3-1.4 16 7.3 32.5 28.7 31.2 12.8-.8 21.3-8.6 28.9-18.9l27-1.7 2.7-29.8zm56.1-7.7c1.2-12.9-7.6-13.6-26.1-12.4l-2.7 28.5c14.2-.9 27.5-2.1 28.8-16.1zm21.1 70.8 5.8-60c-5 13.5-14.7 21.1-27.9 26.6l22.1 33.4zm135.4-45-7.9-37.8-15.8 39.3 23.7-1.5zm-170.1-74.6-4.3-17.5-39.6 2.6-8.1 18.2-31.9 2.1 57-121.9 23.9-1.6 30.7 102 9.9-104.7 27-1.8 37.8 63.6 6.5-66.6 28.5-1.9-4 41.2c7.4-13.5 22.9-44.7 63.6-47.5 40.5-2.8 52.4 29.3 53.4 30.3l3.3-32 39.3-2.7c12.7-.9 27.8.3 36.3 9.7l-4.4-11.9 32.2-2.2 12.9 43.2 23-45.7 31-2.2-43.6 78.4-4.8 44.3-28.4 1.9 4.8-44.3-15.8-43c1 22.3-9.2 40.1-32 49.6l25.2 38.8-36.4 2.4-19.2-36.8-4 38.3-28.4 1.9 3.3-31.5c-6.7 9.3-19.7 35.4-59.6 38-26.2 1.7-45.6-10.3-55.4-39.2l-4 40.3-25 1.6-37.6-63.3-6.3 66.2-56.8 3.7zm276.6-82.1c10.2-.7 17.5-2.1 21.6-4.3 4.5-2.4 7-6.4 7.6-12.1.6-5.3-.6-8.8-3.4-10.4-3.6-2.1-10.6-2.8-22.9-2l-2.9 28.8zM327.7 214c5.6 5.9 12.7 8.5 21.3 7.9 4.7-.3 9.1-1.8 13.3-4.1 5.5-3 10.6-8 15.1-14.3l-34.2 2.3 2.4-23.9 63.1-4.3 1.2-12-31.2 2.1c-4.1-3.7-7.8-6.6-11.1-8.1-4-1.7-8.1-2.8-12.2-2.5-8 .5-15.3 3.6-22 9.2-7.7 6.4-12 14.5-12.9 24.4-1.1 9.6 1.4 17.3 7.2 23.3zm-201.3 8.2 23.8-1.6-8.3-37.6-15.5 39.2z"/></svg>
|
Before Width: | Height: | Size: 2.1 KiB After Width: | Height: | Size: 2.1 KiB |
@ -1 +1 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.1.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M185.7 268.1h76.2l-38.1-91.6-38.1 91.6zM223.8 32 16 106.4l31.8 275.7 176 97.9 176-97.9 31.8-275.7zM354 373.8h-48.6l-26.2-65.4H168.6l-26.2 65.4H93.7L223.8 81.5z"/></svg>
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M185.7 268.1h76.2l-38.1-91.6-38.1 91.6zM223.8 32 16 106.4l31.8 275.7 176 97.9 176-97.9 31.8-275.7zM354 373.8h-48.6l-26.2-65.4H168.6l-26.2 65.4H93.7L223.8 81.5z"/></svg>
|
Before Width: | Height: | Size: 449 B After Width: | Height: | Size: 449 B |
@ -1 +1 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.1.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M400 32H48C21.5 32 0 53.5 0 80v352c0 26.5 21.5 48 48 48h352c26.5 0 48-21.5 48-48V80c0-26.5-21.5-48-48-48zM127 384.5c-5.5 9.6-17.8 12.8-27.3 7.3-9.6-5.5-12.8-17.8-7.3-27.3l14.3-24.7c16.1-4.9 29.3-1.1 39.6 11.4L127 384.5zm138.9-53.9H84c-11 0-20-9-20-20s9-20 20-20h51l65.4-113.2-20.5-35.4c-5.5-9.6-2.2-21.8 7.3-27.3 9.6-5.5 21.8-2.2 27.3 7.3l8.9 15.4 8.9-15.4c5.5-9.6 17.8-12.8 27.3-7.3 9.6 5.5 12.8 17.8 7.3 27.3l-85.8 148.6h62.1c20.2 0 31.5 23.7 22.7 40zm98.1 0h-29l19.6 33.9c5.5 9.6 2.2 21.8-7.3 27.3-9.6 5.5-21.8 2.2-27.3-7.3-32.9-56.9-57.5-99.7-74-128.1-16.7-29-4.8-58 7.1-67.8 13.1 22.7 32.7 56.7 58.9 102h52c11 0 20 9 20 20 0 11.1-9 20-20 20z"/></svg>
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M400 32H48C21.5 32 0 53.5 0 80v352c0 26.5 21.5 48 48 48h352c26.5 0 48-21.5 48-48V80c0-26.5-21.5-48-48-48zM127 384.5c-5.5 9.6-17.8 12.8-27.3 7.3-9.6-5.5-12.8-17.8-7.3-27.3l14.3-24.7c16.1-4.9 29.3-1.1 39.6 11.4L127 384.5zm138.9-53.9H84c-11 0-20-9-20-20s9-20 20-20h51l65.4-113.2-20.5-35.4c-5.5-9.6-2.2-21.8 7.3-27.3 9.6-5.5 21.8-2.2 27.3 7.3l8.9 15.4 8.9-15.4c5.5-9.6 17.8-12.8 27.3-7.3 9.6 5.5 12.8 17.8 7.3 27.3l-85.8 148.6h62.1c20.2 0 31.5 23.7 22.7 40zm98.1 0h-29l19.6 33.9c5.5 9.6 2.2 21.8-7.3 27.3-9.6 5.5-21.8 2.2-27.3-7.3-32.9-56.9-57.5-99.7-74-128.1-16.7-29-4.8-58 7.1-67.8 13.1 22.7 32.7 56.7 58.9 102h52c11 0 20 9 20 20 0 11.1-9 20-20 20z"/></svg>
|
Before Width: | Height: | Size: 936 B After Width: | Height: | Size: 936 B |
@ -1 +1 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.1.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="m255.9 120.9 9.1-15.7c5.6-9.8 18.1-13.1 27.9-7.5 9.8 5.6 13.1 18.1 7.5 27.9l-87.5 151.5h63.3c20.5 0 32 24.1 23.1 40.8H113.8c-11.3 0-20.4-9.1-20.4-20.4 0-11.3 9.1-20.4 20.4-20.4h52l66.6-115.4-20.8-36.1c-5.6-9.8-2.3-22.2 7.5-27.9 9.8-5.6 22.2-2.3 27.9 7.5l8.9 15.7zm-78.7 218-19.6 34c-5.6 9.8-18.1 13.1-27.9 7.5-9.8-5.6-13.1-18.1-7.5-27.9l14.6-25.2c16.4-5.1 29.8-1.2 40.4 11.6zm168.9-61.7h53.1c11.3 0 20.4 9.1 20.4 20.4 0 11.3-9.1 20.4-20.4 20.4h-29.5l19.9 34.5c5.6 9.8 2.3 22.2-7.5 27.9-9.8 5.6-22.2 2.3-27.9-7.5-33.5-58.1-58.7-101.6-75.4-130.6-17.1-29.5-4.9-59.1 7.2-69.1 13.4 23 33.4 57.7 60.1 104zM256 8C119 8 8 119 8 256s111 248 248 248 248-111 248-248S393 8 256 8zm216 248c0 118.7-96.1 216-216 216-118.7 0-216-96.1-216-216 0-118.7 96.1-216 216-216 118.7 0 216 96.1 216 216z"/></svg>
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="m255.9 120.9 9.1-15.7c5.6-9.8 18.1-13.1 27.9-7.5 9.8 5.6 13.1 18.1 7.5 27.9l-87.5 151.5h63.3c20.5 0 32 24.1 23.1 40.8H113.8c-11.3 0-20.4-9.1-20.4-20.4 0-11.3 9.1-20.4 20.4-20.4h52l66.6-115.4-20.8-36.1c-5.6-9.8-2.3-22.2 7.5-27.9 9.8-5.6 22.2-2.3 27.9 7.5l8.9 15.7zm-78.7 218-19.6 34c-5.6 9.8-18.1 13.1-27.9 7.5-9.8-5.6-13.1-18.1-7.5-27.9l14.6-25.2c16.4-5.1 29.8-1.2 40.4 11.6zm168.9-61.7h53.1c11.3 0 20.4 9.1 20.4 20.4 0 11.3-9.1 20.4-20.4 20.4h-29.5l19.9 34.5c5.6 9.8 2.3 22.2-7.5 27.9-9.8 5.6-22.2 2.3-27.9-7.5-33.5-58.1-58.7-101.6-75.4-130.6-17.1-29.5-4.9-59.1 7.2-69.1 13.4 23 33.4 57.7 60.1 104zM256 8C119 8 8 119 8 256s111 248 248 248 248-111 248-248S393 8 256 8zm216 248c0 118.7-96.1 216-216 216-118.7 0-216-96.1-216-216 0-118.7 96.1-216 216-216 118.7 0 216 96.1 216 216z"/></svg>
|
Before Width: | Height: | Size: 1.0 KiB After Width: | Height: | Size: 1.0 KiB |
@ -1 +1 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.1.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M42.1 239.1c22.2 0 29 2.8 33.5 14.6h.8v-22.9c0-11.3-4.8-15.4-17.9-15.4-11.3 0-14.4 2.5-15.1 12.8H4.8c.3-13.9 1.5-19.1 5.8-24.4C17.9 195 29.5 192 56.7 192c33 0 47.1 5 53.9 18.9 2 4.3 4 15.6 4 23.7v76.3H76.3l1.3-19.1h-1c-5.3 15.6-13.6 20.4-35.5 20.4-30.3 0-41.1-10.1-41.1-37.3 0-25.2 12.3-35.8 42.1-35.8zm17.1 48.1c13.1 0 16.9-3 16.9-13.4 0-9.1-4.3-11.6-19.6-11.6-13.1 0-17.9 3-17.9 12.1-.1 10.4 3.7 12.9 20.6 12.9zm77.8-94.9h38.3l-1.5 20.6h.8c9.1-17.1 15.9-20.9 37.5-20.9 14.4 0 24.7 3 31.5 9.1 9.8 8.6 12.8 20.4 12.8 48.1 0 30-3 43.1-12.1 52.9-6.8 7.3-16.4 10.1-33.2 10.1-20.4 0-29.2-5.5-33.8-21.2h-.8v70.3H137v-169zm80.9 60.7c0-27.5-3.3-32.5-20.7-32.5-16.9 0-20.7 5-20.7 28.7 0 28 3.5 33.5 21.2 33.5 16.4 0 20.2-5.6 20.2-29.7zm57.9-60.7h38.3l-1.5 20.6h.8c9.1-17.1 15.9-20.9 37.5-20.9 14.4 0 24.7 3 31.5 9.1 9.8 8.6 12.8 20.4 12.8 48.1 0 30-3 43.1-12.1 52.9-6.8 7.3-16.4 10.1-33.3 10.1-20.4 0-29.2-5.5-33.8-21.2h-.8v70.3h-39.5v-169zm80.9 60.7c0-27.5-3.3-32.5-20.7-32.5-16.9 0-20.7 5-20.7 28.7 0 28 3.5 33.5 21.2 33.5 16.4 0 20.2-5.6 20.2-29.7zm53.8-3.8c0-25.4 3.3-37.8 12.3-45.8 8.8-8.1 22.2-11.3 45.1-11.3 42.8 0 55.7 12.8 55.7 55.7v11.1h-75.3c-.3 2-.3 4-.3 4.8 0 16.9 4.5 21.9 20.1 21.9 13.9 0 17.9-3 17.9-13.9h37.5v2.3c0 9.8-2.5 18.9-6.8 24.7-7.3 9.8-19.6 13.6-44.3 13.6-27.5 0-41.6-3.3-50.6-12.3-8.5-8.5-11.3-21.3-11.3-50.8zm76.4-11.6c-.3-1.8-.3-3.3-.3-3.8 0-12.3-3.3-14.6-19.6-14.6-14.4 0-17.1 3-18.1 15.1l-.3 3.3h38.3zm55.6-45.3h38.3l-1.8 19.9h.7c6.8-14.9 14.4-20.2 29.7-20.2 10.8 0 19.1 3.3 23.4 9.3 5.3 7.3 6.8 14.4 6.8 34 0 1.5 0 5 .2 9.3h-35c.3-1.8.3-3.3.3-4 0-15.4-2-19.4-10.3-19.4-6.3 0-10.8 3.3-13.1 9.3-1 3-1 4.3-1 12.3v68h-38.3V192.3z"/></svg>
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M42.1 239.1c22.2 0 29 2.8 33.5 14.6h.8v-22.9c0-11.3-4.8-15.4-17.9-15.4-11.3 0-14.4 2.5-15.1 12.8H4.8c.3-13.9 1.5-19.1 5.8-24.4C17.9 195 29.5 192 56.7 192c33 0 47.1 5 53.9 18.9 2 4.3 4 15.6 4 23.7v76.3H76.3l1.3-19.1h-1c-5.3 15.6-13.6 20.4-35.5 20.4-30.3 0-41.1-10.1-41.1-37.3 0-25.2 12.3-35.8 42.1-35.8zm17.1 48.1c13.1 0 16.9-3 16.9-13.4 0-9.1-4.3-11.6-19.6-11.6-13.1 0-17.9 3-17.9 12.1-.1 10.4 3.7 12.9 20.6 12.9zm77.8-94.9h38.3l-1.5 20.6h.8c9.1-17.1 15.9-20.9 37.5-20.9 14.4 0 24.7 3 31.5 9.1 9.8 8.6 12.8 20.4 12.8 48.1 0 30-3 43.1-12.1 52.9-6.8 7.3-16.4 10.1-33.2 10.1-20.4 0-29.2-5.5-33.8-21.2h-.8v70.3H137v-169zm80.9 60.7c0-27.5-3.3-32.5-20.7-32.5-16.9 0-20.7 5-20.7 28.7 0 28 3.5 33.5 21.2 33.5 16.4 0 20.2-5.6 20.2-29.7zm57.9-60.7h38.3l-1.5 20.6h.8c9.1-17.1 15.9-20.9 37.5-20.9 14.4 0 24.7 3 31.5 9.1 9.8 8.6 12.8 20.4 12.8 48.1 0 30-3 43.1-12.1 52.9-6.8 7.3-16.4 10.1-33.3 10.1-20.4 0-29.2-5.5-33.8-21.2h-.8v70.3h-39.5v-169zm80.9 60.7c0-27.5-3.3-32.5-20.7-32.5-16.9 0-20.7 5-20.7 28.7 0 28 3.5 33.5 21.2 33.5 16.4 0 20.2-5.6 20.2-29.7zm53.8-3.8c0-25.4 3.3-37.8 12.3-45.8 8.8-8.1 22.2-11.3 45.1-11.3 42.8 0 55.7 12.8 55.7 55.7v11.1h-75.3c-.3 2-.3 4-.3 4.8 0 16.9 4.5 21.9 20.1 21.9 13.9 0 17.9-3 17.9-13.9h37.5v2.3c0 9.8-2.5 18.9-6.8 24.7-7.3 9.8-19.6 13.6-44.3 13.6-27.5 0-41.6-3.3-50.6-12.3-8.5-8.5-11.3-21.3-11.3-50.8zm76.4-11.6c-.3-1.8-.3-3.3-.3-3.8 0-12.3-3.3-14.6-19.6-14.6-14.4 0-17.1 3-18.1 15.1l-.3 3.3h38.3zm55.6-45.3h38.3l-1.8 19.9h.7c6.8-14.9 14.4-20.2 29.7-20.2 10.8 0 19.1 3.3 23.4 9.3 5.3 7.3 6.8 14.4 6.8 34 0 1.5 0 5 .2 9.3h-35c.3-1.8.3-3.3.3-4 0-15.4-2-19.4-10.3-19.4-6.3 0-10.8 3.3-13.1 9.3-1 3-1 4.3-1 12.3v68h-38.3V192.3z"/></svg>
|
Before Width: | Height: | Size: 1.9 KiB After Width: | Height: | Size: 1.9 KiB |
@ -1 +1 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.1.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M116.9 158.5c-7.5 8.9-19.5 15.9-31.5 14.9-1.5-12 4.4-24.8 11.3-32.6 7.5-9.1 20.6-15.6 31.3-16.1 1.2 12.4-3.7 24.7-11.1 33.8m10.9 17.2c-17.4-1-32.3 9.9-40.5 9.9-8.4 0-21-9.4-34.8-9.1-17.9.3-34.5 10.4-43.6 26.5-18.8 32.3-4.9 80 13.3 106.3 8.9 13 19.5 27.3 33.5 26.8 13.3-.5 18.5-8.6 34.5-8.6 16.1 0 20.8 8.6 34.8 8.4 14.5-.3 23.6-13 32.5-26 10.1-14.8 14.3-29.1 14.5-29.9-.3-.3-28-10.9-28.3-42.9-.3-26.8 21.9-39.5 22.9-40.3-12.5-18.6-32-20.6-38.8-21.1m100.4-36.2v194.9h30.3v-66.6h41.9c38.3 0 65.1-26.3 65.1-64.3s-26.4-64-64.1-64h-73.2zm30.3 25.5h34.9c26.3 0 41.3 14 41.3 38.6s-15 38.8-41.4 38.8h-34.8V165zm162.2 170.9c19 0 36.6-9.6 44.6-24.9h.6v23.4h28v-97c0-28.1-22.5-46.3-57.1-46.3-32.1 0-55.9 18.4-56.8 43.6h27.3c2.3-12 13.4-19.9 28.6-19.9 18.5 0 28.9 8.6 28.9 24.5v10.8l-37.8 2.3c-35.1 2.1-54.1 16.5-54.1 41.5.1 25.2 19.7 42 47.8 42zm8.2-23.1c-16.1 0-26.4-7.8-26.4-19.6 0-12.3 9.9-19.4 28.8-20.5l33.6-2.1v11c0 18.2-15.5 31.2-36 31.2zm102.5 74.6c29.5 0 43.4-11.3 55.5-45.4L640 193h-30.8l-35.6 115.1h-.6L537.4 193h-31.6L557 334.9l-2.8 8.6c-4.6 14.6-12.1 20.3-25.5 20.3-2.4 0-7-.3-8.9-.5v23.4c1.8.4 9.3.7 11.6.7z"/></svg>
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M116.9 158.5c-7.5 8.9-19.5 15.9-31.5 14.9-1.5-12 4.4-24.8 11.3-32.6 7.5-9.1 20.6-15.6 31.3-16.1 1.2 12.4-3.7 24.7-11.1 33.8m10.9 17.2c-17.4-1-32.3 9.9-40.5 9.9-8.4 0-21-9.4-34.8-9.1-17.9.3-34.5 10.4-43.6 26.5-18.8 32.3-4.9 80 13.3 106.3 8.9 13 19.5 27.3 33.5 26.8 13.3-.5 18.5-8.6 34.5-8.6 16.1 0 20.8 8.6 34.8 8.4 14.5-.3 23.6-13 32.5-26 10.1-14.8 14.3-29.1 14.5-29.9-.3-.3-28-10.9-28.3-42.9-.3-26.8 21.9-39.5 22.9-40.3-12.5-18.6-32-20.6-38.8-21.1m100.4-36.2v194.9h30.3v-66.6h41.9c38.3 0 65.1-26.3 65.1-64.3s-26.4-64-64.1-64h-73.2zm30.3 25.5h34.9c26.3 0 41.3 14 41.3 38.6s-15 38.8-41.4 38.8h-34.8V165zm162.2 170.9c19 0 36.6-9.6 44.6-24.9h.6v23.4h28v-97c0-28.1-22.5-46.3-57.1-46.3-32.1 0-55.9 18.4-56.8 43.6h27.3c2.3-12 13.4-19.9 28.6-19.9 18.5 0 28.9 8.6 28.9 24.5v10.8l-37.8 2.3c-35.1 2.1-54.1 16.5-54.1 41.5.1 25.2 19.7 42 47.8 42zm8.2-23.1c-16.1 0-26.4-7.8-26.4-19.6 0-12.3 9.9-19.4 28.8-20.5l33.6-2.1v11c0 18.2-15.5 31.2-36 31.2zm102.5 74.6c29.5 0 43.4-11.3 55.5-45.4L640 193h-30.8l-35.6 115.1h-.6L537.4 193h-31.6L557 334.9l-2.8 8.6c-4.6 14.6-12.1 20.3-25.5 20.3-2.4 0-7-.3-8.9-.5v23.4c1.8.4 9.3.7 11.6.7z"/></svg>
|
Before Width: | Height: | Size: 1.4 KiB After Width: | Height: | Size: 1.4 KiB |
@ -1 +1 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512"><!--! Font Awesome Free 6.1.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M318.7 268.7c-.2-36.7 16.4-64.4 50-84.8-18.8-26.9-47.2-41.7-84.7-44.6-35.5-2.8-74.3 20.7-88.5 20.7-15 0-49.4-19.7-76.4-19.7C63.3 141.2 4 184.8 4 273.5q0 39.3 14.4 81.2c12.8 36.7 59 126.7 107.2 125.2 25.2-.6 43-17.9 75.8-17.9 31.8 0 48.3 17.9 76.4 17.9 48.6-.7 90.4-82.5 102.6-119.3-65.2-30.7-61.7-90-61.7-91.9zm-56.6-164.2c27.3-32.4 24.8-61.9 24-72.5-24.1 1.4-52 16.4-67.9 34.9-17.5 19.8-27.8 44.3-25.6 71.9 26.1 2 49.9-11.4 69.5-34.3z"/></svg>
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M318.7 268.7c-.2-36.7 16.4-64.4 50-84.8-18.8-26.9-47.2-41.7-84.7-44.6-35.5-2.8-74.3 20.7-88.5 20.7-15 0-49.4-19.7-76.4-19.7C63.3 141.2 4 184.8 4 273.5q0 39.3 14.4 81.2c12.8 36.7 59 126.7 107.2 125.2 25.2-.6 43-17.9 75.8-17.9 31.8 0 48.3 17.9 76.4 17.9 48.6-.7 90.4-82.5 102.6-119.3-65.2-30.7-61.7-90-61.7-91.9zm-56.6-164.2c27.3-32.4 24.8-61.9 24-72.5-24.1 1.4-52 16.4-67.9 34.9-17.5 19.8-27.8 44.3-25.6 71.9 26.1 2 49.9-11.4 69.5-34.3z"/></svg>
|
Before Width: | Height: | Size: 725 B After Width: | Height: | Size: 725 B |
@ -1 +1 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.1.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="m2 377.4 43 74.3A51.35 51.35 0 0 0 90.9 480h285.4l-59.2-102.6zM501.8 350 335.6 59.3A51.38 51.38 0 0 0 290.2 32h-88.4l257.3 447.6 40.7-70.5c1.9-3.2 21-29.7 2-59.1zM275 304.5l-115.5-200L44 304.5z"/></svg>
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="m2 377.4 43 74.3A51.35 51.35 0 0 0 90.9 480h285.4l-59.2-102.6zM501.8 350 335.6 59.3A51.38 51.38 0 0 0 290.2 32h-88.4l257.3 447.6 40.7-70.5c1.9-3.2 21-29.7 2-59.1zM275 304.5l-115.5-200L44 304.5z"/></svg>
|
Before Width: | Height: | Size: 483 B After Width: | Height: | Size: 483 B |
@ -1 +1 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.1.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M517.5 309.2c38.8-40 58.1-80 58.5-116.1.8-65.5-59.4-118.2-169.4-135C277.9 38.4 118.1 73.6 0 140.5 52 114 110.6 92.3 170.7 82.3c74.5-20.5 153-25.4 221.3-14.8C544.5 91.3 588.8 195 490.8 299.2c-10.2 10.8-22 21.1-35 30.6L304.9 103.4 114.7 388.9c-65.6-29.4-76.5-90.2-19.1-151.2 20.8-22.2 48.3-41.9 79.5-58.1 20-12.2 39.7-22.6 62-30.7-65.1 20.3-122.7 52.9-161.6 92.9-27.7 28.6-41.4 57.1-41.7 82.9-.5 35.1 23.4 65.1 68.4 83l-34.5 51.7h101.6l22-34.4c22.2 1 45.3 0 68.6-2.7l-22.8 37.1h135.5L340 406.3c18.6-5.3 36.9-11.5 54.5-18.7l45.9 71.8H542L468.6 349c18.5-12.1 35-25.5 48.9-39.8zm-187.6 80.5-25-40.6-32.7 53.3c-23.4 3.5-46.7 5.1-69.2 4.4l101.9-159.3 78.7 123c-17.2 7.4-35.3 13.9-53.7 19.2z"/></svg>
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M517.5 309.2c38.8-40 58.1-80 58.5-116.1.8-65.5-59.4-118.2-169.4-135C277.9 38.4 118.1 73.6 0 140.5 52 114 110.6 92.3 170.7 82.3c74.5-20.5 153-25.4 221.3-14.8C544.5 91.3 588.8 195 490.8 299.2c-10.2 10.8-22 21.1-35 30.6L304.9 103.4 114.7 388.9c-65.6-29.4-76.5-90.2-19.1-151.2 20.8-22.2 48.3-41.9 79.5-58.1 20-12.2 39.7-22.6 62-30.7-65.1 20.3-122.7 52.9-161.6 92.9-27.7 28.6-41.4 57.1-41.7 82.9-.5 35.1 23.4 65.1 68.4 83l-34.5 51.7h101.6l22-34.4c22.2 1 45.3 0 68.6-2.7l-22.8 37.1h135.5L340 406.3c18.6-5.3 36.9-11.5 54.5-18.7l45.9 71.8H542L468.6 349c18.5-12.1 35-25.5 48.9-39.8zm-187.6 80.5-25-40.6-32.7 53.3c-23.4 3.5-46.7 5.1-69.2 4.4l101.9-159.3 78.7 123c-17.2 7.4-35.3 13.9-53.7 19.2z"/></svg>
|
Before Width: | Height: | Size: 973 B After Width: | Height: | Size: 973 B |
@ -1 +1 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.1.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M152.2 236.4c-7.7-8.2-19.7-7.7-24.8 2.8L1.6 490.2c-5 10 2.4 21.7 13.4 21.7h175c5.8.1 11-3.2 13.4-8.4 37.9-77.8 15.1-196.3-51.2-267.1zM244.4 8.1c-122.3 193.4-8.5 348.6 65 495.5 2.5 5.1 7.7 8.4 13.4 8.4H497c11.2 0 18.4-11.8 13.4-21.7 0 0-234.5-470.6-240.4-482.3-5.3-10.6-18.8-10.8-25.6.1z"/></svg>
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M152.2 236.4c-7.7-8.2-19.7-7.7-24.8 2.8L1.6 490.2c-5 10 2.4 21.7 13.4 21.7h175c5.8.1 11-3.2 13.4-8.4 37.9-77.8 15.1-196.3-51.2-267.1zM244.4 8.1c-122.3 193.4-8.5 348.6 65 495.5 2.5 5.1 7.7 8.4 13.4 8.4H497c11.2 0 18.4-11.8 13.4-21.7 0 0-234.5-470.6-240.4-482.3-5.3-10.6-18.8-10.8-25.6.1z"/></svg>
|
Before Width: | Height: | Size: 576 B After Width: | Height: | Size: 576 B |