Merge branch 'master' into refactor/dark-mode
33
.env
@@ -1,33 +0,0 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Copyright (c) 2016-2020 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
|
||||
# IN THE SOFTWARE.
|
||||
|
||||
# Setup virtual environment
|
||||
if [ ! -d venv ]; then
|
||||
echo "Setting up virtual environment"
|
||||
virtualenv venv
|
||||
fi
|
||||
|
||||
# Activate virtual environment
|
||||
if [ -f venv/bin/activate ]; then
|
||||
echo "Activating virtual environment"
|
||||
source venv/bin/activate
|
||||
fi
|
||||
2
.gitattributes
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
# Enforce Unix newlines
|
||||
* text=auto eol=lf
|
||||
7
.github/ISSUE_TEMPLATE/bug.md
vendored
@@ -1,10 +1,9 @@
|
||||
---
|
||||
name: Bug
|
||||
about: Report a bug
|
||||
title:
|
||||
labels:
|
||||
assignees:
|
||||
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
<!--
|
||||
|
||||
7
.github/ISSUE_TEMPLATE/feature.md
vendored
@@ -1,10 +1,9 @@
|
||||
---
|
||||
name: Feature
|
||||
about: Suggest an idea
|
||||
title:
|
||||
labels:
|
||||
assignees:
|
||||
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
<!--
|
||||
|
||||
7
.github/ISSUE_TEMPLATE/question.md
vendored
@@ -1,10 +1,9 @@
|
||||
---
|
||||
name: Question
|
||||
about: The issue tracker is not for questions. Please ask your question on StackOverflow.
|
||||
title:
|
||||
labels:
|
||||
assignees:
|
||||
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
__THE ISSUE TRACKER IS NOT FOR QUESTIONS.__
|
||||
|
||||
20
.github/ISSUE_TEMPLATE/translate.md
vendored
@@ -1,37 +1,43 @@
|
||||
---
|
||||
name: Translate
|
||||
about: Help translate Material into more languages
|
||||
title: New translation: {Insert language}
|
||||
about: 'Help translate Material into more languages '
|
||||
title: 'New translation: {Insert language}'
|
||||
labels: enhancement
|
||||
assignees:
|
||||
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## Instructions
|
||||
|
||||
1. Check, if your language is already available: [here](http://bit.ly/2DCzaL0)
|
||||
1. Check, if your language is already available: [here](https://bit.ly/3c2ox0C)
|
||||
2. If it isn't, please translate the labels on the right:
|
||||
|
||||
``` jinja
|
||||
{% macro t(key) %}{{ {
|
||||
"language": "en",
|
||||
"direction": "ltr",
|
||||
"clipboard.copy": "Copy to clipboard",
|
||||
"clipboard.copied": "Copied to clipboard",
|
||||
"edit.link.title": "Edit this page",
|
||||
"footer.previous": "Previous",
|
||||
"footer.next": "Next",
|
||||
"footer.title": "Footer",
|
||||
"header.title": "Header",
|
||||
"meta.comments": "Comments",
|
||||
"meta.source": "Source",
|
||||
"search.language": "en",
|
||||
"nav.title": "Navigation",
|
||||
"search.config.lang": "en",
|
||||
"search.config.pipeline": "trimmer, stopWordFilter",
|
||||
"search.config.separator": "[\s\-]+",
|
||||
"search.placeholder": "Search",
|
||||
"search.reset": "Clear",
|
||||
"search.result.placeholder": "Type to start searching",
|
||||
"search.result.none": "No matching documents",
|
||||
"search.result.one": "1 matching document",
|
||||
"search.result.other": "# matching documents",
|
||||
"search.tokenizer": "[\s\-]+",
|
||||
"skip.link.title": "Skip to content",
|
||||
"source.link.title": "Go to repository",
|
||||
"source.revision.date": "Last update",
|
||||
"tabs.title": "Tabs",
|
||||
"toc.title": "Table of contents"
|
||||
}[key] }}{% endmacro %}
|
||||
```
|
||||
|
||||
BIN
.github/assets/logo.png
vendored
Normal file
|
After Width: | Height: | Size: 15 KiB |
BIN
.github/assets/screenshot.png
vendored
Normal file
|
After Width: | Height: | Size: 132 KiB |
47
.github/workflows/ci.yml
vendored
@@ -23,6 +23,12 @@ on:
|
||||
- push
|
||||
- pull_request
|
||||
|
||||
# Environment
|
||||
env:
|
||||
CI: true
|
||||
NODE_VERSION: 10.x
|
||||
PYTHON_VERSION: 3.x
|
||||
|
||||
# Jobs to run
|
||||
jobs:
|
||||
|
||||
@@ -37,13 +43,13 @@ jobs:
|
||||
# Install Node runtime and dependencies
|
||||
- uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: 10.x
|
||||
node-version: ${{ env.NODE_VERSION }}
|
||||
|
||||
- uses: actions/cache@v1
|
||||
id: cache-node
|
||||
with:
|
||||
path: node_modules
|
||||
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
|
||||
key: ${{ runner.os }}-node-${{ env.NODE_VERSION }}-${{ hashFiles('**/package-lock.json') }}
|
||||
|
||||
- if: steps.cache-node.outputs.cache-hit != 'true'
|
||||
run: npm install
|
||||
@@ -69,13 +75,13 @@ jobs:
|
||||
# Install Python runtime and dependencies
|
||||
- uses: actions/setup-python@v1
|
||||
with:
|
||||
python-version: 3.x
|
||||
python-version: ${{ env.PYTHON_VERSION }}
|
||||
|
||||
# - uses: actions/cache@v1
|
||||
# id: cache-python
|
||||
# with:
|
||||
# path: ~/.cache/pip
|
||||
# key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
|
||||
# key: ${{ runner.os }}-pip-${{ env.PYTHON_VERSION }}-${{ hashFiles('**/requirements.txt') }}
|
||||
|
||||
# - if: steps.cache-python.outputs.cache-hit != 'true'
|
||||
- run: pip install -r requirements.txt
|
||||
@@ -118,13 +124,13 @@ jobs:
|
||||
# Install Node runtime and dependencies
|
||||
- uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: 10.x
|
||||
node-version: ${{ env.NODE_VERSION }}
|
||||
|
||||
- uses: actions/cache@v1
|
||||
id: cache-node
|
||||
with:
|
||||
path: node_modules
|
||||
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
|
||||
key: ${{ runner.os }}-node-${{ env.NODE_VERSION }}-${{ hashFiles('**/package-lock.json') }}
|
||||
|
||||
- if: steps.cache-node.outputs.cache-hit != 'true'
|
||||
run: npm install
|
||||
@@ -135,15 +141,14 @@ jobs:
|
||||
# Install Python runtime and dependencies
|
||||
- uses: actions/setup-python@v1
|
||||
with:
|
||||
python-version: 3.x
|
||||
python-version: ${{ env.PYTHON_VERSION }}
|
||||
|
||||
- run: pip install --upgrade setuptools wheel twine
|
||||
|
||||
# # Build and test Docker image
|
||||
# - run: |
|
||||
# docker build -t ${GITHUB_REPOSITORY} .
|
||||
# docker run --rm -i -v $(pwd):/docs ${GITHUB_REPOSITORY} \
|
||||
# build --theme material
|
||||
# Build and test Docker image
|
||||
- run: |
|
||||
docker build -t ${GITHUB_REPOSITORY} .
|
||||
docker run --rm -i -v $(pwd):/docs ${GITHUB_REPOSITORY} build
|
||||
|
||||
# Build Python package
|
||||
- run: python setup.py build sdist bdist_wheel --universal
|
||||
@@ -154,12 +159,12 @@ jobs:
|
||||
PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
|
||||
run: twine upload -u ${PYPI_USERNAME} -p ${PYPI_PASSWORD} dist/*
|
||||
|
||||
# # Push image to Docker Hub
|
||||
# - env:
|
||||
# DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
|
||||
# DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
|
||||
# run: |
|
||||
# docker login -u ${DOCKER_USERNAME} -p ${DOCKER_PASSWORD}
|
||||
# docker tag ${GITHUB_REPOSITORY} ${GITHUB_REPOSITORY}:${GITHUB_REF##*/}
|
||||
# docker tag ${GITHUB_REPOSITORY} ${GITHUB_REPOSITORY}:latest
|
||||
# docker push ${GITHUB_REPOSITORY}
|
||||
# Push image to Docker Hub
|
||||
- env:
|
||||
DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
|
||||
DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
|
||||
run: |
|
||||
docker login -u ${DOCKER_USERNAME} -p ${DOCKER_PASSWORD}
|
||||
docker tag ${GITHUB_REPOSITORY} ${GITHUB_REPOSITORY}:${GITHUB_REF##*/}
|
||||
docker tag ${GITHUB_REPOSITORY} ${GITHUB_REPOSITORY}:latest
|
||||
docker push ${GITHUB_REPOSITORY}
|
||||
|
||||
@@ -21,6 +21,7 @@
|
||||
# Distribution files
|
||||
docs
|
||||
material
|
||||
src/**/*.html
|
||||
|
||||
# Don't lint shame
|
||||
src/assets/stylesheets/_shame.scss
|
||||
|
||||
51
CHANGELOG
@@ -1,14 +1,53 @@
|
||||
mkdocs-material 4.6.3 (2020-02-14)
|
||||
mkdocs-material-5.1.1 (2020-04-17)
|
||||
|
||||
* Added new FontAwesome icons
|
||||
* Fixed #1609: Instant loading doesn't honor target=_blank
|
||||
* Fixed GitHub stars count rounding errors
|
||||
* Fixed GitLab stars count retrieval
|
||||
|
||||
mkdocs-material-5.1.0 (2020-04-12)
|
||||
|
||||
* Added support for icons from Markdown through mkdocs-material-extensions
|
||||
|
||||
mkdocs-material-5.0.2 (2020-04-10)
|
||||
|
||||
* Added CSS source maps to distribution files
|
||||
* Fixed errors in Chinese (Traditional) translations
|
||||
* Fixed creation of stale directory on installation from git
|
||||
* Improved overflow scrolling behavior on iOS (reduced bundle size by 4kb)
|
||||
|
||||
mkdocs-material-5.0.1 (2020-04-07)
|
||||
|
||||
* Fixed syntax error in Spanish translations
|
||||
|
||||
mkdocs-material-5.0.0 (2020-04-07)
|
||||
|
||||
* Reactive architecture – try app.dialog$.next("Hi!") in the console
|
||||
* Instant loading – make Material behave like a Single Page Application
|
||||
* Improved CSS customization with CSS variables – set your brand's colors
|
||||
* Improved CSS resilience, e.g. proper sidebar locking for customized headers
|
||||
* Improved icon integration and configuration – now including over 5k icons
|
||||
* Added possibility to use any icon for logo, repository and social links
|
||||
* Search UI does not freeze anymore (moved to web worker)
|
||||
* Search index built only once when using instant loading
|
||||
* Improved extensible keyboard handling
|
||||
* Support for prebuilt search indexes
|
||||
* Support for displaying stars and forks for GitLab repositories
|
||||
* Support for scroll snapping of sidebars and search results
|
||||
* Reduced HTML and CSS footprint due to deprecation of IE support
|
||||
* Slight facelifting of some UI elements (Admonitions, tables, ...)
|
||||
|
||||
mkdocs-material-4.6.3 (2020-02-14)
|
||||
|
||||
* Removed optional third-party plugins from requirements.txt
|
||||
* Updated Docker image to contain all supported third-party plugins
|
||||
|
||||
mkdocs-material 4.6.2 (2020-02-08)
|
||||
mkdocs-material-4.6.2 (2020-02-08)
|
||||
|
||||
* Added Romanian translations
|
||||
* Fixed #1451: Inconsistent spacing for fenced code blocks
|
||||
|
||||
mkdocs-material 4.6.1 (2020-02-08)
|
||||
mkdocs-material-4.6.1 (2020-02-08)
|
||||
|
||||
* Fixed #1324: Metadata author only rendering first character
|
||||
* Fixed #1393: Set tabindex to 0 for skip to content link
|
||||
@@ -16,7 +55,7 @@ mkdocs-material 4.6.1 (2020-02-08)
|
||||
* Fixed errors in Japanese translations
|
||||
* Improved Google Lighthouse score
|
||||
|
||||
mkdocs-material 4.6.0 (2019-12-11)
|
||||
mkdocs-material-4.6.0 (2019-12-11)
|
||||
|
||||
* Added support for mkdocs-git-revision-date-localized-plugin
|
||||
* Fixed invalid character in Google Fonts URL
|
||||
@@ -171,7 +210,7 @@ mkdocs-material-2.9.2 (2018-06-29)
|
||||
mkdocs-material-2.9.1 (2018-06-18)
|
||||
|
||||
* Added support for different spellings for theme color
|
||||
* Fixed #799: Added support for web font minification in production
|
||||
* Fixed #799: Added support for webfont minification in production
|
||||
* Fixed #800: Added .highlighttable as an alias for .codehilitetable
|
||||
|
||||
mkdocs-material-2.9.0 (2018-06-13)
|
||||
@@ -540,7 +579,7 @@ mkdocs-material-1.5.2 (2017-04-05)
|
||||
|
||||
mkdocs-material-1.5.1 (2017-03-30)
|
||||
|
||||
* Fixed rendering and offset of targetted footnotes
|
||||
* Fixed rendering and offset of targeted footnotes
|
||||
* Fixed #238: Link on logo is not set to site_url
|
||||
|
||||
mkdocs-material-1.5.0 (2017-03-24)
|
||||
|
||||
@@ -37,11 +37,13 @@ RUN \
|
||||
git \
|
||||
git-fast-import \
|
||||
openssh \
|
||||
&& apk add --no-cache --virtual .build gcc musl-dev \
|
||||
&& pip install --no-cache-dir . \
|
||||
&& pip install --no-cache-dir \
|
||||
'mkdocs-minify-plugin>=0.2' \
|
||||
'mkdocs-git-revision-date-localized-plugin>=0.4' \
|
||||
'mkdocs-awesome-pages-plugin>=2.2.1' \
|
||||
&& apk del .build gcc musl-dev \
|
||||
&& rm -rf /tmp/*
|
||||
|
||||
# Set working directory
|
||||
|
||||
153
README.md
@@ -1,34 +1,101 @@
|
||||
[![Github Action][action-image]][action-link]
|
||||
[![Downloads][downloads-image]][downloads-link]
|
||||
[![Gitter][gitter-image]][gitter-link]
|
||||
[![PyPI][pypi-image]][pypi-link]
|
||||
[![dependabot][dependabot-image]][dependabot-link]
|
||||
<p align="center">
|
||||
<a href="https://squidfunk.github.io/mkdocs-material">
|
||||
<img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/logo.png" width="320" alt="Material for MkDocs">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
[action-image]: https://github.com/squidfunk/mkdocs-material/workflows/ci/badge.svg?branch=master
|
||||
[action-link]: https://github.com/squidfunk/mkdocs-material/actions
|
||||
[downloads-image]: https://img.shields.io/pypi/dm/mkdocs-material.svg
|
||||
[downloads-link]: https://pypistats.org/packages/mkdocs-material
|
||||
[gitter-image]: https://badges.gitter.im/squidfunk/mkdocs-material.svg
|
||||
[gitter-link]: https://gitter.im/squidfunk/mkdocs-material
|
||||
[pypi-image]: https://img.shields.io/pypi/v/mkdocs-material.svg
|
||||
[pypi-link]: https://pypi.python.org/pypi/mkdocs-material
|
||||
[dependabot-image]: https://img.shields.io/badge/dependabot-enabled-06f.svg
|
||||
[dependabot-link]: https://dependabot.com
|
||||
<p align="center">
|
||||
<strong>
|
||||
A
|
||||
<a href="https://material.io/">Material Design</a>
|
||||
theme for
|
||||
<a href="https://www.mkdocs.org/">MkDocs</a>
|
||||
</strong>
|
||||
</p>
|
||||
|
||||
# Material for MkDocs
|
||||
<p align="center">
|
||||
<a href="https://github.com/squidfunk/mkdocs-material/actions"><img
|
||||
src="https://github.com/squidfunk/mkdocs-material/workflows/ci/badge.svg?branch=master"
|
||||
alt="GitHub Action"
|
||||
/></a>
|
||||
<a href="https://pypistats.org/packages/mkdocs-material"><img
|
||||
src="https://img.shields.io/pypi/dm/mkdocs-material.svg"
|
||||
alt="Downloads"
|
||||
/></a>
|
||||
<a href="https://gitter.im/squidfunk/mkdocs-material"><img
|
||||
src="https://badges.gitter.im/squidfunk/mkdocs-material.svg"
|
||||
alt="Chat on Gitter"
|
||||
/></a>
|
||||
<a href="https://pypi.org/project/mkdocs-material"><img
|
||||
src="https://img.shields.io/pypi/v/mkdocs-material.svg"
|
||||
alt="Python Package Index"
|
||||
/></a>
|
||||
<a href="https://amzn.to/353WRpj"><img
|
||||
src="https://img.shields.io/static/v1?label=amazon&message=wish%20list&color=orange"
|
||||
/></a>
|
||||
</p>
|
||||
|
||||
> ⚠️ __Help test [Material 5](https://github.com/squidfunk/mkdocs-material/issues/1498)!__
|
||||
<p align="center">
|
||||
Create a branded static site from a set of Markdown files to host the
|
||||
documentation of your Open Source or commercial project – customizable,
|
||||
searchable, mobile-friendly, 40+ languages. Set up in 5 minutes.
|
||||
</p>
|
||||
|
||||
A Material Design theme for [MkDocs][1].
|
||||
<p align="center">
|
||||
<a href="https://squidfunk.github.io/mkdocs-material/getting-started/">
|
||||
<img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/screenshot.png" width=700 />
|
||||
</a>
|
||||
</p>
|
||||
|
||||
[][2]
|
||||
<p align="center">
|
||||
<em>
|
||||
A demo is worth a thousand words — check it out at
|
||||
<a
|
||||
href="https://squidfunk.github.io/mkdocs-material/"
|
||||
>squidfunk.github.io/mkdocs-material</a>.
|
||||
</em>
|
||||
</p>
|
||||
|
||||
[1]: https://www.mkdocs.org
|
||||
[2]: https://squidfunk.github.io/mkdocs-material/
|
||||
## Features
|
||||
|
||||
* **It's just Markdown** — write your technical documentation in plain Markdown
|
||||
– no need to know HTML, JavaScript, or CSS. Material for MkDocs will do the
|
||||
heavy lifting and convert your writing to a beautiful and functional website.
|
||||
|
||||
* **Responsive by design** — built from the ground up to work on all sorts of
|
||||
devices – from mobile phones to widescreens. The underlying fluid layout will
|
||||
always adapt perfectly to the available screen space.
|
||||
|
||||
* **Static, yet searchable** — almost magically, your technical documentation
|
||||
website will be searchable without any further ado. Material for MkDocs comes
|
||||
with built-in search – no server needed – that will instantly answer your
|
||||
users' queries.
|
||||
|
||||
* **Many configuration options** — change the color palette, font families,
|
||||
language, icons, favicon and logo. Add a source repository link, links to your
|
||||
social profiles, Google Analytics and Disqus - all with a few lines of code.
|
||||
|
||||
* **Truly international** — thanks to many contributors, Material for MkDocs
|
||||
includes translations for more than 40 languages and offers full native RTL
|
||||
(right-to-left) support for languages such as Arabic, Persian (Farsi) and
|
||||
Hebrew.
|
||||
|
||||
* **Accessible** — Material for MkDocs provides extensible keyboard navigation
|
||||
and semantic markup including role attributes and landmarks. Furthermore, the
|
||||
layout is entirely based on `rem` values, respecting the user's default font
|
||||
size.
|
||||
|
||||
* **Beyond GitHub Markdown** — integrates natively with Python Markdown
|
||||
Extensions, offering additional elements like callouts, tabbed content
|
||||
containers, mathematical formulas, critic markup, task lists, and emojis.
|
||||
|
||||
* **Modern architecture** — Material for MkDocs's underlying codebase is built
|
||||
with TypeScript, RxJS, and SCSS, and is compiled with Webpack, bringing
|
||||
excellent possibilities for theme extension and customization.
|
||||
|
||||
## Quick start
|
||||
|
||||
Install the latest version of Material with `pip`:
|
||||
Material for MkDocs can be installed with `pip`:
|
||||
|
||||
``` sh
|
||||
pip install mkdocs-material
|
||||
@@ -41,29 +108,33 @@ theme:
|
||||
name: material
|
||||
```
|
||||
|
||||
## What to expect
|
||||
For other installation methods, configuration options, and a demo, visit
|
||||
[squidfunk.github.io/mkdocs-material][1]
|
||||
|
||||
* Responsive design and fluid layout for all kinds of screens and devices,
|
||||
designed to serve your project documentation in a user-friendly way in 41
|
||||
languages with optimal readability.
|
||||
[1]: https://squidfunk.github.io/mkdocs-material/
|
||||
|
||||
* Easily customizable primary and accent color, fonts, favicon and logo;
|
||||
straight forward localization through theme extension; integrated with Google
|
||||
Analytics, Disqus and GitHub.
|
||||
## Users
|
||||
|
||||
* Well-designed search interface accessible through hotkeys (<kbd>F</kbd> or
|
||||
<kbd>S</kbd>), intelligent grouping of search results, search term
|
||||
highlighting and lazy loading.
|
||||
* **Companies** —
|
||||
[AWS](https://awssecworkshops.com/),
|
||||
[ING](https://ing-bank.github.io/baker/),
|
||||
[Lyft](https://lyft.github.io/amundsen/),
|
||||
[Netflix](https://netflix.github.io/titus/),
|
||||
[Uber](https://uber.github.io/ludwig/getting_started/),
|
||||
[SAP](https://sap.github.io/ui5-tooling/),
|
||||
[Spotify](https://spotify.github.io/mkdocs-monorepo-plugin/),
|
||||
[Square](https://square.github.io/okhttp/),
|
||||
[Zalando](https://opensource.zalando.com/skipper/)
|
||||
|
||||
For detailed installation instructions and a demo, visit
|
||||
https://squidfunk.github.io/mkdocs-material/
|
||||
|
||||
## Support
|
||||
|
||||
If you're happy with Material for MkDocs and feel like giving something back,
|
||||
you may check out squidfunk's [Amazon wish list][3].
|
||||
|
||||
[3]: https://amzn.to/353WRpj
|
||||
* **Open Source** —
|
||||
[AutoKeras](https://autokeras.com/),
|
||||
[FastAPI](https://fastapi.tiangolo.com/),
|
||||
[OpenFaaS](https://docs.openfaas.com/),
|
||||
[Pi-Hole](https://docs.pi-hole.net/),
|
||||
[Pydantic](https://pydantic-docs.helpmanual.io/),
|
||||
[Traefik](https://docs.traefik.io/),
|
||||
[Vapor](https://docs.vapor.codes/),
|
||||
[ZeroNet](https://zeronet.io/docs/)
|
||||
|
||||
## License
|
||||
|
||||
|
||||
|
Before Width: | Height: | Size: 2.2 KiB After Width: | Height: | Size: 1.9 KiB |
BIN
docs/assets/images/banner.png
Normal file
|
After Width: | Height: | Size: 144 KiB |
BIN
docs/assets/images/illustration.png
Normal file
|
After Width: | Height: | Size: 193 KiB |
|
Before Width: | Height: | Size: 291 KiB |
@@ -1 +1,5 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
--8<-- "CONTRIBUTING.md"
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Customization
|
||||
|
||||
## A great starting point
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Data privacy
|
||||
|
||||
In itself, Material for MkDocs does not perform any tracking and should adhere
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Admonition
|
||||
|
||||
[Admonition][1] is an extension included in the standard Markdown library that
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# CodeHilite
|
||||
|
||||
[CodeHilite][1] is an extension that adds syntax highlighting to code blocks
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Footnotes
|
||||
|
||||
[Footnotes][1] is another extension included in the standard Markdown library.
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
hero: Set heroes with metadata
|
||||
path: tree/master/docs/extensions
|
||||
source: metadata.md
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Permalinks
|
||||
|
||||
Permalinks are a feature of the [Table of Contents][1] extension, which is part
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# PyMdown Extensions
|
||||
|
||||
[PyMdown Extensions][1] is a collection of Markdown extensions that add some
|
||||
@@ -20,8 +24,8 @@ markdown_extensions:
|
||||
- pymdownx.critic
|
||||
- pymdownx.details
|
||||
- pymdownx.emoji:
|
||||
emoji_index: !!python/name:pymdownx.emoji.twemoji
|
||||
emoji_generator: !!python/name:pymdownx.emoji.to_svg
|
||||
emoji_index: !!python/name:materialx.emoji.twemoji
|
||||
emoji_generator: !!python/name:materialx.emoji.to_svg
|
||||
- pymdownx.inlinehilite
|
||||
- pymdownx.magiclink
|
||||
- pymdownx.mark
|
||||
@@ -182,7 +186,7 @@ By default, [Emoji][13] uses JoyPixles' emoji under the former name EmojiOne.
|
||||
Recent versions of the extension lock support to an older version (2.2.7) due
|
||||
to JoyPixels' newer, less permissible licenses included in later releases. This
|
||||
restricts support to Unicode 9. To get the latest support for the current
|
||||
Unicode version, you can use Twemoji instead which has a much more permissable
|
||||
Unicode version, you can use Twemoji instead which has a much more permissible
|
||||
license. Simply override the default emoji index being used:
|
||||
|
||||
``` yaml
|
||||
@@ -204,61 +208,94 @@ index.
|
||||
from either provider, please read their licenses to ensure proper
|
||||
attribution: [EmojiOne][17] or [Twemoji][14].
|
||||
|
||||
### Icons :hatching_chick:
|
||||
|
||||
In addition, you can embed the Material Design icons, Fontawesome icons and
|
||||
GitHub's Octicons directly from Markdown by using [Material for MkDocs's custom
|
||||
emoji index][19]. It extends the Twemoji index with new short names that access
|
||||
any of the included icons. To use the custom index, you need to use
|
||||
`materialx.emoji` instead of `pymdownx.emoji`:
|
||||
|
||||
``` yaml
|
||||
markdown_extensions:
|
||||
- pymdownx.emoji:
|
||||
emoji_index: !!python/name:materialx.emoji.twemoji
|
||||
emoji_generator: !!python/name:materialx.emoji.to_svg
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
``` markdown
|
||||
* :material-account-circle: – we can use Material Design icons
|
||||
* :fontawesome-regular-laugh-wink: – we can also use FontAwesome icons
|
||||
* :octicons-octoface: – that's not all, we can also use GitHub's Octicons
|
||||
```
|
||||
|
||||
Result:
|
||||
|
||||
* :material-account-circle: – we can use [Material Design icons][20]
|
||||
* :fontawesome-regular-laugh-wink: – we can also use [FontAwesome icons][21]
|
||||
* :octicons-octoface: – that's not all, we can also use [GitHub's Octicons][22]
|
||||
|
||||
[13]: https://facelessuser.github.io/pymdown-extensions/extensions/emoji/
|
||||
[14]: https://twemoji.twitter.com/
|
||||
[15]: https://www.joypixels.com/
|
||||
[16]: https://creativecommons.org/licenses/by/4.0/legalcode
|
||||
[17]: https://github.com/joypixels/emojione#emojione-version-2
|
||||
[18]: https://facelessuser.github.io/pymdown-extensions/extensions/emoji/#default-emoji-indexes
|
||||
[19]: https://github.com/facelessuser/mkdocs-material-extensions
|
||||
[20]: https://material.io/resources/icons/
|
||||
[21]: https://fontawesome.com/icons?d=gallery&m=free
|
||||
[22]: https://octicons.github.com/
|
||||
|
||||
### InlineHilite
|
||||
|
||||
[InlineHilite][19] adds support for inline code highlighting. It's useful for
|
||||
[InlineHilite][23] adds support for inline code highlighting. It's useful for
|
||||
short snippets included within body copy, e.g. `#!js var test = 0;` and can be
|
||||
activated by prefixing inline code with a shebang and language identifier,
|
||||
e.g. `#!js`.
|
||||
|
||||
[19]: https://facelessuser.github.io/pymdown-extensions/extensions/inlinehilite/
|
||||
[23]: https://facelessuser.github.io/pymdown-extensions/extensions/inlinehilite/
|
||||
|
||||
### MagicLink
|
||||
|
||||
[MagicLink][20] detects links in Markdown and auto-generates the necessary
|
||||
[MagicLink][24] detects links in Markdown and auto-generates the necessary
|
||||
markup, so no special syntax is required. It auto-links `http[s]://` and
|
||||
`ftp://` links, as well as references to email addresses.
|
||||
|
||||
[20]: https://facelessuser.github.io/pymdown-extensions/extensions/magiclink/
|
||||
[24]: https://facelessuser.github.io/pymdown-extensions/extensions/magiclink/
|
||||
|
||||
### Mark
|
||||
|
||||
[Mark][21] adds the ability to ==highlight text== like it was marked with a
|
||||
[Mark][25] adds the ability to ==highlight text== like it was marked with a
|
||||
==text marker==. The portion of text that should be highlighted must be
|
||||
enclosed in two equal signs `==...==`.
|
||||
|
||||
[21]: https://facelessuser.github.io/pymdown-extensions/extensions/mark/
|
||||
[25]: https://facelessuser.github.io/pymdown-extensions/extensions/mark/
|
||||
|
||||
### SmartSymbols
|
||||
|
||||
[SmartSymbols][22] converts markup for special characters into their
|
||||
[SmartSymbols][26] converts markup for special characters into their
|
||||
corresponding symbols, e.g. arrows (<--, -->, <-->), trademark and copyright
|
||||
symbols ((c), (tm), (r)) and fractions (1/2, 1/4, ...).
|
||||
|
||||
[22]: https://facelessuser.github.io/pymdown-extensions/extensions/smartsymbols/
|
||||
[26]: https://facelessuser.github.io/pymdown-extensions/extensions/smartsymbols/
|
||||
|
||||
### SuperFences
|
||||
|
||||
[SuperFences][23] provides the ability to nest code blocks under blockquotes,
|
||||
lists and other block elements, which the [Fenced Code Blocks][24] extension
|
||||
[SuperFences][27] provides the ability to nest code blocks under blockquotes,
|
||||
lists and other block elements, which the [Fenced Code Blocks][28] extension
|
||||
from the standard Markdown library doesn't parse correctly.
|
||||
|
||||
SuperFences does also allow [grouping code blocks with tabs][25].
|
||||
SuperFences does also allow [grouping code blocks with tabs][29].
|
||||
|
||||
[23]: https://facelessuser.github.io/pymdown-extensions/extensions/superfences/
|
||||
[24]: https://python-markdown.github.io/extensions/fenced_code_blocks/
|
||||
[25]: codehilite.md#grouping-code-blocks
|
||||
[27]: https://facelessuser.github.io/pymdown-extensions/extensions/superfences/
|
||||
[28]: https://python-markdown.github.io/extensions/fenced_code_blocks/
|
||||
[29]: codehilite.md#grouping-code-blocks
|
||||
|
||||
### Tabbed
|
||||
|
||||
[Tabbed][26] adds support for creating tabbed groups of Markdown content.
|
||||
[Tabbed][30] adds support for creating tabbed groups of Markdown content.
|
||||
|
||||
Example:
|
||||
|
||||
@@ -290,11 +327,11 @@ Result:
|
||||
:banana: Banana | Yellow
|
||||
:kiwi: Kiwi | Green
|
||||
|
||||
[26]: https://facelessuser.github.io/pymdown-extensions/extensions/superfences/
|
||||
[30]: https://facelessuser.github.io/pymdown-extensions/extensions/superfences/
|
||||
|
||||
### Tasklist
|
||||
|
||||
[Tasklist][27] adds support for styled checkbox lists. This is useful for
|
||||
[Tasklist][31] adds support for styled checkbox lists. This is useful for
|
||||
keeping track of tasks and showing what has been done and has yet to be done.
|
||||
Checkbox lists are like regular lists, but prefixed with `[ ]` for empty or
|
||||
`[x]` for filled checkboxes.
|
||||
@@ -327,12 +364,12 @@ Result:
|
||||
* [ ] Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque
|
||||
* [ ] Nulla vel eros venenatis, imperdiet enim id, faucibus nisi
|
||||
|
||||
[27]: https://facelessuser.github.io/pymdown-extensions/extensions/tasklist/
|
||||
[31]: https://facelessuser.github.io/pymdown-extensions/extensions/tasklist/
|
||||
|
||||
### Tilde
|
||||
|
||||
[Tilde][28] provides an easy way to ~~strike through~~ cross out text.
|
||||
[Tilde][32] provides an easy way to ~~strike through~~ cross out text.
|
||||
The portion of text that should be erased must be enclosed in two tildes
|
||||
`~~...~~` and the extension will take care of the rest.
|
||||
|
||||
[28]: https://facelessuser.github.io/pymdown-extensions/extensions/tilde/
|
||||
[32]: https://facelessuser.github.io/pymdown-extensions/extensions/tilde/
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Getting started
|
||||
|
||||
## Installation
|
||||
@@ -10,8 +14,6 @@ the [official Docker image][1].
|
||||
|
||||
### with pip <small>recommended</small>
|
||||
|
||||
> All operating systems
|
||||
|
||||
Material for MkDocs can be installed with `pip`:
|
||||
|
||||
``` sh
|
||||
@@ -26,8 +28,8 @@ those packages separately.
|
||||
!!! tip "Installation in a virtual environment"
|
||||
|
||||
The best way to make sure that you end up with the correct versions and
|
||||
without any incompatibility problems between packages it to use a __virtual
|
||||
environment__. Don't know what this is or how to set it up? We recommend
|
||||
without any incompatibility problems between packages it to use a **virtual
|
||||
environment**. Don't know what this is or how to set it up? We recommend
|
||||
to start by reading a [tutorial on virtual environments][6] for Python.
|
||||
|
||||
!!! warning "Installation on macOS"
|
||||
@@ -59,8 +61,6 @@ those packages separately.
|
||||
|
||||
### with docker <small>recommended</small>
|
||||
|
||||
> All operating systems
|
||||
|
||||
The official [Docker image][7] 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:
|
||||
@@ -69,7 +69,7 @@ minutes, as it comes with all dependencies pre-installed. Pull the image for the
|
||||
docker pull squidfunk/mkdocs-material
|
||||
```
|
||||
|
||||
The `mkdocs` executable is provided as an entrypoint and `serve` is the default
|
||||
The `mkdocs` executable is provided as an entry point and `serve` is the default
|
||||
command. Start the development server in your project root – the folder where
|
||||
`mkdocs.yml` resides — with:
|
||||
|
||||
@@ -89,8 +89,6 @@ command. Start the development server in your project root – the folder where
|
||||
|
||||
### with git
|
||||
|
||||
> All operating systems
|
||||
|
||||
Material for MkDocs can be directly used from [GitHub][8] by cloning the
|
||||
repository into a subfolder of your project root which might be useful if you
|
||||
want to use the very latest version:
|
||||
@@ -103,28 +101,11 @@ The theme will reside in the folder `mkdocs-material/material`.
|
||||
|
||||
[8]: https://github.com/squidfunk/mkdocs-material
|
||||
|
||||
### with choco
|
||||
|
||||
> Windows only
|
||||
|
||||
Material for MkDocs can be installed with [Chocolatey][9]:
|
||||
|
||||
``` dos
|
||||
choco install mkdocs-material
|
||||
```
|
||||
|
||||
Note that this is an [unofficial package][10] of Material for MkDocs, so please
|
||||
understand that the maintainers cannot provide any support for when using this
|
||||
method.
|
||||
|
||||
[9]: https://chocolatey.org
|
||||
[10]: https://chocolatey.org/packages/mkdocs-material
|
||||
|
||||
## Configuration
|
||||
|
||||
Depending on your installation method, you can now add the following lines to
|
||||
`mkdocs.yml` in your project root. If you installed Material for MkDocs using
|
||||
a package manager add:
|
||||
a package manager, add:
|
||||
|
||||
``` yaml
|
||||
theme:
|
||||
@@ -147,12 +128,14 @@ following command:
|
||||
mkdocs serve
|
||||
```
|
||||
|
||||
Point your browser to [http://localhost:8000][11] and your documentation should
|
||||
great you in a new look. If you're starting from scratch, the following
|
||||
configuration can be used as a starting point:
|
||||
Point your browser to http://localhost:8000 and your documentation should greet
|
||||
you in a new look. If you're starting from scratch, the following configuration
|
||||
can be used as a starting point:
|
||||
|
||||
??? summary "Example configuration"
|
||||
|
||||
This is an excerpt from the [`mkdocs.yml`][9] used to render these pages:
|
||||
|
||||
``` yaml
|
||||
# Project information
|
||||
site_name: Material for MkDocs
|
||||
@@ -202,7 +185,7 @@ configuration can be used as a starting point:
|
||||
permalink: true
|
||||
```
|
||||
|
||||
[11]: http://localhost:8000
|
||||
[9]: https://github.com/squidfunk/mkdocs-material/blob/master/mkdocs.yml
|
||||
|
||||
### Feature flags
|
||||
|
||||
@@ -243,6 +226,15 @@ Note that all *top-level pages* (i.e. all top-level entries that directly refer
|
||||
to an `*.md` file) defined inside the `nav` entry of `mkdocs.yml` will be
|
||||
grouped under the first tab which will receive the title of the first page.
|
||||
|
||||
This means that there will effectively be no collapsible subsections for the
|
||||
first tab, as each subsection is rendered as another tab. If you want more
|
||||
fine-grained control, i.e., collapsible subsections for the first tab, you can
|
||||
move all *top-level pages into a subsection*, so that the top-level is entirely
|
||||
made up of subsections. Note that tabs are only shown for larger screens, so
|
||||
make sure that navigation is plausible on mobile devices.
|
||||
|
||||
As an example, see the [`mkdocs.yml`][9] used to render these pages.
|
||||
|
||||
### Language
|
||||
|
||||
> Default: `en`
|
||||
@@ -299,7 +291,7 @@ The following language codes are supported:
|
||||
<li><code>nn</code> / Norwegian (Nynorsk)</li>
|
||||
<li><code>fa</code> / Persian</li>
|
||||
<li><code>pl</code> / Polish</li>
|
||||
<li><code>pt</code> / Portugese</li>
|
||||
<li><code>pt</code> / Portuguese</li>
|
||||
<li><code>ro</code> / Romanian</li>
|
||||
<li><code>ru</code> / Russian</li>
|
||||
<li><code>sr</code> / Serbian</li>
|
||||
@@ -320,8 +312,8 @@ The following language codes are supported:
|
||||
</ul>
|
||||
|
||||
While many languages are read `ltr` (left-to-right), Material for MkDocs also
|
||||
supports `rtl` (right-to-left) directionality which is deduced from the selected
|
||||
language, but can also be set with:
|
||||
supports `rtl` (right-to-left) directionality which is inferred from the
|
||||
selected language, but can also be set with:
|
||||
|
||||
``` yaml
|
||||
theme:
|
||||
@@ -330,7 +322,7 @@ theme:
|
||||
|
||||
### Color palette
|
||||
|
||||
The Material Design [color palette][12] comes with 20 hues, all of which are
|
||||
The Material Design [color palette][10] comes with 20 hues, all of which are
|
||||
included with Material for MkDocs. Primary and accent colors can be set from
|
||||
the project root's `mkdocs.yml`:
|
||||
|
||||
@@ -349,7 +341,7 @@ from the template.
|
||||
|
||||
Material for MkDocs defines all colors as CSS variables. If you want to
|
||||
customize the colors beyond the palette (e.g. to use your brand's colors),
|
||||
you can add an [additional stylesheet][13] and override the defaults:
|
||||
you can add an [additional stylesheet][11] and override the defaults:
|
||||
|
||||
``` css
|
||||
:root {
|
||||
@@ -383,8 +375,8 @@ from the template.
|
||||
}
|
||||
```
|
||||
|
||||
[12]: http://www.materialui.co/colors
|
||||
[13]: customization.md/#additional-stylesheets
|
||||
[10]: http://www.materialui.co/colors
|
||||
[11]: customization.md#additional-stylesheets
|
||||
|
||||
#### Primary color
|
||||
|
||||
@@ -404,9 +396,6 @@ Click on a color name to change the primary color of the theme:
|
||||
display: block;
|
||||
color: var(--md-primary-bg-color);
|
||||
background-color: var(--md-primary-fg-color);
|
||||
box-shadow:
|
||||
0.2941176471em 0 0 var(--md-primary-fg-color),
|
||||
-0.2941176471em 0 0 var(--md-primary-fg-color);
|
||||
}
|
||||
</style>
|
||||
|
||||
@@ -493,10 +482,10 @@ Click on a color name to change the accent color of the theme:
|
||||
|
||||
> Default: `Roboto` and `Roboto Mono`
|
||||
|
||||
The [Roboto font family][14] is the default font included with the theme,
|
||||
The [Roboto font family][12] is the default font included with the theme,
|
||||
specifically the regular sans-serif type for text and the `monospaced` type for
|
||||
code. Both fonts are loaded from [Google Fonts][15] and can be changed to any
|
||||
valid webfont, like for example the [Ubuntu font family][16]:
|
||||
code. Both fonts are loaded from [Google Fonts][13] and can be changed to any
|
||||
valid webfont, like for example the [Ubuntu font family][14]:
|
||||
|
||||
``` yaml
|
||||
theme:
|
||||
@@ -514,9 +503,9 @@ theme:
|
||||
font: false
|
||||
```
|
||||
|
||||
[14]: https://fonts.google.com/specimen/Roboto
|
||||
[15]: https://fonts.google.com
|
||||
[16]: https://fonts.google.com/specimen/Ubuntu
|
||||
[12]: https://fonts.google.com/specimen/Roboto
|
||||
[13]: https://fonts.google.com
|
||||
[14]: https://fonts.google.com/specimen/Ubuntu
|
||||
|
||||
### Icons
|
||||
|
||||
@@ -524,7 +513,7 @@ theme:
|
||||
|
||||
Material for MkDocs uses icons in several places. Currently, the following icons
|
||||
can be changed from `mkdocs.yml`: the logo icon, the repository icon and the
|
||||
[social link icons][17]. While the social link icons are tied to the respective
|
||||
[social link icons][15]. While the social link icons are tied to the respective
|
||||
entries, the other icons can be changed by referencing a valid path (without the
|
||||
trailing `.svg`) relative to the `.icons` folder which comes with the theme:
|
||||
|
||||
@@ -538,14 +527,18 @@ theme:
|
||||
All icons are directly inlined as `*.svg` files, so no further requests will be
|
||||
made. Icon sets which are bundled with Material for MkDocs:
|
||||
|
||||
* [Material Design icons][18]: 3.8k icons
|
||||
* [FontAwesome icons][19]: 1.5k icons
|
||||
* [GitHub octicons][20]: 200 icons
|
||||
* [Material Design icons][16] (`material`): 3.8k icons
|
||||
* [FontAwesome icons][17] (`fontawesome`): 1.5k icons
|
||||
* [GitHub's Octicons][18] (`octicons`): 200 icons
|
||||
|
||||
[17]: #adding-social-links
|
||||
[18]: https://material.io/resources/icons/
|
||||
[19]: https://fontawesome.com/icons?d=gallery&m=free
|
||||
[20]: https://octicons.github.com/
|
||||
__You can use all those icons [directly from :fontawesome-brands-markdown:
|
||||
Markdown][19]!__
|
||||
|
||||
[15]: #adding-social-links
|
||||
[16]: https://material.io/resources/icons/
|
||||
[17]: https://fontawesome.com/icons?d=gallery&m=free
|
||||
[18]: https://octicons.github.com/
|
||||
[19]: extensions/pymdown.md#icons
|
||||
|
||||
### Logo
|
||||
|
||||
@@ -597,16 +590,16 @@ Note that the repository icon can be explicitly set through `theme.icon.repo`.
|
||||
If the `repo_url` is set to a GitHub or BitBucket repository, and the
|
||||
`repo_name` is set to *GitHub* or *BitBucket* (implied by default), an
|
||||
edit button will appear at the top of every article. This is the automatic
|
||||
behavior that MkDocs implements. See the [MkDocs documentation][21] on more
|
||||
behavior that MkDocs implements. See the [MkDocs documentation][20] on more
|
||||
guidance regarding the `edit_uri` attribute, which defines whether the edit
|
||||
button is shown or not.
|
||||
|
||||
[21]: https://www.mkdocs.org/user-guide/configuration/#edit_uri
|
||||
[20]: https://www.mkdocs.org/user-guide/configuration/#edit_uri
|
||||
|
||||
### Adding social links
|
||||
|
||||
Social accounts can be linked in the footer of the documentation using the
|
||||
[icons][22] which are bundled with the theme. Note that each `icon` must point
|
||||
[icons][21] which are bundled with the theme. Note that each `icon` must point
|
||||
to a valid path (without the trailing `.svg`) relative to the `.icons` folder
|
||||
which comes with the theme:
|
||||
|
||||
@@ -621,11 +614,11 @@ extra:
|
||||
link: https://linkedin.com/in/squidfunk
|
||||
```
|
||||
|
||||
[22]: #icons
|
||||
[21]: #icons
|
||||
|
||||
### Adding a Web App Manifest
|
||||
|
||||
A [Web App Manifest][23] is a simple JSON file that tells the browser about your
|
||||
A [Web App Manifest][22] is a simple JSON file that tells the browser about your
|
||||
web application and how it should behave when installed on the user's mobile
|
||||
device or desktop. You can specify such a manifest in `mkdocs.yml`:
|
||||
|
||||
@@ -634,15 +627,15 @@ extra:
|
||||
manifest: manifest.webmanifest
|
||||
```
|
||||
|
||||
[23]: https://developers.google.com/web/fundamentals/web-app-manifest/
|
||||
[22]: https://developers.google.com/web/fundamentals/web-app-manifest/
|
||||
|
||||
## Integrations
|
||||
|
||||
### Google Analytics
|
||||
|
||||
MkDocs makes it easy to integrate site tracking with Google Analytics. Besides
|
||||
basic page views, site search is tracked to better understand how people use
|
||||
your documentation. Google Analytics can be activated with:
|
||||
MkDocs makes it easy to integrate site tracking with Google Analytics. To enable
|
||||
tracking, which is disabled by default, you must add your tracking identifier
|
||||
to `mkdocs.yml`:
|
||||
|
||||
``` yaml
|
||||
google_analytics:
|
||||
@@ -650,11 +643,21 @@ google_analytics:
|
||||
- auto
|
||||
```
|
||||
|
||||
Besides basic page views, *site search* can also be tracked to better understand
|
||||
how people use your documentation and what they expect to find. To enable
|
||||
search tracking:
|
||||
|
||||
1. Go to your Google Analytics **admin settings**
|
||||
2. Select the property for the respective tracking code
|
||||
3. Go to the **view settings** tab.
|
||||
4. Scroll down and enable **site search settings**
|
||||
5. Set the **query parameter** to `q`.
|
||||
|
||||
### Disqus
|
||||
|
||||
Material for MkDocs is integrated with [Disqus][24], so if you want to add a
|
||||
comments section to your documentation set the shortname of your Disqus project
|
||||
in `mkdocs.yml`:
|
||||
Material for MkDocs is integrated with [Disqus][23], so if you want to add a
|
||||
comments section to your documentation set the *shortname* of your Disqus
|
||||
project in `mkdocs.yml`:
|
||||
|
||||
``` yaml
|
||||
extra:
|
||||
@@ -669,10 +672,10 @@ necessary JavaScript is automatically included.
|
||||
Note that `site_url` must be set in `mkdocs.yml` for the Disqus integration
|
||||
to load properly.
|
||||
|
||||
Disqus can also be enabled or disabled for specific pages using [Metadata][25].
|
||||
Disqus can also be enabled or disabled for specific pages using [Metadata][24].
|
||||
|
||||
[24]: https://disqus.com
|
||||
[25]: extensions/metadata.md#disqus
|
||||
[23]: https://disqus.com
|
||||
[24]: extensions/metadata.md#disqus
|
||||
|
||||
## Extensions
|
||||
|
||||
@@ -692,19 +695,19 @@ markdown_extensions:
|
||||
See the following list of extensions supported by Material for MkDocs including
|
||||
some more information on configuration and usage:
|
||||
|
||||
* [Admonition][26]
|
||||
* [Codehilite][27]
|
||||
* [Footnotes][28]
|
||||
* [Metadata][29]
|
||||
* [Permalinks][30]
|
||||
* [PyMdown Extensions][31]
|
||||
* [Admonition][25]
|
||||
* [Codehilite][26]
|
||||
* [Footnotes][27]
|
||||
* [Metadata][28]
|
||||
* [Permalinks][29]
|
||||
* [PyMdown Extensions][30]
|
||||
|
||||
[26]: extensions/admonition.md
|
||||
[27]: extensions/codehilite.md
|
||||
[28]: extensions/footnotes.md
|
||||
[29]: extensions/metadata.md
|
||||
[30]: extensions/permalinks.md
|
||||
[31]: extensions/pymdown.md
|
||||
[25]: extensions/admonition.md
|
||||
[26]: extensions/codehilite.md
|
||||
[27]: extensions/footnotes.md
|
||||
[28]: extensions/metadata.md
|
||||
[29]: extensions/permalinks.md
|
||||
[30]: extensions/pymdown.md
|
||||
|
||||
## Plugins
|
||||
|
||||
@@ -713,14 +716,16 @@ steps that sit between the theme and your documentation. For more information,
|
||||
see the following list of plugins tested and supported by Material for MkDocs
|
||||
including more information regarding installation and usage:
|
||||
|
||||
* [Search][32] (enabled by default)
|
||||
* [Minification][33]
|
||||
* [Revision date][34]
|
||||
* [Search][31] (enabled by default)
|
||||
* [Minification][32]
|
||||
* [Revision date][33]
|
||||
* [Awesome pages][34]
|
||||
|
||||
For further reference, the MkDocs wiki contains a list of all
|
||||
[available plugins][35].
|
||||
|
||||
[32]: plugins/search.md
|
||||
[33]: plugins/minification.md
|
||||
[34]: plugins/revision-date.md
|
||||
[31]: plugins/search.md
|
||||
[32]: plugins/minification.md
|
||||
[33]: plugins/revision-date.md
|
||||
[34]: plugins/awesome-pages.md
|
||||
[35]: https://github.com/mkdocs/mkdocs/wiki/MkDocs-Plugins
|
||||
|
||||
@@ -1,49 +1,4 @@
|
||||
---
|
||||
template: overrides/home.html
|
||||
title: Material for MkDocs
|
||||
---
|
||||
|
||||
# Material <small>for MkDocs</small>
|
||||
|
||||
## Create beautiful project documentation
|
||||
|
||||
Material is a theme for [MkDocs][1], an excellent static site generator geared
|
||||
towards project documentation. It is built using Google's [Material Design][2]
|
||||
guidelines.
|
||||
|
||||
[](assets/images/material.png)
|
||||
|
||||
[1]: https://www.mkdocs.org
|
||||
[2]: https://material.io/design/
|
||||
|
||||
## Quick start
|
||||
|
||||
Install the latest version of Material with `pip`:
|
||||
|
||||
``` sh
|
||||
pip install mkdocs-material
|
||||
```
|
||||
|
||||
Add the following line to `mkdocs.yml`:
|
||||
|
||||
``` yaml
|
||||
theme:
|
||||
name: material
|
||||
```
|
||||
|
||||
## What to expect
|
||||
|
||||
* Responsive design and fluid layout for all kinds of screens and devices,
|
||||
designed to serve your project documentation in a user-friendly way in 41
|
||||
languages with optimal readability.
|
||||
|
||||
* Easily customizable primary and accent color, fonts, favicon and logo;
|
||||
straight forward localization through theme extension; integrated with Google
|
||||
Analytics, Disqus and GitHub.
|
||||
|
||||
* Well-designed search interface accessible through hotkeys (<kbd>F</kbd> or
|
||||
<kbd>S</kbd>), intelligent grouping of search results, search term
|
||||
highlighting and lazy loading.
|
||||
|
||||
For detailed instructions see the [getting started guide][3].
|
||||
|
||||
[3]: getting-started.md
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Awesome pages
|
||||
|
||||
The [mkdocs-awesome-pages-plugin][1] omits the need to specify all pages in the
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Minification
|
||||
|
||||
The [mkdocs-minify-plugin][1] will minify all `*.html` files generated by
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Revision date
|
||||
|
||||
The [mkdocs-git-revision-date-localized-plugin][1] will add the date on which a
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Search
|
||||
|
||||
The [built-in search plugin][1] provides client-side search inside the browser
|
||||
@@ -5,9 +9,19 @@ and is implemented using [lunr.js][2] which includes stemmers for the English
|
||||
language by default, while stemmers for other languages are included with
|
||||
[lunr-languages][3], both of which are integrated with this theme.
|
||||
|
||||
!!! tip "Make search work offline"
|
||||
|
||||
While search will not work for the `file://` protocol, as web workers and
|
||||
the use of `XMLHTTPRequest` are both blocked by modern browsers for security
|
||||
reasons, the [localsearch][4] plugin and @squidfunk's [iframe-worker][5]
|
||||
polyfill add support for cases where this is a mandatory requirement, e.g.,
|
||||
for offline use.
|
||||
|
||||
[1]: https://www.mkdocs.org/user-guide/configuration/#search
|
||||
[2]: https://lunrjs.com
|
||||
[3]: https://github.com/MihaiValentin/lunr-languages
|
||||
[4]: https://github.com/wilhelmer/mkdocs-localsearch
|
||||
[5]: https://github.com/squidfunk/iframe-worker
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -65,7 +79,7 @@ The following language codes are supported:
|
||||
<li><code>it</code> / Italian</li>
|
||||
<li><code>ja</code> / Japanese</li>
|
||||
<li><code>no</code> / Norwegian</li>
|
||||
<li><code>pt</code> / Portugese</li>
|
||||
<li><code>pt</code> / Portuguese</li>
|
||||
<li><code>ro</code> / Romanian</li>
|
||||
<li><code>ru</code> / Russian</li>
|
||||
<li><code>es</code> / Spanish</li>
|
||||
@@ -91,14 +105,14 @@ index parts of words that are separated by `-` or `.`:
|
||||
``` yaml
|
||||
plugins:
|
||||
- search:
|
||||
separator: [\s\-\.]+
|
||||
separator: '[\s\-\.]+'
|
||||
```
|
||||
|
||||
### Prebuilding :hatching_chick:
|
||||
|
||||
> Default: `false`
|
||||
|
||||
MkDocs can generate a [prebuilt index][4] of all pages during build time, which
|
||||
MkDocs can generate a [prebuilt index][6] of all pages during build time, which
|
||||
provides performance improvements at the cost of more bandwidth. This may be
|
||||
beneficial for large documentation projects that are served with appropriate
|
||||
HTTP headers (e.g. `Content-Encoding: gzip`).
|
||||
@@ -112,7 +126,7 @@ plugins:
|
||||
prebuild_index: true
|
||||
```
|
||||
|
||||
[4]: https://www.mkdocs.org/user-guide/configuration/#prebuild_index
|
||||
[6]: https://www.mkdocs.org/user-guide/configuration/#prebuild_index
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
# Material for MkDocs 4
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Upgrading to 4.x
|
||||
|
||||
## Highlights
|
||||
|
||||
|
||||
@@ -1,8 +1,12 @@
|
||||
# Material for MkDocs 5
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Upgrading to 5.x
|
||||
|
||||
## Highlights
|
||||
|
||||
* Reactive architecture – try `__material.dialog$.next("Hi!")` in the console
|
||||
* Reactive architecture – try `app.dialog$.next("Hi!")` in the console
|
||||
* [Instant loading][5] – make Material behave like a Single Page Application
|
||||
* Improved CSS customization with [CSS variables][1] – set your brand's colors
|
||||
* Improved CSS resilience, e.g. proper sidebar locking for customized headers
|
||||
@@ -50,8 +54,8 @@ flags and can be enabled by listing them in `mkdocs.yml` under `theme.features`:
|
||||
tabs: true
|
||||
```
|
||||
|
||||
[4]: ../../../getting-started/#tabs
|
||||
[5]: ../../../getting-started/#instant-loading
|
||||
[4]: ../../getting-started/#tabs
|
||||
[5]: ../../getting-started/#instant-loading
|
||||
|
||||
#### `theme.logo.icon`
|
||||
|
||||
@@ -66,7 +70,7 @@ be set to any of the [icons bundled with the theme][6]:
|
||||
logo: material/cloud
|
||||
```
|
||||
|
||||
[6]: ../../../getting-started/#icons
|
||||
[6]: ../../getting-started/#icons
|
||||
|
||||
=== "4.x"
|
||||
|
||||
@@ -107,7 +111,7 @@ was renamed to `separator`:
|
||||
``` yaml
|
||||
plugins:
|
||||
- search:
|
||||
separator: [\s\-\.]+
|
||||
separator: '[\s\-\.]+'
|
||||
lang:
|
||||
- en
|
||||
- de
|
||||
@@ -123,7 +127,7 @@ was renamed to `separator`:
|
||||
tokenizer: [\s\-\.]+
|
||||
```
|
||||
|
||||
[7]: ../../../plugins/search/#configuration
|
||||
[7]: ../../plugins/search/#configuration
|
||||
|
||||
#### `extra.social.*`
|
||||
|
||||
@@ -187,7 +191,7 @@ matches the new structure:
|
||||
- <meta name="lang:{{ key }}" content="{{ lang.t(key) }}">
|
||||
- {% endfor %}
|
||||
<link rel="shortcut icon" href="{{ config.theme.favicon | url }}">
|
||||
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-5.0.0b2-1">
|
||||
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-5.0.0">
|
||||
{% endblock %}
|
||||
@@ -56,9 +42,9 @@
|
||||
{% endif %}
|
||||
@@ -221,7 +225,7 @@ matches the new structure:
|
||||
{% if config.extra.manifest %}
|
||||
<link rel="manifest" href="{{ config.extra.manifest | url }}" crossorigin="use-credentials">
|
||||
{% endif %}
|
||||
@@ -95,47 +78,46 @@
|
||||
@@ -95,47 +77,50 @@
|
||||
{% endblock %}
|
||||
{% block extrahead %}{% endblock %}
|
||||
</head>
|
||||
@@ -251,20 +255,23 @@ matches the new structure:
|
||||
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
||||
- <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
|
||||
+ <label class="md-overlay" for="__drawer"></label>
|
||||
{% if page.toc | first is defined %}
|
||||
- <a href="{{ (page.toc | first).url }}" tabindex="0" class="md-skip">
|
||||
+ {% set skip = page.toc | first %}
|
||||
+ <a href="{{ skip.url | url }}" class="md-skip" data-md-component="skip">
|
||||
{{ lang.t('skip.link.title') }}
|
||||
</a>
|
||||
{% endif %}
|
||||
+ {% if self.announce() %}
|
||||
+ <aside class="md-announce" data-md-component="announce">
|
||||
+ <div class="md-announce__inner md-grid md-typeset">
|
||||
+ {% block announce %}{% endblock %}
|
||||
+ </div>
|
||||
+ </aside>
|
||||
+ {% endif %}
|
||||
+ <div data-md-component="skip">
|
||||
+ {% if page.toc | first is defined %}
|
||||
+ {% set skip = page.toc | first %}
|
||||
+ <a href="{{ skip.url | url }}" class="md-skip">
|
||||
+ {{ lang.t('skip.link.title') }}
|
||||
+ </a>
|
||||
+ {% endif %}
|
||||
+ </div>
|
||||
+ <div data-md-component="announce">
|
||||
+ {% if self.announce() %}
|
||||
+ <aside class="md-announce">
|
||||
+ <div class="md-announce__inner md-grid md-typeset">
|
||||
+ {% block announce %}{% endblock %}
|
||||
+ </div>
|
||||
+ </aside>
|
||||
+ {% endif %}
|
||||
+ </div>
|
||||
{% block header %}
|
||||
{% include "partials/header.html" %}
|
||||
{% endblock %}
|
||||
@@ -290,7 +297,7 @@ matches the new structure:
|
||||
{% block site_nav %}
|
||||
{% if nav %}
|
||||
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
|
||||
@@ -160,41 +142,25 @@
|
||||
@@ -160,41 +141,25 @@
|
||||
<article class="md-content__inner md-typeset">
|
||||
{% block content %}
|
||||
{% if page.edit_url %}
|
||||
@@ -345,15 +352,12 @@ matches the new structure:
|
||||
{% endif %}
|
||||
{% endblock %}
|
||||
{% block disqus %}
|
||||
@@ -208,29 +174,40 @@
|
||||
@@ -208,29 +174,35 @@
|
||||
{% include "partials/footer.html" %}
|
||||
{% endblock %}
|
||||
</div>
|
||||
+ {% block config %}
|
||||
+ <script>var __config={}</script>
|
||||
+ {% endblock %}
|
||||
{% block scripts %}
|
||||
- <script src="{{ 'assets/javascripts/application.df00da5d.js' | url }}"></script>
|
||||
- <script src="{{ 'assets/javascripts/application.********.js' | url }}"></script>
|
||||
- {% if lang.t("search.language") != "en" %}
|
||||
- {% set languages = lang.t("search.language").split(",") %}
|
||||
- {% if languages | length and languages[0] != "" %}
|
||||
@@ -375,8 +379,8 @@ matches the new structure:
|
||||
- {% endif %}
|
||||
- {% endif %}
|
||||
- <script>app.initialize({version:"{{ mkdocs_version }}",url:{base:"{{ base_url }}"}})</script>
|
||||
+ <script src="{{ 'assets/javascripts/vendor.31a2e7b9.min.js' | url }}"></script>
|
||||
+ <script src="{{ 'assets/javascripts/bundle.5b33ad8d.min.js' | url }}"></script>
|
||||
+ <script src="{{ 'assets/javascripts/vendor.********.min.js' | url }}"></script>
|
||||
+ <script src="{{ 'assets/javascripts/bundle.********.min.js' | url }}"></script>
|
||||
+ {%- set translations = {} -%}
|
||||
+ {%- for key in [
|
||||
+ "clipboard.copy",
|
||||
@@ -392,18 +396,17 @@ matches the new structure:
|
||||
+ {%- set _ = translations.update({ key: lang.t(key) }) -%}
|
||||
+ {%- endfor -%}
|
||||
+ <script id="__lang" type="application/json">
|
||||
+ {{ translations | tojson }}
|
||||
+ {{- translations | tojson -}}
|
||||
+ </script>
|
||||
+ {% block config %}{% endblock %}
|
||||
+ <script>
|
||||
+ __material = initialize(Object.assign({
|
||||
+ url: {
|
||||
+ base: "{{ base_url }}",
|
||||
+ worker: {
|
||||
+ search: "{{ 'assets/javascripts/worker/search.edc88caf.min.js' | url }}"
|
||||
+ }
|
||||
+ },
|
||||
+ features: {{ config.theme.features | tojson }}
|
||||
+ }, __config))
|
||||
+ app = initialize({
|
||||
+ base: "{{ base_url }}",
|
||||
+ features: {{ config.theme.features | tojson }},
|
||||
+ search: Object.assign({
|
||||
+ worker: "{{ 'assets/javascripts/worker/search.********.min.js' | url }}"
|
||||
+ }, typeof search !== "undefined" && search)
|
||||
+ })
|
||||
+ </script>
|
||||
{% for path in config["extra_javascript"] %}
|
||||
<script src="{{ path | url }}"></script>
|
||||
@@ -464,7 +467,7 @@ matches the new structure:
|
||||
#### `partials/header.html`
|
||||
|
||||
``` diff
|
||||
@@ -2,51 +2,46 @@
|
||||
@@ -2,51 +2,43 @@
|
||||
This file was automatically generated - do not edit
|
||||
-#}
|
||||
<header class="md-header" data-md-component="header">
|
||||
@@ -485,24 +488,7 @@ matches the new structure:
|
||||
- <div class="md-flex__cell md-flex__cell--stretch">
|
||||
- <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
|
||||
- {% if config.site_name == page.title %}
|
||||
+ <nav class="md-header-nav md-grid" aria-label="{{ lang.t('header.title') }}">
|
||||
+ <a href="{{ config.site_url | default(nav.homepage.url, true) | url }}" title="{{ config.site_name }}" aria-label="{{ config.site_name }}" class="md-header-nav__button md-logo">
|
||||
+ {% if config.theme.logo %}
|
||||
+ <img src="{{ config.theme.logo | url }}" alt="logo">
|
||||
+ {% else %}
|
||||
+ {% include ".icons/" ~ config.theme.icon.logo ~ ".svg" %}
|
||||
+ {% endif %}
|
||||
+ </a>
|
||||
+ <label class="md-header-nav__button md-icon" for="__drawer">
|
||||
+ {% include ".icons/material/menu" ~ ".svg" %}
|
||||
+ </label>
|
||||
+ <div class="md-header-nav__title" data-md-component="header-title">
|
||||
+ <div class="md-header-nav__ellipsis md-ellipsis">
|
||||
+ {% if config.site_name == page.title %}
|
||||
+ {{ config.site_name }}
|
||||
+ {% else %}
|
||||
+ <span class="md-header-nav__topic">
|
||||
{{ config.site_name }}
|
||||
- {{ config.site_name }}
|
||||
- {% else %}
|
||||
- <span class="md-header-nav__topic">
|
||||
- {{ config.site_name }}
|
||||
@@ -515,29 +501,44 @@ matches the new structure:
|
||||
- {% endif %}
|
||||
- </span>
|
||||
- {% endif %}
|
||||
- </div>
|
||||
+ <nav class="md-header-nav md-grid" aria-label="{{ lang.t('header.title') }}">
|
||||
+ <a href="{{ config.site_url | default(nav.homepage.url, true) | url }}" title="{{ config.site_name }}" class="md-header-nav__button md-logo" aria-label="{{ config.site_name }}">
|
||||
+ {% include "partials/logo.html" %}
|
||||
+ </a>
|
||||
+ <label class="md-header-nav__button md-icon" for="__drawer">
|
||||
+ {% include ".icons/material/menu" ~ ".svg" %}
|
||||
+ </label>
|
||||
+ <div class="md-header-nav__title" data-md-component="header-title">
|
||||
+ {% if config.site_name == page.title %}
|
||||
+ <div class="md-header-nav__ellipsis md-ellipsis">
|
||||
+ {{ config.site_name }}
|
||||
</div>
|
||||
- </div>
|
||||
- <div class="md-flex__cell md-flex__cell--shrink">
|
||||
- {% if "search" in config["plugins"] %}
|
||||
- <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
|
||||
- {% include "partials/search.html" %}
|
||||
- {% endif %}
|
||||
- </div>
|
||||
- {% if config.repo_url %}
|
||||
- <div class="md-flex__cell md-flex__cell--shrink">
|
||||
- <div class="md-header-nav__source">
|
||||
- {% include "partials/source.html" %}
|
||||
- </div>
|
||||
+ {% else %}
|
||||
+ <div class="md-header-nav__ellipsis">
|
||||
+ <span class="md-header-nav__topic md-ellipsis">
|
||||
+ {{ config.site_name }}
|
||||
+ </span>
|
||||
+ <span class="md-header-nav__topic">
|
||||
+ <span class="md-header-nav__topic md-ellipsis">
|
||||
+ {% if page and page.meta and page.meta.title %}
|
||||
+ {{ page.meta.title }}
|
||||
+ {% else %}
|
||||
+ {{ page.title }}
|
||||
+ {% endif %}
|
||||
+ </span>
|
||||
{% endif %}
|
||||
</div>
|
||||
- {% if config.repo_url %}
|
||||
- <div class="md-flex__cell md-flex__cell--shrink">
|
||||
- <div class="md-header-nav__source">
|
||||
- {% include "partials/source.html" %}
|
||||
- </div>
|
||||
- </div>
|
||||
- {% endif %}
|
||||
</div>
|
||||
{% endif %}
|
||||
</div>
|
||||
+ {% if "search" in config["plugins"] %}
|
||||
+ <label class="md-header-nav__button md-icon" for="__search">
|
||||
@@ -589,6 +590,21 @@ matches the new structure:
|
||||
+{% macro t(key) %}{{ lang.t(key) | default(fallback.t(key)) }}{% endmacro %}
|
||||
```
|
||||
|
||||
#### `partials/logo.html`
|
||||
|
||||
``` diff
|
||||
@@ -0,0 +1,9 @@
|
||||
+{#-
|
||||
+ This file was automatically generated - do not edit
|
||||
+-#}
|
||||
+{% if config.theme.logo %}
|
||||
+ <img src="{{ config.theme.logo | url }}" alt="logo">
|
||||
+{% else %}
|
||||
+ {% set icon = config.theme.icon.logo or "material/library" %}
|
||||
+ {% include ".icons/" ~ icon ~ ".svg" %}
|
||||
+{% endif %}
|
||||
```
|
||||
|
||||
#### `partials/nav-item.html`
|
||||
|
||||
``` diff
|
||||
@@ -624,7 +640,7 @@ matches the new structure:
|
||||
#### `partials/nav.html`
|
||||
|
||||
``` diff
|
||||
@@ -1,13 +1,14 @@
|
||||
@@ -1,14 +1,10 @@
|
||||
{#-
|
||||
This file was automatically generated - do not edit
|
||||
-#}
|
||||
@@ -633,18 +649,16 @@ matches the new structure:
|
||||
- <a href="{{ config.site_url | default(nav.homepage.url, true) | url }}" title="{{ config.site_name }}" class="md-nav__button md-logo">
|
||||
- {% if config.theme.logo.icon %}
|
||||
- <i class="md-icon">{{ config.theme.logo.icon }}</i>
|
||||
- {% else %}
|
||||
- <img alt="logo" src="{{ config.theme.logo | url }}" width="48" height="48">
|
||||
- {% endif %}
|
||||
+<nav class="md-nav md-nav--primary" aria-label="{{ lang.t('nav.title') }}" data-md-level="0">
|
||||
+ <label class="md-nav__title" for="__drawer">
|
||||
+ <a href="{{ config.site_url | default(nav.homepage.url, true) | url }}" title="{{ config.site_name }}" aria-label="{{ config.site_name }}" class="md-nav__button md-logo">
|
||||
+ {% if config.theme.logo %}
|
||||
+ <img src="{{ config.theme.logo | url }}" alt="logo">
|
||||
{% else %}
|
||||
- <img alt="logo" src="{{ config.theme.logo | url }}" width="48" height="48">
|
||||
+ {% set icon = config.theme.icon.logo or "material/library" %}
|
||||
+ {% include ".icons/" ~ icon ~ ".svg" %}
|
||||
{% endif %}
|
||||
+ <a href="{{ config.site_url | default(nav.homepage.url, true) | url }}" title="{{ config.site_name }}" class="md-nav__button md-logo" aria-label="{{ config.site_name }}">
|
||||
+ {% include "partials/logo.html" %}
|
||||
</a>
|
||||
{{ config.site_name }}
|
||||
</label>
|
||||
```
|
||||
|
||||
#### `partials/search.html`
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Upgrading
|
||||
|
||||
To upgrade to the latest version:
|
||||
@@ -14,6 +18,47 @@ pip show mkdocs-material
|
||||
|
||||
## Changelog
|
||||
|
||||
### 5.1.1 <small>_ April 17, 2020</small>
|
||||
|
||||
* Added new FontAwesome icons
|
||||
* Fixed #1609: Instant loading doesn't honor `target=_blank`
|
||||
* Fixed GitHub stars count rounding errors
|
||||
* Fixed GitLab stars count retrieval
|
||||
|
||||
### 5.1.0 <small>_ April 12, 2020</small>
|
||||
|
||||
* Added support for icons from Markdown through [mkdocs-material-extensions][1]
|
||||
|
||||
[1]: https://github.com/facelessuser/mkdocs-material-extensions
|
||||
|
||||
### 5.0.2 <small>_ April 10, 2020</small>
|
||||
|
||||
* Added CSS source maps to distribution files
|
||||
* Fixed errors in Chinese (Traditional) translations
|
||||
* Fixed creation of stale directory on installation from git
|
||||
* Improved overflow scrolling behavior on iOS (reduced bundle size by `4kb`)
|
||||
|
||||
### 5.0.1 <small>_ April 7, 2020</small>
|
||||
|
||||
* Fixed syntax error in Spanish translation
|
||||
|
||||
### 5.0.0 <small>_ April 7, 2020</small>
|
||||
|
||||
* Reactive architecture – try `app.dialog$.next("Hi!")` in the console
|
||||
* Instant loading – make Material behave like a Single Page Application
|
||||
* Improved CSS customization with CSS variables – set your brand's colors
|
||||
* Improved CSS resilience, e.g. proper sidebar locking for customized headers
|
||||
* Improved icon integration and configuration – now including over 5k icons
|
||||
* Added possibility to use any icon for logo, repository and social links
|
||||
* Search UI does not freeze anymore (moved to web worker)
|
||||
* Search index built only once when using instant loading
|
||||
* Improved extensible keyboard handling
|
||||
* Support for prebuilt search indexes
|
||||
* Support for displaying stars and forks for GitLab repositories
|
||||
* Support for scroll snapping of sidebars and search results
|
||||
* Reduced HTML and CSS footprint due to deprecation of Internet Explorer support
|
||||
* Slight facelifting of some UI elements (Admonitions, tables, ...)
|
||||
|
||||
### 4.6.3 <small>_ February 14, 2020</small>
|
||||
|
||||
* Removed optional third-party plugins from `requirements.txt`
|
||||
@@ -34,10 +79,10 @@ pip show mkdocs-material
|
||||
|
||||
### 4.6.0 <small>_ December 11, 2019</small>
|
||||
|
||||
* Added support for [mkdocs-git-revision-date-localized-plugin][3]
|
||||
* Added support for [mkdocs-git-revision-date-localized-plugin][2]
|
||||
* Fixed invalid character in Google Fonts URL
|
||||
|
||||
[3]: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
|
||||
[2]: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
|
||||
|
||||
### 4.5.1 <small>_ December 2, 2019</small>
|
||||
|
||||
@@ -123,7 +168,7 @@ pip show mkdocs-material
|
||||
* Added background on hover for table rows
|
||||
* Removed Google Tag Manager and reverted to Google Analytics
|
||||
* Removed blocks in partials - Jinja doesn't support them
|
||||
* Fixed #911: Chrome breaks layout if system language is Chinese (__BREAKING__)
|
||||
* Fixed #911: Chrome breaks layout if system language is Chinese (**BREAKING**)
|
||||
* Fixed #976: Removed FastClick
|
||||
|
||||
### 3.3.0 <small>_ January 29, 2019</small>
|
||||
@@ -172,7 +217,7 @@ pip show mkdocs-material
|
||||
|
||||
### 3.0.0 <small>_ August 5, 2018</small>
|
||||
|
||||
* Upgraded MkDocs to 1.0 (__BREAKING__)
|
||||
* Upgraded MkDocs to 1.0 (**BREAKING**)
|
||||
* Upgraded Python in official Docker image to 3.6
|
||||
* Added Serbian and Serbo-Croatian translations
|
||||
|
||||
@@ -559,7 +604,7 @@ pip show mkdocs-material
|
||||
|
||||
### 1.5.1 <small>_ March 30, 2017</small>
|
||||
|
||||
* Fixed rendering and offset of targetted footnotes
|
||||
* Fixed rendering and offset of targeted footnotes
|
||||
* Fixed #238: Link on logo is not set to `site_url`
|
||||
|
||||
### 1.5.0 <small>_ March 24, 2017</small>
|
||||
|
||||
1
material/.icons/fontawesome/solid/box-tissue.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M383.88,287.82l64-192H338.47a70.2,70.2,0,0,1-66.59-48,70.21,70.21,0,0,0-66.6-48H63.88l64,288Zm-384,192a32,32,0,0,0,32,32h448a32,32,0,0,0,32-32v-64H-.12Zm480-256H438.94l-21.33,64h14.27a16,16,0,0,1,0,32h-352a16,16,0,1,1,0-32H95.09l-14.22-64h-49a32,32,0,0,0-32,32v128h512v-128A32,32,0,0,0,479.88,223.82Z"/></svg>
|
||||
|
After Width: | Height: | Size: 380 B |
1
material/.icons/fontawesome/solid/disease.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M472.29 195.9l-67.06-23c-19.28-6.6-33.54-20.92-38.14-38.31l-16-60.45c-11.58-43.77-76.57-57.13-110-22.62L195 99.24c-13.26 13.71-33.54 20.93-54.2 19.31l-71.9-5.62c-52-4.07-86.93 44.89-59 82.84l38.54 52.42c11.08 15.07 12.82 33.86 4.64 50.24l-28.43 57C4 396.67 47.46 440.29 98.11 429.23l70-15.28c20.11-4.39 41.45 0 57.07 11.73l54.32 40.83c39.32 29.56 101 7.57 104.45-37.22l4.7-61.86c1.35-17.8 12.8-33.87 30.63-43l62-31.74c44.84-22.96 39.55-80.17-8.99-96.79zM160 256a32 32 0 1 1 32-32 32 32 0 0 1-32 32zm128 96a32 32 0 1 1 32-32 32 32 0 0 1-32 32zm16-128a16 16 0 1 1 16-16 16 16 0 0 1-16 16z"/></svg>
|
||||
|
After Width: | Height: | Size: 666 B |
1
material/.icons/fontawesome/solid/faucet.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M352,256H313.39c-15.71-13.44-35.46-23.07-57.39-28V180.44l-32-3.38-32,3.38V228c-21.93,5-41.68,14.6-57.39,28H16A16,16,0,0,0,0,272v96a16,16,0,0,0,16,16h92.79C129.38,421.73,173,448,224,448s94.62-26.27,115.21-64H352a32,32,0,0,1,32,32,32,32,0,0,0,32,32h64a32,32,0,0,0,32-32A160,160,0,0,0,352,256ZM81.59,159.91l142.41-15,142.41,15c9.42,1,17.59-6.81,17.59-16.8V112.89c0-10-8.17-17.8-17.59-16.81L256,107.74V80a16,16,0,0,0-16-16H208a16,16,0,0,0-16,16v27.74L81.59,96.08C72.17,95.09,64,102.9,64,112.89v30.22C64,153.1,72.17,160.91,81.59,159.91Z"/></svg>
|
||||
|
After Width: | Height: | Size: 611 B |
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><path d="M159.88,175.82h64v64a16,16,0,0,0,16,16h64a16,16,0,0,0,16-16v-64h64a16,16,0,0,0,16-16v-64a16,16,0,0,0-16-16h-64v-64a16,16,0,0,0-16-16h-64a16,16,0,0,0-16,16v64h-64a16,16,0,0,0-16,16v64A16,16,0,0,0,159.88,175.82ZM568.07,336.13a39.91,39.91,0,0,0-55.93-8.47L392.47,415.84H271.86a16,16,0,0,1,0-32H350.1c16,0,30.75-10.87,33.37-26.61a32.06,32.06,0,0,0-31.62-37.38h-160a117.7,117.7,0,0,0-74.12,26.25l-46.5,37.74H15.87a16.11,16.11,0,0,0-16,16v96a16.11,16.11,0,0,0,16,16h347a104.8,104.8,0,0,0,61.7-20.27L559.6,392A40,40,0,0,0,568.07,336.13Z"/></svg>
|
||||
|
After Width: | Height: | Size: 609 B |
1
material/.icons/fontawesome/solid/hand-holding-water.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><path d="M288 256c53 0 96-42.1 96-94 0-40-57.1-120.7-83.2-155.6-6.4-8.5-19.2-8.5-25.6 0C249.1 41.3 192 122 192 162c0 51.9 43 94 96 94zm277.3 72.1c-11.8-10.7-30.2-10-42.6 0L430.3 402c-11.3 9.1-25.4 14-40 14H272c-8.8 0-16-7.2-16-16s7.2-16 16-16h78.3c15.9 0 30.7-10.9 33.3-26.6 3.3-20-12.1-37.4-31.6-37.4H192c-27 0-53.1 9.3-74.1 26.3L71.4 384H16c-8.8 0-16 7.2-16 16v96c0 8.8 7.2 16 16 16h356.8c14.5 0 28.6-4.9 40-14L564 377c15.2-12.1 16.4-35.3 1.3-48.9z"/></svg>
|
||||
|
After Width: | Height: | Size: 521 B |
1
material/.icons/fontawesome/solid/hand-sparkles.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><path d="M106.66,170.64l.09,0,49.55-20.65a7.32,7.32,0,0,0,3.68-6h0a7.29,7.29,0,0,0-3.68-6l-49.57-20.67-.07,0L86,67.68a6.66,6.66,0,0,0-11.92,0l-20.7,49.63-.05,0L3.7,138A7.29,7.29,0,0,0,0,144H0a7.32,7.32,0,0,0,3.68,6L53.27,170.6l.07,0L74,220.26a6.65,6.65,0,0,0,11.92,0l20.69-49.62ZM471.38,467.41l-1-.42-1-.5a38.67,38.67,0,0,1,0-69.14l1-.49,1-.43,37.49-15.63,15.63-37.48.41-1,.47-.95c3.85-7.74,10.58-13.63,18.35-17.34,0-1.33.25-2.69.27-4V144a32,32,0,0,0-64,0v72a8,8,0,0,1-8,8H456a8,8,0,0,1-8-8V64a32,32,0,0,0-64,0V216a8,8,0,0,1-8,8H360a8,8,0,0,1-8-8V32a32,32,0,0,0-64,0V216a8,8,0,0,1-8,8H264a8,8,0,0,1-8-8V64a32,32,0,0,0-64,0v241l-23.59-32.49a40,40,0,0,0-64.71,47.09L229.3,492.21A48.07,48.07,0,0,0,268.09,512H465.7c19.24,0,35.65-11.73,43.24-28.79l-.07-.17ZM349.79,339.52,320,351.93l-12.42,29.78a4,4,0,0,1-7.15,0L288,351.93l-29.79-12.41a4,4,0,0,1,0-7.16L288,319.94l12.42-29.78a4,4,0,0,1,7.15,0L320,319.94l29.79,12.42a4,4,0,0,1,0,7.16ZM640,431.91a7.28,7.28,0,0,0-3.68-6l-49.57-20.67-.07,0L566,355.63a6.66,6.66,0,0,0-11.92,0l-20.7,49.63-.05,0L483.7,426a7.28,7.28,0,0,0-3.68,6h0a7.29,7.29,0,0,0,3.68,5.95l49.57,20.67.07,0L554,508.21a6.65,6.65,0,0,0,11.92,0l20.69-49.62h0l.09,0,49.55-20.66a7.29,7.29,0,0,0,3.68-5.95h0Z"/></svg>
|
||||
|
After Width: | Height: | Size: 1.3 KiB |
1
material/.icons/fontawesome/solid/hands-wash.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><path d="M496,224a48,48,0,1,0-48-48A48,48,0,0,0,496,224ZM311.47,178.45A56.77,56.77,0,0,1,328,176a56,56,0,0,1,19,3.49l15.35-48.61A24,24,0,0,0,342,99.74c-11.53-1.35-22.21,6.44-25.71,17.51l-20.9,66.17ZM93.65,386.33c.8-.19,1.54-.54,2.35-.71V359.93a156,156,0,0,1,107.06-148l73.7-22.76L310.92,81.05a24,24,0,0,0-20.33-31.11c-11.53-1.34-22.22,6.45-25.72,17.52L231.42,173.88a8,8,0,0,1-15.26-4.83L259.53,31.26A24,24,0,0,0,239.2.15C227.67-1.19,217,6.6,213.49,17.66L165.56,169.37a8,8,0,1,1-15.26-4.82l38.56-122a24,24,0,0,0-20.33-31.11C157,10,146.32,17.83,142.82,28.9l-60,189.85L80.76,168.7A24,24,0,0,0,56.9,144.55c-13.23-.05-24.72,10.54-24.9,23.86V281.14A123.69,123.69,0,0,0,93.65,386.33ZM519.1,336H360a8,8,0,0,1,0-16H488a24,24,0,0,0,23.54-28.76C509.35,279.84,498.71,272,487.1,272H288l47.09-17.06a24,24,0,0,0-14.18-45.88L213.19,242.31A123.88,123.88,0,0,0,128,360v25.65a79.78,79.78,0,0,1,58,108.63A118.9,118.9,0,0,0,248,512H456a24,24,0,0,0,23.54-28.76C477.35,471.84,466.71,464,455.1,464H360a8,8,0,0,1,0-16H488a24,24,0,0,0,23.54-28.76C509.35,407.84,498.71,400,487.1,400H360a8,8,0,0,1,0-16H520a24,24,0,0,0,23.54-28.76C541.35,343.84,530.71,336,519.1,336ZM416,64a32,32,0,1,0-32-32A32,32,0,0,0,416,64ZM112,416a48,48,0,1,0,48,48A48,48,0,0,0,112,416Z"/></svg>
|
||||
|
After Width: | Height: | Size: 1.3 KiB |
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><path d="M358.59,195.6,504.2,313.8a63.4,63.4,0,0,1,22.21,37.91H624a16.05,16.05,0,0,0,16-16V143.91A16,16,0,0,0,624,128H512L457.41,73.41A32,32,0,0,0,434.8,64H348.91a32,32,0,0,0-21.61,8.41l-88.12,80.68-25.69-19.85L289.09,64H205.3a32,32,0,0,0-22.6,9.41l-20.34,20.3L45.47,3.38A16,16,0,0,0,23,6.19L3.38,31.46A16,16,0,0,0,6.19,53.91L594.54,508.63A16,16,0,0,0,617,505.82l19.64-25.27a16,16,0,0,0-2.81-22.45L303.4,202.72l32.69-29.92,27-24.7a16,16,0,0,1,21.61,23.61ZM16,128A16.05,16.05,0,0,0,0,144V335.91a16,16,0,0,0,16,16H146.3l90.5,81.89a64,64,0,0,0,90-9.3l.2-.2,17.91,15.5a37.16,37.16,0,0,0,52.29-5.39l8.8-10.82L23.56,128Z"/></svg>
|
||||
|
After Width: | Height: | Size: 685 B |
1
material/.icons/fontawesome/solid/handshake-slash.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><path d="M0,128.21V384H64a32,32,0,0,0,32-32V184L23.83,128.21ZM48,320.1a16,16,0,1,1-16,16A16,16,0,0,1,48,320.1Zm80,31.81h18.3l90.5,81.89a64,64,0,0,0,90-9.3l.2-.2,17.91,15.5a37.16,37.16,0,0,0,52.29-5.39l8.8-10.82L128,208.72Zm416-223.7V352.1a32,32,0,0,0,32,32h64V128.21ZM592,352.1a16,16,0,1,1,16-16A16,16,0,0,1,592,352.1ZM303.33,202.67l59.58-54.57a16,16,0,0,1,21.59,23.61L358.41,195.6,504,313.8a73.08,73.08,0,0,1,7.91,7.7V128L457.3,73.41A31.76,31.76,0,0,0,434.7,64H348.8a31.93,31.93,0,0,0-21.6,8.41l-88.07,80.64-25.64-19.81L289.09,64H205.3a32,32,0,0,0-22.6,9.41L162.36,93.72,45.47,3.38A16,16,0,0,0,23,6.19L3.38,31.46A16,16,0,0,0,6.19,53.91L594.53,508.63A16,16,0,0,0,617,505.82l19.65-25.27a16,16,0,0,0-2.82-22.45Z"/></svg>
|
||||
|
After Width: | Height: | Size: 780 B |
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><path d="M454.11,319.21c19.56-3.81,31.62-25,23.11-44.21-21-47.12-48.5-151.75-73.12-186.75A208.13,208.13,0,0,0,234.1,0H192A190.64,190.64,0,0,0,84.18,33.3L45.46,3.38A16,16,0,0,0,23,6.19L3.37,31.46A16,16,0,0,0,6.18,53.91L594.53,508.63A16,16,0,0,0,617,505.82l19.64-25.27a16,16,0,0,0-2.81-22.45ZM313.39,210.45,263.61,172c5.88-7.14,14.43-12,24.36-12a32.06,32.06,0,0,1,32,32C320,199,317.24,205.17,313.39,210.45ZM616,304a24,24,0,1,0-24-24A24,24,0,0,0,616,304Zm-64,64a24,24,0,1,0-24-24A24,24,0,0,0,552,368ZM288,384a32,32,0,0,1,32-32h19.54L20.73,105.59A190.86,190.86,0,0,0,0,192c0,56.75,24.75,107.62,64,142.88V512H288V480h64a64,64,0,0,0,64-64H320A32,32,0,0,1,288,384Zm328-24a24,24,0,1,0,24,24A24,24,0,0,0,616,360Z"/></svg>
|
||||
|
After Width: | Height: | Size: 774 B |
1
material/.icons/fontawesome/solid/head-side-cough.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><path d="M616,304a24,24,0,1,0-24-24A24,24,0,0,0,616,304ZM552,416a24,24,0,1,0,24,24A24,24,0,0,0,552,416Zm-64-56a24,24,0,1,0,24,24A24,24,0,0,0,488,360ZM616,464a24,24,0,1,0,24,24A24,24,0,0,0,616,464Zm0-104a24,24,0,1,0,24,24A24,24,0,0,0,616,360Zm-64-40a24,24,0,1,0,24,24A24,24,0,0,0,552,320Zm-74.78-45c-21-47.12-48.5-151.75-73.12-186.75A208.13,208.13,0,0,0,234.1,0H192C86,0,0,86,0,192c0,56.75,24.75,107.62,64,142.88V512H288V480h64a64,64,0,0,0,64-64H320a32,32,0,0,1,0-64h96V320h32A32,32,0,0,0,477.22,275ZM288,224a32,32,0,1,1,32-32A32.07,32.07,0,0,1,288,224Z"/></svg>
|
||||
|
After Width: | Height: | Size: 623 B |
1
material/.icons/fontawesome/solid/head-side-mask.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M.15,184.42C-2.17,244.21,23,298.06,64,334.88V512H224V316.51L3.67,156.25A182.28,182.28,0,0,0,.15,184.42ZM509.22,275c-21-47.12-48.5-151.75-73.12-186.75A208.11,208.11,0,0,0,266.11,0H200C117,0,42.48,50.57,13.25,123.65L239.21,288H511.76A31.35,31.35,0,0,0,509.22,275ZM320,224a32,32,0,1,1,32-32A32.07,32.07,0,0,1,320,224Zm16,144H496l16-48H256V512H401.88a64,64,0,0,0,60.71-43.76L464,464H336a16,16,0,0,1,0-32H474.67l10.67-32H336a16,16,0,0,1,0-32Z"/></svg>
|
||||
|
After Width: | Height: | Size: 517 B |
1
material/.icons/fontawesome/solid/head-side-virus.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M272,240a16,16,0,1,0,16,16A16,16,0,0,0,272,240Zm-64-64a16,16,0,1,0,16,16A16,16,0,0,0,208,176Zm301.2,99c-20.93-47.12-48.43-151.73-73.07-186.75A207.9,207.9,0,0,0,266.09,0H192C86,0,0,86,0,192A191.23,191.23,0,0,0,64,334.81V512H320V448h64a64,64,0,0,0,64-64V320H480A32,32,0,0,0,509.2,275ZM368,240H355.88c-28.51,0-42.79,34.47-22.63,54.63l8.58,8.57a16,16,0,1,1-22.63,22.63l-8.57-8.58C290.47,297.09,256,311.37,256,339.88V352a16,16,0,0,1-32,0V339.88c0-28.51-34.47-42.79-54.63-22.63l-8.57,8.58a16,16,0,0,1-22.63-22.63l8.58-8.57c20.16-20.16,5.88-54.63-22.63-54.63H112a16,16,0,0,1,0-32h12.12c28.51,0,42.79-34.47,22.63-54.63l-8.58-8.57a16,16,0,0,1,22.63-22.63l8.57,8.58c20.16,20.16,54.63,5.88,54.63-22.63V96a16,16,0,0,1,32,0v12.12c0,28.51,34.47,42.79,54.63,22.63l8.57-8.58a16,16,0,0,1,22.63,22.63l-8.58,8.57C313.09,173.53,327.37,208,355.88,208H368a16,16,0,0,1,0,32Z"/></svg>
|
||||
|
After Width: | Height: | Size: 931 B |
1
material/.icons/fontawesome/solid/hospital-user.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><path d="M480 320a96 96 0 1 0-96-96 96 96 0 0 0 96 96zm48 32a22.88 22.88 0 0 0-7.06 1.09 124.76 124.76 0 0 1-81.89 0A22.82 22.82 0 0 0 432 352a112 112 0 0 0-112 112.62c.14 26.26 21.73 47.38 48 47.38h224c26.27 0 47.86-21.12 48-47.38A112 112 0 0 0 528 352zm-198.09 10.45A145.19 145.19 0 0 1 352 344.62V128a32 32 0 0 0-32-32h-32V32a32 32 0 0 0-32-32H96a32 32 0 0 0-32 32v64H32a32 32 0 0 0-32 32v368a16 16 0 0 0 16 16h288.31A78.62 78.62 0 0 1 288 464.79a143.06 143.06 0 0 1 41.91-102.34zM144 404a12 12 0 0 1-12 12H92a12 12 0 0 1-12-12v-40a12 12 0 0 1 12-12h40a12 12 0 0 1 12 12zm0-128a12 12 0 0 1-12 12H92a12 12 0 0 1-12-12v-40a12 12 0 0 1 12-12h40a12 12 0 0 1 12 12zm48-122a6 6 0 0 1-6 6h-20a6 6 0 0 1-6-6v-26h-26a6 6 0 0 1-6-6v-20a6 6 0 0 1 6-6h26V70a6 6 0 0 1 6-6h20a6 6 0 0 1 6 6v26h26a6 6 0 0 1 6 6v20a6 6 0 0 1-6 6h-26zm80 250a12 12 0 0 1-12 12h-40a12 12 0 0 1-12-12v-40a12 12 0 0 1 12-12h40a12 12 0 0 1 12 12zm0-128a12 12 0 0 1-12 12h-40a12 12 0 0 1-12-12v-40a12 12 0 0 1 12-12h40a12 12 0 0 1 12 12z"/></svg>
|
||||
|
After Width: | Height: | Size: 1.0 KiB |
1
material/.icons/fontawesome/solid/house-user.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><path d="M570.69,236.27,512,184.44V48a16,16,0,0,0-16-16H432a16,16,0,0,0-16,16V99.67L314.78,10.3C308.5,4.61,296.53,0,288,0s-20.46,4.61-26.74,10.3l-256,226A18.27,18.27,0,0,0,0,248.2a18.64,18.64,0,0,0,4.09,10.71L25.5,282.7a21.14,21.14,0,0,0,12,5.3,21.67,21.67,0,0,0,10.69-4.11l15.9-14V480a32,32,0,0,0,32,32H480a32,32,0,0,0,32-32V269.88l15.91,14A21.94,21.94,0,0,0,538.63,288a20.89,20.89,0,0,0,11.87-5.31l21.41-23.81A21.64,21.64,0,0,0,576,248.19,21,21,0,0,0,570.69,236.27ZM288,176a64,64,0,1,1-64,64A64,64,0,0,1,288,176ZM400,448H176a16,16,0,0,1-16-16,96,96,0,0,1,96-96h64a96,96,0,0,1,96,96A16,16,0,0,1,400,448Z"/></svg>
|
||||
|
After Width: | Height: | Size: 675 B |
1
material/.icons/fontawesome/solid/laptop-house.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><path d="M272,288H208a16,16,0,0,1-16-16V208a16,16,0,0,1,16-16h64a16,16,0,0,1,16,16v37.12C299.11,232.24,315,224,332.8,224H469.74l6.65-7.53A16.51,16.51,0,0,0,480,207a16.31,16.31,0,0,0-4.75-10.61L416,144V48a16,16,0,0,0-16-16H368a16,16,0,0,0-16,16V87.3L263.5,8.92C258,4,247.45,0,240.05,0s-17.93,4-23.47,8.92L4.78,196.42A16.15,16.15,0,0,0,0,207a16.4,16.4,0,0,0,3.55,9.39L22.34,237.7A16.22,16.22,0,0,0,33,242.48,16.51,16.51,0,0,0,42.34,239L64,219.88V384a32,32,0,0,0,32,32H272ZM629.33,448H592V288c0-17.67-12.89-32-28.8-32H332.8c-15.91,0-28.8,14.33-28.8,32V448H266.67A10.67,10.67,0,0,0,256,458.67v10.66A42.82,42.82,0,0,0,298.6,512H597.4A42.82,42.82,0,0,0,640,469.33V458.67A10.67,10.67,0,0,0,629.33,448ZM544,448H352V304H544Z"/></svg>
|
||||
|
After Width: | Height: | Size: 786 B |
1
material/.icons/fontawesome/solid/lungs-virus.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><path d="M344,150.68V16A16,16,0,0,0,328,0H312a16,16,0,0,0-16,16V150.68a46.45,46.45,0,0,1,48,0ZM195.54,444.46a48.06,48.06,0,0,1,0-67.88l8.58-8.58H192a48,48,0,0,1,0-96h12.12l-8.58-8.57a48,48,0,0,1,60.46-74V161.75C256,125.38,224.62,96,186,96c-44,0-58,28.5-80.12,63.13a819.52,819.52,0,0,0-102,231A113.16,113.16,0,0,0,0,419.75C0,481,62.5,525.26,125.25,508.38l59.5-15.87a98.51,98.51,0,0,0,52.5-34.75,46.49,46.49,0,0,1-41.71-13.3Zm226.29-22.63a16,16,0,0,0,0-22.62l-8.58-8.58C393.09,370.47,407.37,336,435.88,336H448a16,16,0,0,0,0-32H435.88c-28.51,0-42.79-34.47-22.63-54.62l8.58-8.58a16,16,0,0,0-22.63-22.63l-8.57,8.58C370.47,246.91,336,232.63,336,204.12V192a16,16,0,0,0-32,0v12.12c0,28.51-34.47,42.79-54.63,22.63l-8.57-8.58a16,16,0,0,0-22.63,22.63l8.58,8.58c20.16,20.15,5.88,54.62-22.63,54.62H192a16,16,0,0,0,0,32h12.12c28.51,0,42.79,34.47,22.63,54.63l-8.58,8.58a16,16,0,1,0,22.63,22.62l8.57-8.57C269.53,393.1,304,407.38,304,435.88V448a16,16,0,0,0,32,0V435.88c0-28.5,34.47-42.78,54.63-22.62l8.57,8.57a16,16,0,0,0,22.63,0ZM288,304a16,16,0,1,1,16-16A16,16,0,0,1,288,304Zm64,64a16,16,0,1,1,16-16A16,16,0,0,1,352,368Zm284.12,22.13a819.52,819.52,0,0,0-102-231C512,124.5,498,96,454,96c-38.62,0-70,29.38-70,65.75v27.72a48,48,0,0,1,60.46,74L435.88,272H448a48,48,0,0,1,0,96H435.88l8.58,8.58a47.7,47.7,0,0,1-41.71,81.18,98.51,98.51,0,0,0,52.5,34.75l59.5,15.87C577.5,525.26,640,481,640,419.75A113.16,113.16,0,0,0,636.12,390.13Z"/></svg>
|
||||
|
After Width: | Height: | Size: 1.4 KiB |
1
material/.icons/fontawesome/solid/lungs.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><path d="M636.11 390.15C614.44 308.85 580.07 231 534.1 159.13 511.98 124.56 498.03 96 454.05 96 415.36 96 384 125.42 384 161.71v60.11l-32.88-21.92a15.996 15.996 0 0 1-7.12-13.31V16c0-8.84-7.16-16-16-16h-16c-8.84 0-16 7.16-16 16v170.59c0 5.35-2.67 10.34-7.12 13.31L256 221.82v-60.11C256 125.42 224.64 96 185.95 96c-43.98 0-57.93 28.56-80.05 63.13C59.93 231 25.56 308.85 3.89 390.15 1.3 399.84 0 409.79 0 419.78c0 61.23 62.48 105.44 125.24 88.62l59.5-15.95c42.18-11.3 71.26-47.47 71.26-88.62v-87.49l-85.84 57.23a7.992 7.992 0 0 1-11.09-2.22l-8.88-13.31a7.992 7.992 0 0 1 2.22-11.09L320 235.23l167.59 111.72a7.994 7.994 0 0 1 2.22 11.09l-8.88 13.31a7.994 7.994 0 0 1-11.09 2.22L384 316.34v87.49c0 41.15 29.08 77.31 71.26 88.62l59.5 15.95C577.52 525.22 640 481.01 640 419.78c0-9.99-1.3-19.94-3.89-29.63z"/></svg>
|
||||
|
After Width: | Height: | Size: 870 B |
1
material/.icons/fontawesome/solid/people-arrows.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><path d="M96,128A64,64,0,1,0,32,64,64,64,0,0,0,96,128Zm0,176.08a44.11,44.11,0,0,1,13.64-32L181.77,204c1.65-1.55,3.77-2.31,5.61-3.57A63.91,63.91,0,0,0,128,160H64A64,64,0,0,0,0,224v96a32,32,0,0,0,32,32V480a32,32,0,0,0,32,32h64a32,32,0,0,0,32-32V383.61l-50.36-47.53A44.08,44.08,0,0,1,96,304.08ZM480,128a64,64,0,1,0-64-64A64,64,0,0,0,480,128Zm32,32H448a63.91,63.91,0,0,0-59.38,40.42c1.84,1.27,4,2,5.62,3.59l72.12,68.06a44.37,44.37,0,0,1,0,64L416,383.62V480a32,32,0,0,0,32,32h64a32,32,0,0,0,32-32V352a32,32,0,0,0,32-32V224A64,64,0,0,0,512,160ZM444.4,295.34l-72.12-68.06A12,12,0,0,0,352,236v36H224V236a12,12,0,0,0-20.28-8.73L131.6,295.34a12.4,12.4,0,0,0,0,17.47l72.12,68.07A12,12,0,0,0,224,372.14V336H352v36.14a12,12,0,0,0,20.28,8.74l72.12-68.07A12.4,12.4,0,0,0,444.4,295.34Z"/></svg>
|
||||
|
After Width: | Height: | Size: 840 B |
1
material/.icons/fontawesome/solid/plane-slash.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><path d="M32.48,147.88,64,256,32.48,364.13A16,16,0,0,0,48,384H88a16,16,0,0,0,12.8-6.41L144,320H246.85l-49,171.59A16,16,0,0,0,213.2,512h65.5a16,16,0,0,0,13.89-8.06l66.6-116.54L34.35,136.34A15.47,15.47,0,0,0,32.48,147.88ZM633.82,458.09,455.14,320H512c35.34,0,96-28.66,96-64s-60.66-64-96-64H397.7L292.61,8.06C290.06,3.61,283.84,0,278.71,0H213.2a16,16,0,0,0-15.38,20.39l36.94,129.29L45.46,3.38A16,16,0,0,0,23,6.19L3.37,31.45A16,16,0,0,0,6.18,53.91L594.54,508.63A16,16,0,0,0,617,505.81l19.64-25.26A16,16,0,0,0,633.82,458.09Z"/></svg>
|
||||
|
After Width: | Height: | Size: 590 B |
1
material/.icons/fontawesome/solid/pump-medical.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512"><path d="M235.51,159.82H84.24A64,64,0,0,0,20.51,218L.14,442a64,64,0,0,0,63.74,69.8h192A64,64,0,0,0,319.61,442L299.24,218A64,64,0,0,0,235.51,159.82Zm4.37,173.33a13.35,13.35,0,0,1-13.34,13.34h-40v40a13.33,13.33,0,0,1-13.33,13.33H146.54a13.33,13.33,0,0,1-13.33-13.33v-40h-40a13.34,13.34,0,0,1-13.33-13.34V306.49a13.33,13.33,0,0,1,13.33-13.34h40v-40a13.33,13.33,0,0,1,13.33-13.33h26.67a13.33,13.33,0,0,1,13.33,13.33v40h40a13.34,13.34,0,0,1,13.34,13.34ZM379.19,93.88,335.87,50.56a64,64,0,0,0-45.24-18.74H223.88a32,32,0,0,0-32-32h-64a32,32,0,0,0-32,32v96h128v-32h66.75l43.31,43.31a16,16,0,0,0,22.63,0l22.62-22.62A16,16,0,0,0,379.19,93.88Z"/></svg>
|
||||
|
After Width: | Height: | Size: 703 B |
1
material/.icons/fontawesome/solid/pump-soap.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512"><path d="M235.63,160H84.37a64,64,0,0,0-63.74,58.21L.27,442.21A64,64,0,0,0,64,512H256a64,64,0,0,0,63.74-69.79l-20.36-224A64,64,0,0,0,235.63,160ZM160,416c-33.12,0-60-26.33-60-58.75,0-25,35.7-75.47,52-97.27A10,10,0,0,1,168,260c16.33,21.8,52,72.27,52,97.27C220,389.67,193.12,416,160,416ZM379.31,94.06,336,50.74A64,64,0,0,0,290.75,32H224A32,32,0,0,0,192,0H128A32,32,0,0,0,96,32v96H224V96h66.75l43.31,43.31a16,16,0,0,0,22.63,0l22.62-22.62A16,16,0,0,0,379.31,94.06Z"/></svg>
|
||||
|
After Width: | Height: | Size: 529 B |
1
material/.icons/fontawesome/solid/shield-virus.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M224,192a16,16,0,1,0,16,16A16,16,0,0,0,224,192ZM466.5,83.68l-192-80A57.4,57.4,0,0,0,256.05,0a57.4,57.4,0,0,0-18.46,3.67l-192,80A47.93,47.93,0,0,0,16,128C16,326.5,130.5,463.72,237.5,508.32a48.09,48.09,0,0,0,36.91,0C360.09,472.61,496,349.3,496,128A48,48,0,0,0,466.5,83.68ZM384,256H371.88c-28.51,0-42.79,34.47-22.63,54.63l8.58,8.57a16,16,0,1,1-22.63,22.63l-8.57-8.58C306.47,313.09,272,327.37,272,355.88V368a16,16,0,0,1-32,0V355.88c0-28.51-34.47-42.79-54.63-22.63l-8.57,8.58a16,16,0,0,1-22.63-22.63l8.58-8.57c20.16-20.16,5.88-54.63-22.63-54.63H128a16,16,0,0,1,0-32h12.12c28.51,0,42.79-34.47,22.63-54.63l-8.58-8.57a16,16,0,0,1,22.63-22.63l8.57,8.58c20.16,20.16,54.63,5.88,54.63-22.63V112a16,16,0,0,1,32,0v12.12c0,28.51,34.47,42.79,54.63,22.63l8.57-8.58a16,16,0,0,1,22.63,22.63l-8.58,8.57C329.09,189.53,343.37,224,371.88,224H384a16,16,0,0,1,0,32Zm-96,0a16,16,0,1,0,16,16A16,16,0,0,0,288,256Z"/></svg>
|
||||
|
After Width: | Height: | Size: 965 B |
1
material/.icons/fontawesome/solid/soap.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M416,192a95.42,95.42,0,0,1-30.94,70.21A95.8,95.8,0,0,1,352,448H160a96,96,0,0,1,0-192h88.91A95.3,95.3,0,0,1,224,192H96A96,96,0,0,0,0,288V416a96,96,0,0,0,96,96H416a96,96,0,0,0,96-96V288A96,96,0,0,0,416,192Zm-96,64a64,64,0,1,0-64-64A64,64,0,0,0,320,256ZM208,96a48,48,0,1,0-48-48A48,48,0,0,0,208,96ZM384,64a32,32,0,1,0-32-32A32,32,0,0,0,384,64ZM160,288a64,64,0,0,0,0,128H352a64,64,0,0,0,0-128Z"/></svg>
|
||||
|
After Width: | Height: | Size: 469 B |
1
material/.icons/fontawesome/solid/stopwatch-20.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M398.5,190.91l.59-.61,26.59-26.58a16,16,0,0,0,0-22.63L403,118.41a16,16,0,0,0-22.63,0l-24.68,24.68A206.68,206.68,0,0,0,256,98.5V64h32a16,16,0,0,0,16-16V16A16,16,0,0,0,288,0H160a16.05,16.05,0,0,0-16,16V48a16.05,16.05,0,0,0,16,16h32V98.5A207.92,207.92,0,0,0,16.09,297.57C12.64,411.5,106.76,510.22,220.72,512,337.13,513.77,432,420,432,304A206,206,0,0,0,398.5,190.91ZM204.37,377.55a8.2,8.2,0,0,1,8.32,8.07v22.31a8.2,8.2,0,0,1-8.32,8.07H121.52a16.46,16.46,0,0,1-16.61-17.62c2.78-35.22,14.67-57.41,38.45-91.37,20.42-29.19,27.1-37.32,27.1-62.34,0-16.92-1.79-24.27-12.21-24.27-9.39,0-12.69,7.4-12.69,22.68v5.23a8.2,8.2,0,0,1-8.33,8.07h-24.9a8.2,8.2,0,0,1-8.33-8.07v-4.07c0-27.3,8.48-60.24,56.43-60.24,43,0,55.57,25.85,55.57,61,0,35.58-12.44,51.21-34.35,81.31-11.56,15-24.61,35.57-26.41,51.2ZM344,352.32c0,35.16-12.3,63.68-57.23,63.68C243.19,416,232,386.48,232,352.55V247.22c0-40.73,19.58-63.22,56.2-63.22C325,184,344,206.64,344,245.3ZM287.87,221.73c-9.41,0-13.23,7.5-13.23,20V357.68c0,13.11,3.59,20.59,13.23,20.59s13-8,13-21.27V241.06C300.89,229.79,297.88,221.73,287.87,221.73Z"/></svg>
|
||||
|
After Width: | Height: | Size: 1.1 KiB |
1
material/.icons/fontawesome/solid/store-alt-slash.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><path d="M17.89,123.62,5.51,142.2c-14.2,21.3,1,49.8,26.59,49.8h74.26ZM576,413.42V224H512V364L384,265V224H330.92l-41.4-32H608c25.5,0,40.7-28.5,26.59-49.8l-85.29-128A32.18,32.18,0,0,0,522.6,0H117.42A31.87,31.87,0,0,0,90.81,14.2l-10.66,16L45.46,3.38A16,16,0,0,0,23,6.19L3.37,31.46A16,16,0,0,0,6.18,53.91L594.53,508.63A16,16,0,0,0,617,505.81l19.64-25.26a16,16,0,0,0-2.81-22.45ZM320,384H128V224H64V480a32,32,0,0,0,32,32H352a32,32,0,0,0,32-32V406.59l-64-49.47Z"/></svg>
|
||||
|
After Width: | Height: | Size: 525 B |
1
material/.icons/fontawesome/solid/store-slash.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><path d="M121.51,384V284.2a119.43,119.43,0,0,1-28,3.8,123.46,123.46,0,0,1-17.1-1.2,114.88,114.88,0,0,1-15.58-3.6V480c0,17.7,13.59,32,30.4,32H505.75L348.42,384Zm-28-128.09c25.1,0,47.29-10.72,64-27.24L24,120.05c-30.52,53.39-2.45,126.53,56.49,135A95.68,95.68,0,0,0,93.48,255.91ZM602.13,458.09,547.2,413.41V283.2a93.5,93.5,0,0,1-15.57,3.6,127.31,127.31,0,0,1-17.29,1.2,114.89,114.89,0,0,1-28-3.8v79.68L348.52,251.77a88.06,88.06,0,0,0,25.41,4.14c28.11,0,53-13,70.11-33.11,17.19,20.11,42.08,33.11,70.11,33.11a94.31,94.31,0,0,0,13-.91c59.66-8.41,88-82.8,56.06-136.4L521.55,15A30.1,30.1,0,0,0,495.81,0H112A30.11,30.11,0,0,0,86.27,15L76.88,30.78,43.19,3.38A14.68,14.68,0,0,0,21.86,6.19L3.2,31.45A16.58,16.58,0,0,0,5.87,53.91L564.81,508.63a14.69,14.69,0,0,0,21.33-2.82l18.66-25.26A16.58,16.58,0,0,0,602.13,458.09Z"/></svg>
|
||||
|
After Width: | Height: | Size: 874 B |
1
material/.icons/fontawesome/solid/toilet-paper-slash.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><path d="M64,192V364.13c0,41.12-9.75,62.75-31.12,126.87A16,16,0,0,0,48,512H328.86a31.87,31.87,0,0,0,30.38-21.87c9.31-27.83,18-53.35,22.18-85.55l-316-244.25C64.53,170.66,64,181.19,64,192ZM633.82,458.09l-102-78.81C575.28,360.91,608,284.32,608,192,608,86,565,0,512,0s-96,86-96,192c0,42,7,80.4,18.43,112L384,265V192c0-83.62,23.63-153.5,60.5-192H160c-23.33,0-44.63,16.83-61.26,44.53L45.46,3.38A16,16,0,0,0,23,6.19L3.37,31.45A16,16,0,0,0,6.18,53.91L594.54,508.63A16,16,0,0,0,617,505.81l19.64-25.26A16,16,0,0,0,633.82,458.09ZM512,256c-17.63,0-32-28.62-32-64s14.37-64,32-64,32,28.63,32,64S529.62,256,512,256Z"/></svg>
|
||||
|
After Width: | Height: | Size: 671 B |
1
material/.icons/fontawesome/solid/virus-slash.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><path d="M114,227.56H92.44a28.44,28.44,0,0,0,0,56.88H114c50.68,0,76.06,61.28,40.23,97.12L139,396.81A28.44,28.44,0,1,0,179.19,437l15.25-15.25c35.84-35.84,97.11-10.45,97.11,40.23v21.54a28.45,28.45,0,0,0,56.9,0V462c0-26.61,17-45.91,38.22-53.37l-244.5-189A55.58,55.58,0,0,1,114,227.56ZM633.82,458.09,470.62,332c4.17-25.39,24.91-47.52,55.39-47.52h21.55a28.44,28.44,0,1,0,0-56.88H526c-50.68,0-76.06-61.28-40.23-97.12L501,115.19A28.44,28.44,0,0,0,460.81,75L445.56,90.22c-35.84,35.84-97.11,10.46-97.11-40.23V28.45a28.45,28.45,0,0,0-56.9,0V50c0,50.69-61.27,76.07-97.11,40.23L179.19,75A28.43,28.43,0,0,0,139,75c-.13.14-.15.32-.28.46L45.46,3.38A16,16,0,0,0,23,6.19L3.37,31.45A16,16,0,0,0,6.18,53.91L594.54,508.63A16,16,0,0,0,617,505.81l19.64-25.26A16,16,0,0,0,633.82,458.09ZM335.43,227.48l-62.87-48.59A46.55,46.55,0,0,1,288,176a48,48,0,0,1,48,48C336,225.22,335.52,226.29,335.43,227.48Z"/></svg>
|
||||
|
After Width: | Height: | Size: 945 B |
1
material/.icons/fontawesome/solid/virus.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M483.55,227.55H462c-50.68,0-76.07-61.27-40.23-97.11L437,115.19A28.44,28.44,0,0,0,396.8,75L381.56,90.22c-35.84,35.83-97.11,10.45-97.11-40.23V28.44a28.45,28.45,0,0,0-56.9,0V50c0,50.68-61.27,76.06-97.11,40.23L115.2,75A28.44,28.44,0,0,0,75,115.19l15.25,15.25c35.84,35.84,10.45,97.11-40.23,97.11H28.45a28.45,28.45,0,1,0,0,56.89H50c50.68,0,76.07,61.28,40.23,97.12L75,396.8A28.45,28.45,0,0,0,115.2,437l15.24-15.25c35.84-35.84,97.11-10.45,97.11,40.23v21.54a28.45,28.45,0,0,0,56.9,0V462c0-50.68,61.27-76.07,97.11-40.23L396.8,437A28.45,28.45,0,0,0,437,396.8l-15.25-15.24c-35.84-35.84-10.45-97.12,40.23-97.12h21.54a28.45,28.45,0,1,0,0-56.89ZM224,272a48,48,0,1,1,48-48A48,48,0,0,1,224,272Zm80,56a24,24,0,1,1,24-24A24,24,0,0,1,304,328Z"/></svg>
|
||||
|
After Width: | Height: | Size: 802 B |
1
material/.icons/fontawesome/solid/viruses.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><path d="M624,352H611.88c-28.51,0-42.79-34.47-22.63-54.63l8.58-8.57a16,16,0,1,0-22.63-22.63l-8.57,8.58C546.47,294.91,512,280.63,512,252.12V240a16,16,0,0,0-32,0v12.12c0,28.51-34.47,42.79-54.63,22.63l-8.57-8.58a16,16,0,0,0-22.63,22.63l8.58,8.57c20.16,20.16,5.88,54.63-22.63,54.63H368a16,16,0,0,0,0,32h12.12c28.51,0,42.79,34.47,22.63,54.63l-8.58,8.57a16,16,0,1,0,22.63,22.63l8.57-8.58c20.16-20.16,54.63-5.88,54.63,22.63V496a16,16,0,0,0,32,0V483.88c0-28.51,34.47-42.79,54.63-22.63l8.57,8.58a16,16,0,1,0,22.63-22.63l-8.58-8.57C569.09,418.47,583.37,384,611.88,384H624a16,16,0,0,0,0-32ZM480,384a32,32,0,1,1,32-32A32,32,0,0,1,480,384ZM346.51,213.33h16.16a21.33,21.33,0,0,0,0-42.66H346.51c-38,0-57.05-46-30.17-72.84l11.43-11.44A21.33,21.33,0,0,0,297.6,56.23L286.17,67.66c-26.88,26.88-72.84,7.85-72.84-30.17V21.33a21.33,21.33,0,0,0-42.66,0V37.49c0,38-46,57.05-72.84,30.17L86.4,56.23A21.33,21.33,0,0,0,56.23,86.39L67.66,97.83c26.88,26.88,7.85,72.84-30.17,72.84H21.33a21.33,21.33,0,0,0,0,42.66H37.49c38,0,57.05,46,30.17,72.84L56.23,297.6A21.33,21.33,0,1,0,86.4,327.77l11.43-11.43c26.88-26.88,72.84-7.85,72.84,30.17v16.16a21.33,21.33,0,0,0,42.66,0V346.51c0-38,46-57.05,72.84-30.17l11.43,11.43a21.33,21.33,0,0,0,30.17-30.17l-11.43-11.43C289.46,259.29,308.49,213.33,346.51,213.33ZM160,192a32,32,0,1,1,32-32A32,32,0,0,1,160,192Zm80,32a16,16,0,1,1,16-16A16,16,0,0,1,240,224Z"/></svg>
|
||||
|
After Width: | Height: | Size: 1.4 KiB |
|
Before Width: | Height: | Size: 1.8 KiB After Width: | Height: | Size: 1.8 KiB |
2
material/assets/javascripts/bundle.0f38e514.min.js
vendored
Normal file
1
material/assets/javascripts/bundle.0f38e514.min.js.map
Normal file
31
material/assets/javascripts/vendor.d7126665.min.js
vendored
Normal file
1
material/assets/javascripts/vendor.d7126665.min.js.map
Normal file
59
material/assets/javascripts/worker/search.58d22e8e.min.js
vendored
Normal file
@@ -1,10 +1,12 @@
|
||||
{
|
||||
"assets/javascripts/bundle.js": "assets/javascripts/bundle.e2842e12.min.js",
|
||||
"assets/javascripts/bundle.js.map": "assets/javascripts/bundle.e2842e12.min.js.map",
|
||||
"assets/javascripts/vendor.js": "assets/javascripts/vendor.0c35f0aa.min.js",
|
||||
"assets/javascripts/vendor.js.map": "assets/javascripts/vendor.0c35f0aa.min.js.map",
|
||||
"assets/javascripts/worker/search.js": "assets/javascripts/worker/search.2613054f.min.js",
|
||||
"assets/javascripts/worker/search.js.map": "assets/javascripts/worker/search.2613054f.min.js.map",
|
||||
"assets/stylesheets/main.css": "assets/stylesheets/main.2331f4ab.min.css",
|
||||
"assets/stylesheets/palette.css": "assets/stylesheets/palette.e9ae9b85.min.css"
|
||||
"assets/javascripts/bundle.js": "assets/javascripts/bundle.0f38e514.min.js",
|
||||
"assets/javascripts/bundle.js.map": "assets/javascripts/bundle.0f38e514.min.js.map",
|
||||
"assets/javascripts/vendor.js": "assets/javascripts/vendor.d7126665.min.js",
|
||||
"assets/javascripts/vendor.js.map": "assets/javascripts/vendor.d7126665.min.js.map",
|
||||
"assets/javascripts/worker/search.js": "assets/javascripts/worker/search.58d22e8e.min.js",
|
||||
"assets/javascripts/worker/search.js.map": "assets/javascripts/worker/search.58d22e8e.min.js.map",
|
||||
"assets/stylesheets/main.css": "assets/stylesheets/main.53de219a.min.css",
|
||||
"assets/stylesheets/main.css.map": "assets/stylesheets/main.53de219a.min.css.map",
|
||||
"assets/stylesheets/palette.css": "assets/stylesheets/palette.14da9d3a.min.css",
|
||||
"assets/stylesheets/palette.css.map": "assets/stylesheets/palette.14da9d3a.min.css.map"
|
||||
}
|
||||
3
material/assets/stylesheets/main.53de219a.min.css
vendored
Normal file
1
material/assets/stylesheets/main.53de219a.min.css.map
Normal file
1
material/assets/stylesheets/palette.14da9d3a.min.css.map
Normal file
@@ -29,7 +29,7 @@
|
||||
<meta name="author" content="{{ config.site_author }}">
|
||||
{% endif %}
|
||||
<link rel="shortcut icon" href="{{ config.theme.favicon | url }}">
|
||||
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-5.0.0rc3">
|
||||
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-5.1.1">
|
||||
{% endblock %}
|
||||
{% block htmltitle %}
|
||||
{% if page and page.meta and page.meta.title %}
|
||||
@@ -41,9 +41,9 @@
|
||||
{% endif %}
|
||||
{% endblock %}
|
||||
{% block styles %}
|
||||
<link rel="stylesheet" href="{{ 'assets/stylesheets/main.2331f4ab.min.css' | url }}">
|
||||
<link rel="stylesheet" href="{{ 'assets/stylesheets/main.53de219a.min.css' | url }}">
|
||||
{% if palette.primary or palette.accent %}
|
||||
<link rel="stylesheet" href="{{ 'assets/stylesheets/palette.e9ae9b85.min.css' | url }}">
|
||||
<link rel="stylesheet" href="{{ 'assets/stylesheets/palette.14da9d3a.min.css' | url }}">
|
||||
{% endif %}
|
||||
{% if palette.primary %}
|
||||
{% import "partials/palette.html" as map %}
|
||||
@@ -88,19 +88,23 @@
|
||||
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
||||
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
||||
<label class="md-overlay" for="__drawer"></label>
|
||||
{% if page.toc | first is defined %}
|
||||
{% set skip = page.toc | first %}
|
||||
<a href="{{ skip.url | url }}" class="md-skip" data-md-component="skip">
|
||||
{{ lang.t('skip.link.title') }}
|
||||
</a>
|
||||
{% endif %}
|
||||
{% if self.announce() %}
|
||||
<aside class="md-announce" data-md-component="announce">
|
||||
<div class="md-announce__inner md-grid md-typeset">
|
||||
{% block announce %}{% endblock %}
|
||||
</div>
|
||||
</aside>
|
||||
{% endif %}
|
||||
<div data-md-component="skip">
|
||||
{% if page.toc | first is defined %}
|
||||
{% set skip = page.toc | first %}
|
||||
<a href="{{ skip.url | url }}" class="md-skip">
|
||||
{{ lang.t('skip.link.title') }}
|
||||
</a>
|
||||
{% endif %}
|
||||
</div>
|
||||
<div data-md-component="announce">
|
||||
{% if self.announce() %}
|
||||
<aside class="md-announce">
|
||||
<div class="md-announce__inner md-grid md-typeset">
|
||||
{% block announce %}{% endblock %}
|
||||
</div>
|
||||
</aside>
|
||||
{% endif %}
|
||||
</div>
|
||||
{% block header %}
|
||||
{% include "partials/header.html" %}
|
||||
{% endblock %}
|
||||
@@ -173,12 +177,9 @@
|
||||
{% include "partials/footer.html" %}
|
||||
{% endblock %}
|
||||
</div>
|
||||
{% block config %}
|
||||
<script>var __config={}</script>
|
||||
{% endblock %}
|
||||
{% block scripts %}
|
||||
<script src="{{ 'assets/javascripts/vendor.0c35f0aa.min.js' | url }}"></script>
|
||||
<script src="{{ 'assets/javascripts/bundle.e2842e12.min.js' | url }}"></script>
|
||||
<script src="{{ 'assets/javascripts/vendor.d7126665.min.js' | url }}"></script>
|
||||
<script src="{{ 'assets/javascripts/bundle.0f38e514.min.js' | url }}"></script>
|
||||
{%- set translations = {} -%}
|
||||
{%- for key in [
|
||||
"clipboard.copy",
|
||||
@@ -194,18 +195,17 @@
|
||||
{%- set _ = translations.update({ key: lang.t(key) }) -%}
|
||||
{%- endfor -%}
|
||||
<script id="__lang" type="application/json">
|
||||
{{ translations | tojson }}
|
||||
{{- translations | tojson -}}
|
||||
</script>
|
||||
{% block config %}{% endblock %}
|
||||
<script>
|
||||
__material = initialize(Object.assign({
|
||||
url: {
|
||||
base: "{{ base_url }}",
|
||||
worker: {
|
||||
search: "{{ 'assets/javascripts/worker/search.2613054f.min.js' | url }}"
|
||||
}
|
||||
},
|
||||
features: {{ config.theme.features | tojson }}
|
||||
}, typeof __config !== "undefined" ? __config : {}))
|
||||
app = initialize({
|
||||
base: "{{ base_url }}",
|
||||
features: {{ config.theme.features | tojson }},
|
||||
search: Object.assign({
|
||||
worker: "{{ 'assets/javascripts/worker/search.58d22e8e.min.js' | url }}"
|
||||
}, typeof search !== "undefined" && search)
|
||||
})
|
||||
</script>
|
||||
{% for path in config["extra_javascript"] %}
|
||||
<script src="{{ path | url }}"></script>
|
||||
|
||||
@@ -1,7 +1,29 @@
|
||||
{#-
|
||||
This file was automatically generated - do not edit
|
||||
-#}
|
||||
{% extends "base.html" %}
|
||||
{% block announce %}
|
||||
Material for MkDocs 5.0.0rc3
|
||||
{% extends "overrides/main.html" %}
|
||||
{% block tabs %}
|
||||
{{ super() }}
|
||||
<style>.md-header{position:initial}.md-main__inner{margin:0}.md-content{display:none}.tx-container{padding-top:1rem;background:url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 1123 258'><path d='M1124,2c0,0 0,256 0,256l-1125,0l0,-48c0,0 16,5 55,5c116,0 197,-92 325,-92c121,0 114,46 254,46c140,0 214,-167 572,-166Z' style='fill: white' /></svg>") no-repeat bottom,linear-gradient(to bottom,var(--md-primary-fg-color),hsla(160deg,47%,55%,1) 99%,#fff 99%)}.tx-hero{margin:0 .8rem;color:var(--md-primary-bg-color)}.tx-hero h1{margin-bottom:1rem;color:currentColor;font-weight:700}.tx-hero__content{padding-bottom:6rem}.tx-hero .md-button{margin-top:.5rem;margin-right:.5rem;color:var(--md-primary-bg-color)}.tx-hero .md-button--primary{background-color:var(--md-primary-bg-color);color:hsla(193deg,37%,48%,1);border-color:var(--md-primary-bg-color)}.tx-hero .md-button:focus,.tx-hero .md-button:hover{background-color:var(--md-accent-fg-color);color:var(--md-default-bg-color);border-color:var(--md-accent-fg-color)}@media screen and (max-width:30em){.tx-hero h1{font-size:1.4rem}}@media screen and (min-width:60em){.md-sidebar--secondary{display:none}.tx-hero{display:flex;align-items:stretch}.tx-hero__content{max-width:19rem;margin-top:3.5rem;padding-bottom:14vw}.tx-hero__image{width:38rem;order:1;transform:translateX(4rem)}}@media screen and (min-width:76.25em){.md-sidebar--primary{display:none}.tx-hero__image{transform:translateX(8rem)}}</style>
|
||||
<section class="tx-container">
|
||||
<div class="md-grid md-typeset">
|
||||
<div class="tx-hero">
|
||||
<div class="tx-hero__image">
|
||||
<img src="assets/images/illustration.png" alt="" draggable="false">
|
||||
</div>
|
||||
<div class="tx-hero__content">
|
||||
<h1>Technical documentation that just works</h1>
|
||||
<p>{{ config.site_description }}. Set up in 5 minutes.</p>
|
||||
<a href="{{ page.next_page.url | url }}" title="{{ page.next_page.title | striptags }}" class="md-button md-button--primary">
|
||||
Get started
|
||||
</a>
|
||||
<a href="{{ config.repo_url }}" title="{{ lang.t('source.link.title') }}" class="md-button">
|
||||
Go to GitHub
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
{% endblock %}
|
||||
{% block content %}{% endblock %}
|
||||
{% block footer %}{% endblock %}
|
||||
|
||||
37
material/overrides/main.html
Normal file
@@ -0,0 +1,37 @@
|
||||
{#-
|
||||
This file was automatically generated - do not edit
|
||||
-#}
|
||||
{% extends "base.html" %}
|
||||
{% block extrahead %}
|
||||
{% set title = config.site_name %}
|
||||
{% if page and page.title and not page.is_homepage %}
|
||||
{% set title = config.site_name ~ " - " ~ page.title | striptags %}
|
||||
{% endif %}
|
||||
{% set image = config.site_url ~ 'assets/images/banner.png' %}
|
||||
<meta property="og:type" content="website">
|
||||
<meta property="og:title" content="{{ title }}">
|
||||
<meta property="og:description" content="{{ config.site_description }}">
|
||||
<meta property="og:url" content="{{ page.canonical_url }}">
|
||||
<meta property="og:image" content="{{ image }}">
|
||||
<meta property="og:image:type" content="image/png">
|
||||
<meta property="og:image:width" content="1200">
|
||||
<meta property="og:image:height" content="630">
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="twitter:site" content="@squidfunk">
|
||||
<meta name="twitter:creator" content="@squidfunk">
|
||||
<meta name="twitter:title" content="{{ title }}">
|
||||
<meta name="twitter:description" content="{{ config.site_description }}">
|
||||
<meta name="twitter:image" content="{{ image }}">
|
||||
{% endblock %}
|
||||
{% block announce %}
|
||||
<style>.md-announce a,.md-announce a:focus,.md-announce a:hover{color:currentColor}.md-announce strong{white-space:nowrap}.md-announce .twitter{margin-left:.2em;color:#00acee}</style>
|
||||
<a href="https://twitter.com/squidfunk">
|
||||
For updates follow <strong>@squidfunk</strong> on
|
||||
<span class="twemoji twitter">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512">
|
||||
<path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"></path>
|
||||
</svg>
|
||||
</span>
|
||||
<strong>Twitter</strong>
|
||||
</a>
|
||||
{% endblock %}
|
||||
@@ -47,11 +47,7 @@
|
||||
{{ config.copyright }}
|
||||
</div>
|
||||
{% endif %}
|
||||
powered by
|
||||
<a href="https://www.mkdocs.org" target="_blank" rel="noopener">
|
||||
MkDocs
|
||||
</a>
|
||||
and
|
||||
Made with
|
||||
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
||||
Material for MkDocs
|
||||
</a>
|
||||
|
||||
@@ -4,38 +4,31 @@
|
||||
<header class="md-header" data-md-component="header">
|
||||
<nav class="md-header-nav md-grid" aria-label="{{ lang.t('header.title') }}">
|
||||
<a href="{{ config.site_url | default(nav.homepage.url, true) | url }}" title="{{ config.site_name }}" class="md-header-nav__button md-logo" aria-label="{{ config.site_name }}">
|
||||
{% if config.theme.logo %}
|
||||
<img src="{{ config.theme.logo | url }}" alt="logo">
|
||||
{% else %}
|
||||
{% set icon = config.theme.icon.logo or "material/library" %}
|
||||
{% include ".icons/" ~ icon ~ ".svg" %}
|
||||
{% endif %}
|
||||
{% include "partials/logo.html" %}
|
||||
</a>
|
||||
<label class="md-header-nav__button md-icon" for="__drawer">
|
||||
{% include ".icons/material/menu" ~ ".svg" %}
|
||||
</label>
|
||||
<div class="md-header-nav__title" data-md-component="header-title">
|
||||
<div class="md-header-nav__ellipsis md-ellipsis">
|
||||
{% if config.site_name == page.title %}
|
||||
{% if config.site_name == page.title %}
|
||||
<div class="md-header-nav__ellipsis md-ellipsis">
|
||||
{{ config.site_name }}
|
||||
{% else %}
|
||||
<span class="md-header-nav__topic">
|
||||
</div>
|
||||
{% else %}
|
||||
<div class="md-header-nav__ellipsis">
|
||||
<span class="md-header-nav__topic md-ellipsis">
|
||||
{{ config.site_name }}
|
||||
</span>
|
||||
<span class="md-header-nav__topic">
|
||||
<span class="md-header-nav__topic md-ellipsis">
|
||||
{% if page and page.meta and page.meta.title %}
|
||||
{{ page.meta.title }}
|
||||
{% else %}
|
||||
{{ page.title }}
|
||||
{% endif %}
|
||||
</span>
|
||||
{% endif %}
|
||||
</div>
|
||||
</div>
|
||||
{% endif %}
|
||||
</div>
|
||||
<label class="md-header-nav__button md-icon" for="__more">
|
||||
{% include ".icons/material/dots-vertical" ~ ".svg" %}
|
||||
</label>
|
||||
{% include "partials/more.html" %}
|
||||
{% if "search" in config["plugins"] %}
|
||||
<label class="md-header-nav__button md-icon" for="__search">
|
||||
{% include ".icons/material/magnify.svg" %}
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
"header.title": "Cabecera",
|
||||
"meta.comments": "Comentarios",
|
||||
"meta.source": "Fuente",
|
||||
"nav.title": "Navegación"
|
||||
"nav.title": "Navegación",
|
||||
"search.config.lang": "es",
|
||||
"search.placeholder": "Búsqueda",
|
||||
"search.reset": "Limpiar",
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
"search.result.one": "找到 1 个符合條件的結果",
|
||||
"search.result.other": "# 個符合條件的結果",
|
||||
"skip.link.title": "跳轉至",
|
||||
"source.link.title": "前往 Github 倉庫",
|
||||
"source.link.title": "前往 GitHub 倉庫",
|
||||
"source.revision.date": "最後更新",
|
||||
"toc.title": "目錄"
|
||||
}[key] }}{% endmacro %}
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
"meta.comments": "留言",
|
||||
"meta.source": "來源",
|
||||
"search.config.lang": "ja",
|
||||
"search.config.separator": "[\,\。]+",
|
||||
"search.config.separator": "[\s\- 、。,.?;]+",
|
||||
"search.placeholder": "搜尋",
|
||||
"search.result.placeholder": "打字進行搜尋",
|
||||
"search.result.none": "沒有符合的項目",
|
||||
@@ -19,5 +19,6 @@
|
||||
"search.result.other": "找到 # 個符合的項目",
|
||||
"skip.link.title": "跳轉到",
|
||||
"source.link.title": "前往倉庫",
|
||||
"toc.title": "本頁目錄"
|
||||
"source.revision.date": "最後更新",
|
||||
"toc.title": "目錄"
|
||||
}[key] }}{% endmacro %}
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
"search.result.one": "找到 1 个符合条件的结果",
|
||||
"search.result.other": "# 个符合条件的结果",
|
||||
"skip.link.title": "跳转至",
|
||||
"source.link.title": "前往 Github 仓库",
|
||||
"source.link.title": "前往 GitHub 仓库",
|
||||
"source.revision.date": "最后更新",
|
||||
"toc.title": "目录"
|
||||
}[key] }}{% endmacro %}
|
||||
|
||||
9
material/partials/logo.html
Normal file
@@ -0,0 +1,9 @@
|
||||
{#-
|
||||
This file was automatically generated - do not edit
|
||||
-#}
|
||||
{% if config.theme.logo %}
|
||||
<img src="{{ config.theme.logo | url }}" alt="logo">
|
||||
{% else %}
|
||||
{% set icon = config.theme.icon.logo or "material/library" %}
|
||||
{% include ".icons/" ~ icon ~ ".svg" %}
|
||||
{% endif %}
|
||||
@@ -4,12 +4,7 @@
|
||||
<nav class="md-nav md-nav--primary" aria-label="{{ lang.t('nav.title') }}" data-md-level="0">
|
||||
<label class="md-nav__title" for="__drawer">
|
||||
<a href="{{ config.site_url | default(nav.homepage.url, true) | url }}" title="{{ config.site_name }}" class="md-nav__button md-logo" aria-label="{{ config.site_name }}">
|
||||
{% if config.theme.logo %}
|
||||
<img src="{{ config.theme.logo | url }}" alt="logo">
|
||||
{% else %}
|
||||
{% set icon = config.theme.icon.logo or "material/library" %}
|
||||
{% include ".icons/" ~ icon ~ ".svg" %}
|
||||
{% endif %}
|
||||
{% include "partials/logo.html" %}
|
||||
</a>
|
||||
{{ config.site_name }}
|
||||
</label>
|
||||
|
||||
18
mkdocs.yml
@@ -20,9 +20,12 @@
|
||||
|
||||
# Project information
|
||||
site_name: Material for MkDocs
|
||||
site_description: A Material Design theme for MkDocs
|
||||
site_author: Martin Donath
|
||||
site_url: https://squidfunk.github.io/mkdocs-material/
|
||||
site_author: Martin Donath
|
||||
site_description: >-
|
||||
Create a branded static site from a set of Markdown files to host the
|
||||
documentation of your Open Source or commercial project – customizable,
|
||||
searchable, mobile-friendly, 40+ languages
|
||||
|
||||
# Repository
|
||||
repo_name: squidfunk/mkdocs-material
|
||||
@@ -49,7 +52,7 @@ theme:
|
||||
language: en
|
||||
features:
|
||||
- tabs
|
||||
# - instant
|
||||
#- instant
|
||||
palette:
|
||||
primary: indigo
|
||||
accent: indigo
|
||||
@@ -85,6 +88,7 @@ extra:
|
||||
# Extensions
|
||||
markdown_extensions:
|
||||
- markdown.extensions.admonition
|
||||
- markdown.extensions.attr_list
|
||||
- markdown.extensions.codehilite:
|
||||
guess_lang: false
|
||||
- markdown.extensions.def_list
|
||||
@@ -99,8 +103,8 @@ markdown_extensions:
|
||||
- pymdownx.critic
|
||||
- pymdownx.details
|
||||
- pymdownx.emoji:
|
||||
emoji_index: !!python/name:pymdownx.emoji.twemoji
|
||||
emoji_generator: !!python/name:pymdownx.emoji.to_svg
|
||||
emoji_index: !!python/name:materialx.emoji.twemoji
|
||||
emoji_generator: !!python/name:materialx.emoji.to_svg
|
||||
# - pymdownx.highlight:
|
||||
# linenums_style: pymdownx-inline
|
||||
- pymdownx.inlinehilite
|
||||
@@ -136,8 +140,8 @@ nav:
|
||||
- Revision date: plugins/revision-date.md
|
||||
- Awesome pages: plugins/awesome-pages.md
|
||||
- Releases:
|
||||
- Material for MkDocs 5: releases/5.md
|
||||
- Material for MkDocs 4: releases/4.md
|
||||
- Upgrading to 5.x: releases/5.md
|
||||
- Upgrading to 4.x: releases/4.md
|
||||
- Changelog: releases/changelog.md
|
||||
- Customization: customization.md
|
||||
- Data privacy: data-privacy.md
|
||||
|
||||
@@ -22,5 +22,5 @@
|
||||
publish = "site"
|
||||
command = """
|
||||
pip install mkdocs-minify-plugin
|
||||
mkdocs build
|
||||
python -m mkdocs build
|
||||
"""
|
||||
|
||||
7461
package-lock.json
generated
41
package.json
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "mkdocs-material",
|
||||
"version": "5.0.0rc3",
|
||||
"version": "5.1.1",
|
||||
"description": "A Material Design theme for MkDocs",
|
||||
"keywords": [
|
||||
"mkdocs",
|
||||
@@ -27,8 +27,8 @@
|
||||
"build": "npm run clean && npx webpack --mode production",
|
||||
"clean": "npx rimraf material",
|
||||
"lint": "npm run lint:ts && npm run lint:scss",
|
||||
"lint:scss": "npx stylelint `find src/assets -name *.scss`",
|
||||
"lint:ts": "npx tslint -p tsconfig.json 'src/**/*.ts'",
|
||||
"lint:scss": "npx stylelint \"src/assets/**/*.scss\"",
|
||||
"lint:ts": "npx tslint -p tsconfig.json \"src/**/*.ts\"",
|
||||
"start": "npx webpack --mode development --watch"
|
||||
},
|
||||
"dependencies": {
|
||||
@@ -37,57 +37,58 @@
|
||||
"lunr": "^2.3.8",
|
||||
"lunr-languages": "^1.4.0",
|
||||
"ramda": "^0.27.0",
|
||||
"rxjs": "^7.0.0-alpha.1"
|
||||
"rxjs": "^7.0.0-beta.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@fortawesome/fontawesome-free": "^5.12.1",
|
||||
"@fortawesome/fontawesome-free": "^5.13.0",
|
||||
"@primer/octicons": "^9.6.0",
|
||||
"@types/clipboard": "^2.0.1",
|
||||
"@types/copy-webpack-plugin": "^5.0.0",
|
||||
"@types/escape-html": "0.0.20",
|
||||
"@types/event-hooks-webpack-plugin": "^2.0.0",
|
||||
"@types/html-minifier": "^3.5.3",
|
||||
"@types/lunr": "^2.3.2",
|
||||
"@types/node": "^13.9.1",
|
||||
"@types/ramda": "^0.26.44",
|
||||
"@types/lunr": "^2.3.3",
|
||||
"@types/mini-css-extract-plugin": "^0.9.1",
|
||||
"@types/node": "^13.13.0",
|
||||
"@types/ramda": "^0.27.3",
|
||||
"@types/resize-observer-browser": "^0.1.3",
|
||||
"@types/webpack": "^4.41.7",
|
||||
"@types/webpack": "^4.41.12",
|
||||
"@types/webpack-assets-manifest": "^3.0.0",
|
||||
"autoprefixer": "^9.7.4",
|
||||
"autoprefixer": "^9.7.6",
|
||||
"copy-webpack-plugin": "^5.1.1",
|
||||
"css-loader": "^3.4.2",
|
||||
"css-loader": "^3.5.2",
|
||||
"css-mqpacker": "^7.0.0",
|
||||
"event-hooks-webpack-plugin": "^2.1.6",
|
||||
"expose-loader": "^0.7.5",
|
||||
"extract-loader": "^5.0.1",
|
||||
"file-loader": "^6.0.0",
|
||||
"github-types": "^1.0.0",
|
||||
"gitlab": "^14.2.2",
|
||||
"html-minifier": "^4.0.0",
|
||||
"ignore-emit-webpack-plugin": "^2.0.2",
|
||||
"material-design-color": "^2.3.2",
|
||||
"material-design-icons-svg": "^3.0.0",
|
||||
"material-shadows": "^3.0.1",
|
||||
"mini-css-extract-plugin": "^0.9.0",
|
||||
"modularscale-sass": "^3.0.10",
|
||||
"postcss-loader": "^3.0.0",
|
||||
"preact": "^10.3.4",
|
||||
"preact": "^10.4.0",
|
||||
"resize-observer-polyfill": "^1.5.1",
|
||||
"rimraf": "^3.0.2",
|
||||
"sass": "^1.26.3",
|
||||
"sass-loader": "^8.0.2",
|
||||
"string-replace-loader": "^2.2.0",
|
||||
"stylelint": "^13.2.1",
|
||||
"string-replace-loader": "^2.3.0",
|
||||
"stylelint": "^13.3.2",
|
||||
"stylelint-config-rational-order": "^0.1.2",
|
||||
"stylelint-config-standard": "^20.0.0",
|
||||
"stylelint-order": "^4.0.0",
|
||||
"stylelint-scss": "^3.15.0",
|
||||
"ts-loader": "^6.2.1",
|
||||
"ts-node": "^8.6.2",
|
||||
"stylelint-scss": "^3.17.0",
|
||||
"ts-loader": "^7.0.1",
|
||||
"ts-node": "^8.8.2",
|
||||
"tsconfig-paths-webpack-plugin": "^3.2.0",
|
||||
"tslib": "^1.11.1",
|
||||
"tslint": "^5.20.1",
|
||||
"tslint-sonarts": "^1.9.0",
|
||||
"typescript": "^3.8.3",
|
||||
"webpack": "^4.42.0",
|
||||
"webpack": "^4.42.1",
|
||||
"webpack-assets-manifest": "^3.1.1",
|
||||
"webpack-cli": "^3.3.11"
|
||||
},
|
||||
|
||||