Backup current changes

This commit is contained in:
squidfunk 2021-03-21 14:04:29 +01:00
parent a070203f91
commit 185f037fbc
22 changed files with 237 additions and 221 deletions

View File

@ -23,84 +23,41 @@ In case you're running into problems, consult the [troubleshooting][4] section.
Material for MkDocs can be installed with `pip`: Material for MkDocs can be installed with `pip`:
=== "Material for MkDocs"
``` ```
pip install mkdocs-material pip install mkdocs-material
``` ```
=== "Insiders"
``` sh
pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
```
This will automatically install compatible versions of all dependencies: This will automatically install compatible versions of all dependencies:
[MkDocs][1], [Markdown][5], [Pygments][6] and [Python Markdown Extensions][7]. [MkDocs][1], [Markdown][5], [Pygments][6] and [Python Markdown Extensions][7].
Material for MkDocs always strives to support the latest versions, so there's Material for MkDocs always strives to support the latest versions, so there's
no need to install those packages separately. no need to install those packages separately.
_Note that in order to install [Insiders][8], you'll need to [become a
sponsor][9], create a personal access token[^1], and set the_ `GH_TOKEN`
_environment variable to the token's value._
[^1]:
In order to use `pip` to install from the private repository over HTTPS, the
[personal access token][14] requires the [`repo`][15] scope. The creation
and usage of an access token is only necessary when installing Insiders
over HTTPS, which is the recommended way when building from within a CI/CD
workflow, e.g. using [GitHub Pages][16] or [GitLab Pages][17].
[5]: https://python-markdown.github.io/ [5]: https://python-markdown.github.io/
[6]: https://pygments.org/ [6]: https://pygments.org/
[7]: https://facelessuser.github.io/pymdown-extensions/ [7]: https://facelessuser.github.io/pymdown-extensions/
[8]: insiders.md
[9]: insiders.md#how-to-become-a-sponsor
### with docker ### with docker
The official [Docker image][10] is a great way to get up and running in a few The official [Docker image][8] 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. Pull the image for the
`latest` version with: `latest` version with:
=== "Material for MkDocs"
``` ```
docker pull squidfunk/mkdocs-material docker pull squidfunk/mkdocs-material
``` ```
=== "Insiders"
```
docker login -u ${GH_USERNAME} -p ${GH_TOKEN} ghcr.io
docker pull ghcr.io/squidfunk/mkdocs-material-insiders
```
The `mkdocs` executable is provided as an entry point and `serve` is the The `mkdocs` executable is provided as an entry point and `serve` is the
default command. If you're not familiar with Docker don't worry, we have you default command. If you're not familiar with Docker don't worry, we have you
covered in the following sections. covered in the following sections.
The following plugins are bundled with the Docker image: The following plugins are bundled with the Docker image:
- [mkdocs-minify-plugin][11] - [mkdocs-minify-plugin][9]
- [mkdocs-redirects][12] - [mkdocs-redirects][10]
_Note that in order to install [Insiders][8], you'll need to [become a [8]: https://hub.docker.com/r/squidfunk/mkdocs-material/
sponsor][9], create a personal access token[^2], and set the_ `GH_TOKEN` [9]: https://github.com/byrnereese/mkdocs-minify-plugin
_environment variable to the token's value._ [10]: https://github.com/datarobot/mkdocs-redirects
[^2]:
If you want to use `docker` to pull the private Docker image from the
[GitHub Container Registry][18], the [personal access token][14] requires
the [`read:packages`][15] scope. Note that you need to login before pulling
the Docker image. As an example, see the [`publish`][19] workflow of the
Material for MkDocs repository. You'll also need to enable "[Improved Container Support][20]"
on your account.
[10]: https://hub.docker.com/r/squidfunk/mkdocs-material/
[11]: https://github.com/byrnereese/mkdocs-minify-plugin
[12]: https://github.com/datarobot/mkdocs-redirects
??? question "How to add plugins to the Docker image?" ??? question "How to add plugins to the Docker image?"
@ -124,22 +81,14 @@ _environment variable to the token's value._
### with git ### with git
Material for MkDocs can be directly used from [GitHub][13] by cloning the Material for MkDocs can be directly used from [GitHub][11] by cloning the
repository into a subfolder of your project root which might be useful if you repository into a subfolder of your project root which might be useful if you
want to use the very latest version: want to use the very latest version:
=== "Material for MkDocs"
``` ```
git clone https://github.com/squidfunk/mkdocs-material.git git clone https://github.com/squidfunk/mkdocs-material.git
``` ```
=== "Insiders"
```
git clone git@github.com:squidfunk/mkdocs-material-insiders.git mkdocs-material
```
The theme will reside in the folder `mkdocs-material/material`. When cloning The theme will reside in the folder `mkdocs-material/material`. When cloning
from `git`, you must install all required dependencies yourself: from `git`, you must install all required dependencies yourself:
@ -147,15 +96,4 @@ from `git`, you must install all required dependencies yourself:
pip install -r mkdocs-material/requirements.txt pip install -r mkdocs-material/requirements.txt
``` ```
_Note that in order to install [Insiders][8], you'll need to [become a [11]: https://github.com/squidfunk/mkdocs-material
sponsor][9]._
[13]: https://github.com/squidfunk/mkdocs-material
[14]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token
[15]: https://docs.github.com/en/developers/apps/scopes-for-oauth-apps#available-scopes
[16]: publishing-your-site.md#github-pages
[17]: publishing-your-site.md#gitlab-pages
[18]: https://docs.github.com/en/free-pro-team@latest/packages/getting-started-with-github-container-registry/about-github-container-registry
[19]: https://github.com/squidfunk/mkdocs-material/blob/master/.github/workflows/publish.yml
[20]: https://docs.github.com/en/free-pro-team@latest/packages/guides/enabling-improved-container-support

View File

@ -0,0 +1,173 @@
---
template: overrides/main.html
title: Getting started
---
# Getting started
Material for MkDocs is a theme for [MkDocs][1], a static site generator geared
towards (technical) project documentation. If you're familiar with Python, you
can install Material for MkDocs with [`pip`][2], the Python package manager.
If not, we recommended using [`docker`][3].
In case you're running into problems, consult the [troubleshooting][4] section.
[1]: https://www.mkdocs.org
[2]: #with-pip
[3]: #with-docker
[4]: ../troubleshooting.md
## Installation
### with pip
Material for MkDocs can be installed with `pip`:
=== "Material for MkDocs"
```
pip install mkdocs-material
```
=== "Insiders"
``` sh
pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
```
This will automatically install compatible versions of all dependencies:
[MkDocs][1], [Markdown][5], [Pygments][6] and [Python Markdown Extensions][7].
Material for MkDocs always strives to support the latest versions, so there's
no need to install those packages separately.
_Note that in order to install [Insiders][8], you'll need to [become a
sponsor][9], create a personal access token[^1], and set the_ `GH_TOKEN`
_environment variable to the token's value._
[^1]:
In order to use `pip` to install from the private repository over HTTPS, the
[personal access token][14] requires the [`repo`][15] scope. The creation
and usage of an access token is only necessary when installing Insiders
over HTTPS, which is the recommended way when building from within a CI/CD
workflow, e.g. using [GitHub Pages][16] or [GitLab Pages][17].
[5]: https://python-markdown.github.io/
[6]: https://pygments.org/
[7]: https://facelessuser.github.io/pymdown-extensions/
[8]: index.md
[9]: index.md#how-to-become-a-sponsor
### with docker
- Fork the Insiders repository to your private or organization account
- https://github.com/squidfunk/mkdocs-material-insiders/fork
- Got to Actions, and enable them
- https://github.com/stylezenbot/mkdocs-material-insiders/actions
- There are three actions (two of which can be deleted, but are no-op in forks)
- Build: the action will not be run on forks
- Documentaiton: build Insiders documentation
- publish: publish, when a new tag is pushed... (!)
- Create a token with the write_packages scope
- Set GHCR_TOKEN as a secret in settings
-
The official [Docker image][10] 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
`latest` version with:
=== "Material for MkDocs"
```
docker pull squidfunk/mkdocs-material
```
=== "Insiders"
```
docker login -u ${GH_USERNAME} -p ${GH_TOKEN} ghcr.io
docker pull ghcr.io/squidfunk/mkdocs-material-insiders
```
The `mkdocs` executable is provided as an entry point and `serve` is the
default command. If you're not familiar with Docker don't worry, we have you
covered in the following sections.
The following plugins are bundled with the Docker image:
- [mkdocs-minify-plugin][11]
- [mkdocs-redirects][12]
_Note that in order to install [Insiders][8], you'll need to [become a
sponsor][9], create a personal access token[^2], and set the_ `GH_TOKEN`
_environment variable to the token's value._
[^2]:
If you want to use `docker` to pull the private Docker image from the
[GitHub Container Registry][18], the [personal access token][14] requires
the [`read:packages`][15] scope. Note that you need to login before pulling
the Docker image. As an example, see the [`publish`][19] workflow of the
Material for MkDocs repository. You'll also need to enable "[Improved Container Support][20]"
on your account.
[10]: https://hub.docker.com/r/squidfunk/mkdocs-material/
[11]: https://github.com/byrnereese/mkdocs-minify-plugin
[12]: https://github.com/datarobot/mkdocs-redirects
??? question "How to add plugins to the Docker image?"
Material for MkDocs bundles useful and common plugins while trying not to
blow up the size of the official image. If the plugin you want to use is
not included, create a new `Dockerfile` and extend the official Docker image
with your custom installation routine:
``` Dockerfile
FROM squidfunk/mkdocs-material
RUN pip install ...
```
Next, you can build the image with the following command:
```
docker build -t squidfunk/mkdocs-material .
```
The new image can be used exactly like the official image.
### with git
Material for MkDocs can be directly used from [GitHub][13] by cloning the
repository into a subfolder of your project root which might be useful if you
want to use the very latest version:
=== "Material for MkDocs"
```
git clone https://github.com/squidfunk/mkdocs-material.git
```
=== "Insiders"
```
git clone git@github.com:squidfunk/mkdocs-material-insiders.git mkdocs-material
```
The theme will reside in the folder `mkdocs-material/material`. When cloning
from `git`, you must install all required dependencies yourself:
```
pip install -r mkdocs-material/requirements.txt
```
_Note that in order to install [Insiders][8], you'll need to [become a
sponsor][9]._
[13]: https://github.com/squidfunk/mkdocs-material
[14]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token
[15]: https://docs.github.com/en/developers/apps/scopes-for-oauth-apps#available-scopes
[16]: ../publishing-your-site.md#github-pages
[17]: ../publishing-your-site.md#gitlab-pages
[18]: https://docs.github.com/en/free-pro-team@latest/packages/getting-started-with-github-container-registry/about-github-container-registry
[19]: https://github.com/squidfunk/mkdocs-material/blob/master/.github/workflows/publish.yml
[20]: https://docs.github.com/en/free-pro-team@latest/packages/guides/enabling-improved-container-support

View File

@ -2,7 +2,7 @@
template: overrides/main.html template: overrides/main.html
--- ---
# <span hidden>Insiders</span> :logo: :material-plus: :octicons-heart-fill-24:{ .mdx-heart } # Material for MkDocs Insiders
Material for MkDocs uses the _sponsorware_ release strategy, which means Material for MkDocs uses the _sponsorware_ release strategy, which means
that _new features are first exclusively released to sponsors_ as part of that _new features are first exclusively released to sponsors_ as part of
@ -146,9 +146,9 @@ the public for general availability.
- [x] [Color palette toggle][16] - [x] [Color palette toggle][16]
- [x] [Back-to-top button][17] - [x] [Back-to-top button][17]
[15]: setup/adding-a-git-repository.md#latest-release [15]: ../setup/adding-a-git-repository.md#latest-release
[16]: setup/changing-the-colors.md#color-palette-toggle [16]: ../setup/changing-the-colors.md#color-palette-toggle
[17]: setup/setting-up-navigation.md#back-to-top-button [17]: ../setup/setting-up-navigation.md#back-to-top-button
#### $ 2,500 Biquinho Vermelho #### $ 2,500 Biquinho Vermelho
@ -156,9 +156,9 @@ the public for general availability.
- [x] [Search highlighting][19] - [x] [Search highlighting][19]
- [x] [Search sharing][20] - [x] [Search sharing][20]
[18]: setup/setting-up-site-search.md#search-suggestions [18]: ../setup/setting-up-site-search.md#search-suggestions
[19]: setup/setting-up-site-search.md#search-highlighting [19]: ../setup/setting-up-site-search.md#search-highlighting
[20]: setup/setting-up-site-search.md#search-sharing [20]: ../setup/setting-up-site-search.md#search-sharing
#### $ 3,000 Caribbean Red #### $ 3,000 Caribbean Red
@ -166,9 +166,9 @@ the public for general availability.
- [x] [Section index pages][22] - [x] [Section index pages][22]
- [x] [Remove generator notice][23] - [x] [Remove generator notice][23]
[21]: setup/setting-up-navigation.md#sticky-navigation-tabs [21]: ../setup/setting-up-navigation.md#sticky-navigation-tabs
[22]: setup/setting-up-navigation.md#section-index-pages [22]: ../setup/setting-up-navigation.md#section-index-pages
[23]: setup/setting-up-the-footer.md#remove-generator [23]: ../setup/setting-up-the-footer.md#remove-generator
#### $ 4,000 Ghost Pepper #### $ 4,000 Ghost Pepper
@ -176,8 +176,8 @@ the public for general availability.
- [x] [Code block annotations][25] - [x] [Code block annotations][25]
- [ ] Non-latest version warning - [ ] Non-latest version warning
[24]: setup/setting-up-navigation.md#anchor-tracking [24]: ../setup/setting-up-navigation.md#anchor-tracking
[25]: reference/code-blocks.md#adding-annotations [25]: ../reference/code-blocks.md#adding-annotations
#### $ 5,000 Aji Panca #### $ 5,000 Aji Panca
@ -185,7 +185,7 @@ the public for general availability.
- [ ] List of last searches - [ ] List of last searches
- [ ] Advanced routing for versioning - [ ] Advanced routing for versioning
[26]: reference/diagrams.md [26]: ../reference/diagrams.md
#### $ 6,000 Trinidad Scorpion #### $ 6,000 Trinidad Scorpion
@ -205,7 +205,7 @@ the public for general availability.
- [ ] TBA - [ ] TBA
- [ ] TBA - [ ] TBA
[27]: reference/admonitions.md#changing-the-icons [27]: ../reference/admonitions.md#changing-the-icons
#### Future #### Future
@ -231,11 +231,11 @@ the public for general availability.
- [x] [Table of contents in navigation][10] - [x] [Table of contents in navigation][10]
- [x] [Header hides on scroll][11] - [x] [Header hides on scroll][11]
[7]: setup/setting-up-navigation.md#navigation-sections [7]: ../setup/setting-up-navigation.md#navigation-sections
[8]: setup/setting-up-navigation.md#navigation-expansion [8]: ../setup/setting-up-navigation.md#navigation-expansion
[9]: setup/setting-up-navigation.md#hide-the-sidebars [9]: ../setup/setting-up-navigation.md#hide-the-sidebars
[10]: setup/setting-up-navigation.md#navigation-integration [10]: ../setup/setting-up-navigation.md#navigation-integration
[11]: setup/setting-up-the-header.md#automatic-hiding [11]: ../setup/setting-up-the-header.md#automatic-hiding
#### $ 1,500 Bhut Jolokia #### $ 1,500 Bhut Jolokia
@ -243,9 +243,9 @@ the public for general availability.
- [x] [Site language selection][13] - [x] [Site language selection][13]
- [x] [Versioning][14] - [x] [Versioning][14]
[12]: reference/admonitions.md#inline-blocks [12]: ../reference/admonitions.md#inline-blocks
[13]: setup/changing-the-language.md#site-language-selector [13]: ../setup/changing-the-language.md#site-language-selector
[14]: setup/setting-up-versioning.md#versioning [14]: ../setup/setting-up-versioning.md#versioning
## Frequently asked questions ## Frequently asked questions
@ -262,7 +262,7 @@ it can be built with Insiders (e.g. as part of GitHub Actions). Thus, it's
recommended to [install Insiders][29] only in CI, as you don't want to expose recommended to [install Insiders][29] only in CI, as you don't want to expose
your `GH_TOKEN` to users. your `GH_TOKEN` to users.
[29]: publishing-your-site.md#github-pages [29]: ../publishing-your-site.md#github-pages
### Terms ### Terms
@ -284,5 +284,5 @@ guidelines:
version__ that's available to you __as long as you like__. Just remember that version__ that's available to you __as long as you like__. Just remember that
[GitHub deletes private forks][31]. [GitHub deletes private forks][31].
[30]: license.md [30]: ../license.md
[31]: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository [31]: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository

View File

@ -80,7 +80,7 @@ using [secrets][5]._
[2]: https://github.com/features/actions [2]: https://github.com/features/actions
[3]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token [3]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token
[4]: insiders.md [4]: insiders/index.md
[5]: https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets [5]: https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets
### with MkDocs ### with MkDocs

View File

@ -445,7 +445,7 @@ a valid icon in `mkdocs.yml`:
[![Admonition with FontAwesome icons][15]][15] [![Admonition with FontAwesome icons][15]][15]
[13]: ../insiders.md [13]: ../insiders/index.md
[14]: ../assets/screenshots/admonition-octicons.png [14]: ../assets/screenshots/admonition-octicons.png
[15]: ../assets/screenshots/admonition-fontawesome.png [15]: ../assets/screenshots/admonition-fontawesome.png

View File

@ -261,7 +261,7 @@ _Annotations require syntax highlighting with [Pygments][24] they're current
not compatible with other JavaScript-based syntax highlighters. Support may be not compatible with other JavaScript-based syntax highlighters. Support may be
added later on._ added later on._
[18]: ../insiders.md [18]: ../insiders/index.md
[19]: ../assets/screenshots/annotations.png [19]: ../assets/screenshots/annotations.png
[20]: https://squidfunk.github.io/mkdocs-material-insiders/reference/code-blocks/#adding-annotations [20]: https://squidfunk.github.io/mkdocs-material-insiders/reference/code-blocks/#adding-annotations

View File

@ -57,7 +57,7 @@ ensures interoperability with all Material for MkDocs features._
in conjunction with the [mkdocs-minify-plugin][9] and doesn't adapt to in conjunction with the [mkdocs-minify-plugin][9] and doesn't adapt to
dark mode. dark mode.
[2]: ../insiders.md [2]: ../insiders/index.md
[3]: https://facelessuser.github.io/pymdown-extensions/extensions/superfences/ [3]: https://facelessuser.github.io/pymdown-extensions/extensions/superfences/
[4]: https://facelessuser.github.io/pymdown-extensions/ [4]: https://facelessuser.github.io/pymdown-extensions/
[5]: #usage [5]: #usage

View File

@ -93,7 +93,7 @@ A demo is worth a thousand words — check it out at
</figcaption> </figcaption>
</figure> </figure>
[5]: ../insiders.md [5]: ../insiders/index.md
[6]: ../assets/screenshots/repository.png [6]: ../assets/screenshots/repository.png
[7]: https://squidfunk.github.io/mkdocs-material-insiders/setup/adding-a-git-repository/ [7]: https://squidfunk.github.io/mkdocs-material-insiders/setup/adding-a-git-repository/

View File

@ -258,7 +258,7 @@ color palettes:
This field is used as the toggle's `title` attribute and should be set to a This field is used as the toggle's `title` attribute and should be set to a
discernable name to improve accessibility. discernable name to improve accessibility.
[6]: ../insiders.md [6]: ../insiders/index.md
[7]: https://squidfunk.github.io/mkdocs-material-insiders/setup/changing-the-colors [7]: https://squidfunk.github.io/mkdocs-material-insiders/setup/changing-the-colors
[8]: #color-scheme [8]: #color-scheme
[9]: #primary-color [9]: #primary-color

View File

@ -118,7 +118,7 @@ theme:
[![Without sticky tabs][11]][11] [![Without sticky tabs][11]][11]
[9]: ../insiders.md [9]: ../insiders/index.md
[10]: ../assets/screenshots/navigation-tabs-sticky.png [10]: ../assets/screenshots/navigation-tabs-sticky.png
[11]: ../assets/screenshots/navigation-tabs-collapsed.png [11]: ../assets/screenshots/navigation-tabs-collapsed.png

View File

@ -165,7 +165,7 @@ A demo is worth a thousand words — check it out at
</figcaption> </figcaption>
</figure> </figure>
[8]: ../insiders.md [8]: ../insiders/index.md
[9]: ../assets/screenshots/search-suggestions.png [9]: ../assets/screenshots/search-suggestions.png
[10]: https://squidfunk.github.io/mkdocs-material-insiders/reference/code-blocks/?q=code+high [10]: https://squidfunk.github.io/mkdocs-material-insiders/reference/code-blocks/?q=code+high

View File

@ -117,7 +117,7 @@ extra:
generator: false generator: false
``` ```
[4]: ../insiders.md [4]: ../insiders/index.md
## Customization ## Customization

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -22,7 +22,7 @@
<meta name="twitter:title" content="{{ title }}"> <meta name="twitter:title" content="{{ title }}">
<meta name="twitter:description" content="{{ config.site_description }}"> <meta name="twitter:description" content="{{ config.site_description }}">
<meta name="twitter:image" content="{{ image }}"> <meta name="twitter:image" content="{{ image }}">
<link rel="stylesheet" href="{{ 'overrides/assets/stylesheets/main.0220c4ec.min.css' | url }}"> <link rel="stylesheet" href="{{ 'overrides/assets/stylesheets/main.a40a2e23.min.css' | url }}">
{% endblock %} {% endblock %}
{% block announce %} {% block announce %}
<a href="https://twitter.com/squidfunk"> <a href="https://twitter.com/squidfunk">
@ -33,24 +33,6 @@
<strong>Twitter</strong> <strong>Twitter</strong>
</a> </a>
{% endblock %} {% endblock %}
{% block content %}
{{ super() }}
<footer class="mdx-content__footer md-typeset">
<a href="{{ 'insiders/' | url }}" title="Material for MkDocs Insiders">
<hr>
<span class="twemoji">
{% include ".icons/logo.svg" %}
</span>
<span class="twemoji">
{% include ".icons/material/plus.svg" %}
</span>
<span class="twemoji mdx-heart">
{% include ".icons/octicons/heart-fill-24.svg" %}
</span>
<hr>
</a>
</footer>
{% endblock %}
{% block scripts %} {% block scripts %}
{{ super() }} {{ super() }}
<script src="{{ 'overrides/assets/javascripts/bundle.25e8c307.min.js' | url }}"></script> <script src="{{ 'overrides/assets/javascripts/bundle.25e8c307.min.js' | url }}"></script>

View File

@ -82,7 +82,7 @@ plugins:
releases/5.md: upgrading.md #upgrading-from-3x-to-4x releases/5.md: upgrading.md #upgrading-from-3x-to-4x
releases/changelog.md: changelog.md releases/changelog.md: changelog.md
setup/adding-social-links.md: setup/setting-up-the-footer.md setup/adding-social-links.md: setup/setting-up-the-footer.md
sponsorship.md: insiders.md sponsorship.md: insiders/index.md
- minify: - minify:
minify_html: true minify_html: true
@ -152,8 +152,11 @@ nav:
- Customization: customization.md - Customization: customization.md
- Troubleshooting: troubleshooting.md - Troubleshooting: troubleshooting.md
- Data privacy: data-privacy.md - Data privacy: data-privacy.md
- Insiders: insiders.md
- License: license.md - License: license.md
- Releases:
- Changelog: changelog.md
- How to upgrade: upgrading.md
- Deprecations: deprecations.md
- Setup: - Setup:
- Changing the colors: setup/changing-the-colors.md - Changing the colors: setup/changing-the-colors.md
- Changing the fonts: setup/changing-the-fonts.md - Changing the fonts: setup/changing-the-fonts.md
@ -183,12 +186,11 @@ nav:
- MathJax: reference/mathjax.md - MathJax: reference/mathjax.md
- Meta tags: reference/meta-tags.md - Meta tags: reference/meta-tags.md
- Variables: reference/variables.md - Variables: reference/variables.md
- Changelog: - Insiders:
- Material for MkDocs: changelog.md - Sponsorware: insiders/index.md
- Material for MkDocs Insiders: changelog/insiders.md - Getting started:
- Guides: - Installation: insiders/getting-started.md
- Upgrading: upgrading.md - Changelog: insiders/changelog.md
- Deprecations: deprecations.md
# Google Analytics # Google Analytics
google_analytics: google_analytics:

View File

@ -39,7 +39,6 @@
@import "main/typeset"; @import "main/typeset";
@import "main/layout/announce"; @import "main/layout/announce";
@import "main/layout/content";
@import "main/layout/hero"; @import "main/layout/hero";
@import "main/layout/iconsearch"; @import "main/layout/iconsearch";
@import "main/layout/sponsorship"; @import "main/layout/sponsorship";

View File

@ -1,56 +0,0 @@
////
/// Copyright (c) 2016-2021 Martin Donath <martin.donath@squidfunk.com>
///
/// Permission is hereby granted, free of charge, to any person obtaining a
/// copy of this software and associated documentation files (the "Software"),
/// to deal in the Software without restriction, including without limitation
/// the rights to use, copy, modify, merge, publish, distribute, sublicense,
/// and/or sell copies of the Software, and to permit persons to whom the
/// Software is furnished to do so, subject to the following conditions:
///
/// The above copyright notice and this permission notice shall be included in
/// all copies or substantial portions of the Software.
///
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
/// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
/// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
/// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
/// DEALINGS
////
// ----------------------------------------------------------------------------
// Rules
// ----------------------------------------------------------------------------
// Content footer
.mdx-content__footer {
margin-top: px2rem(20px);
text-align: center;
// Link to Insiders
a {
display: inline-block;
color: $clr-pink-500;
transition:
transform 250ms cubic-bezier(0.1, 0.7, 0.1, 1),
color 125ms;
// Link to Insiders on focus/hover
&:focus,
&:hover {
transform: scale(1.2);
}
}
// Horizontal separator
hr {
display: inline-block;
width: px2rem(40px);
margin: px2em(16px);
vertical-align: middle;
background-color: currentColor;
border: none;
}
}

View File

@ -70,28 +70,6 @@
</a> </a>
{% endblock %} {% endblock %}
<!-- Content -->
{% block content %}
{{ super() }}
<!-- Content footer -->
<footer class="mdx-content__footer md-typeset">
<a href="{{ 'insiders/' | url }}" title="Material for MkDocs Insiders">
<hr />
<span class="twemoji">
{% include ".icons/logo.svg" %}
</span>
<span class="twemoji">
{% include ".icons/material/plus.svg" %}
</span>
<span class="twemoji mdx-heart">
{% include ".icons/octicons/heart-fill-24.svg" %}
</span>
<hr />
</a>
</footer>
{% endblock %}
<!-- Theme-related JavaScript --> <!-- Theme-related JavaScript -->
{% block scripts %} {% block scripts %}
{{ super() }} {{ super() }}