mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-09-24 03:18:21 +02:00
Merge branch 'master' into chore/update-to-mkdocs-1.6
This commit is contained in:
squidfunk
commit
d98243d24c
@ -53,9 +53,9 @@ and brings value to both new and experienced users of Material for MkDocs.
|
||||
__Want to create a pull request?__ Learn how to create a comprehensive
|
||||
and useful pull request (PR)s
|
||||
|
||||
[Report a bug]: reporting-a-bug.md
|
||||
[Report a docs issue]: reporting-a-docs-issue.md
|
||||
[Request a change]: requesting-a-change.md
|
||||
[Report a bug]: docs/contributing/reporting-a-bug.md
|
||||
[Report a docs issue]: docs/contributing/reporting-a-docs-issue.md
|
||||
[Request a change]: docs/contributing/requesting-a-change.md
|
||||
[Ask a question]: https://github.com/squidfunk/mkdocs-material/discussions
|
||||
[Add translations]: https://github.com/squidfunk/mkdocs-material/adding-translations
|
||||
[Add a translation]: docs/contributing/adding-translations
|
||||
[Create a pull request]: https://github.com/squidfunk/mkdocs-material/pulls
|
||||
|
||||
@ -18,7 +18,7 @@
|
||||
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
||||
# IN THE SOFTWARE.
|
||||
|
||||
FROM python:3.11-alpine3.18
|
||||
FROM python:3.11-alpine3.19
|
||||
|
||||
# Build-time flags
|
||||
ARG WITH_PLUGINS=true
|
||||
|
||||
@ -113,7 +113,7 @@ In this section, we guide your through our processes.
|
||||
[report a bug]: reporting-a-bug.md
|
||||
[report a docs issue]: reporting-a-docs-issue.md
|
||||
[request a change]: requesting-a-change.md
|
||||
[add translations]: https://github.com/squidfunk/mkdocs-material/adding-translations
|
||||
[add translations]: adding-translations.md
|
||||
[create a pull request]: making-a-pull-request.md
|
||||
|
||||
## Checklist
|
||||
|
||||
@ -83,16 +83,16 @@ syntax, which is more convenient that directly using the corresponding
|
||||
[`mark`][mark], [`ins`][ins] and [`del`][del] HTML tags:
|
||||
|
||||
``` title="Text with highlighting"
|
||||
- ==This was marked==
|
||||
- ^^This was inserted^^
|
||||
- ~~This was deleted~~
|
||||
- ==This was marked (highlight)==
|
||||
- ^^This was inserted (underline)^^
|
||||
- ~~This was deleted (strikethrough)~~
|
||||
```
|
||||
|
||||
<div class="result" markdown>
|
||||
|
||||
- ==This was marked==
|
||||
- ^^This was inserted^^
|
||||
- ~~This was deleted~~
|
||||
- ==This was marked (highlight)==
|
||||
- ^^This was inserted (underline)^^
|
||||
- ~~This was deleted (strikethrough)~~
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
@ -11492,6 +11492,7 @@
|
||||
"simple/jsfiddle",
|
||||
"simple/json",
|
||||
"simple/jsonwebtokens",
|
||||
"simple/jsr",
|
||||
"simple/jss",
|
||||
"simple/juce",
|
||||
"simple/juejin",
|
||||
@ -12236,6 +12237,7 @@
|
||||
"simple/progate",
|
||||
"simple/progress",
|
||||
"simple/prometheus",
|
||||
"simple/pronounsdotpage",
|
||||
"simple/prosieben",
|
||||
"simple/proteus",
|
||||
"simple/protocolsdotio",
|
||||
@ -12485,6 +12487,7 @@
|
||||
"simple/scania",
|
||||
"simple/schneiderelectric",
|
||||
"simple/scikitlearn",
|
||||
"simple/scilab",
|
||||
"simple/scipy",
|
||||
"simple/scopus",
|
||||
"simple/scpfoundation",
|
||||
@ -12724,6 +12727,7 @@
|
||||
"simple/subversion",
|
||||
"simple/suckless",
|
||||
"simple/sumologic",
|
||||
"simple/sunrise",
|
||||
"simple/supabase",
|
||||
"simple/supercrease",
|
||||
"simple/supermicro",
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -97,8 +97,10 @@ class TagsPlugin(BasePlugin[TagsConfig]):
|
||||
return self._render_tag_index(markdown)
|
||||
|
||||
# Add page to tags index
|
||||
for tag in page.meta.get("tags", []):
|
||||
self.tags[tag].append(page)
|
||||
tags = page.meta.get("tags", [])
|
||||
if tags:
|
||||
for tag in tags:
|
||||
self.tags[tag].append(page)
|
||||
|
||||
# Inject tags into page (after search and before minification)
|
||||
def on_page_context(self, context, page, config, nav):
|
||||
@ -110,7 +112,8 @@ class TagsPlugin(BasePlugin[TagsConfig]):
|
||||
return
|
||||
|
||||
# Provide tags for page
|
||||
if "tags" in page.meta:
|
||||
context["tags"] =[]
|
||||
if "tags" in page.meta and page.meta["tags"]:
|
||||
context["tags"] = [
|
||||
self._render_tag(tag)
|
||||
for tag in page.meta["tags"]
|
||||
|
||||
@ -1 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M23.694 18.72c-3.845-4.058-12.083-5.754-17.345-3.216l5.504-7.623 2.63 4.163c.148.246.47.32.71.164l1.993-1.333c1.684 1.806 3.358 3.618 4.796 5.158a.19.19 0 0 0 .322-.139.185.185 0 0 0-.023-.088h.001a1542.26 1542.26 0 0 0-4.25-7.364c-.254-.434-.552-.503-.986-.219l-1.34.921-3.382-5.226a.587.587 0 0 0-.494-.275.574.574 0 0 0-.487.265A5684.859 5684.859 0 0 1 .08 18.973v.002c-.2.28-.001.67.343.671.175-.002.331-.124.488-.2 3.142-1.626 10.197-3.996 15.073-.26 2.141 1.817 9.61 1.408 7.71-.465"/></svg>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19.441 8.451c-.653-1.247-1.158-1.841-1.813-1.841-.731 0-1.053.387-1.494 1.079-.357.464-.7 1.1-1.273 1.036-.604-.063-.954-1.491-1.41-2.686-.625-1.63-.985-3.322-2.024-3.322-.593 0-1.111.54-1.915 1.747l-8.301 12.73c-.954 1.593-1.753 2.704-.742 3.748 1.187 1.142 3.975-.857 5.883-2.063 1.908-1.205 3.859-2.38 6.615-2.316 3.71.085 5.512 3.808 7.76 4.516 1.526.487 2.926-.074 3.223-1.65.174-.866-.129-1.707-.547-2.604zm-.254 7.467c-.753.56-1.803-.339-2.481-.72-.72-.401-1.94-1.364-4.124-1.332-1.78.021-2.745.687-3.805 1.407-2.3 1.565-4.379 3.384-4.972 2.443-.382-.603.646-1.809 3.063-5.574 1.718-2.676 2.927-4.813 3.785-4.813.948 0 1 .93 1.145 1.883.272 1.518 1.014 2.308 1.978 2.433 1.08.146 2.014-.76 2.756-.751.693.014 1.15 1.018 1.722 2.065.725 1.301 1.482 2.546.933 2.959z"/></svg>
|
||||
|
Before Width: | Height: | Size: 566 B After Width: | Height: | Size: 850 B |
1
material/templates/.icons/simple/jsr.svg
Normal file
1
material/templates/.icons/simple/jsr.svg
Normal file
@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.692 5.538v3.693H0v7.384h7.385v1.847h12.923v-3.693H24V7.385h-7.385V5.538Zm1.846 1.847h1.847v7.384H1.846v-3.692h1.846v1.846h1.846zm3.693 0h5.538V9.23h-3.692v1.846h3.692v5.538H9.231V14.77h3.692v-1.846H9.231Zm7.384 1.846h5.539v3.692h-1.846v-1.846h-1.846v5.538h-1.847z"/></svg>
|
||||
|
After Width: | Height: | Size: 344 B |
1
material/templates/.icons/simple/pronounsdotpage.svg
Normal file
1
material/templates/.icons/simple/pronounsdotpage.svg
Normal file
@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M14.991 5.14c.058-.102.01-.185-.108-.185l-2.051.001a.414.414 0 0 0-.321.184l-5.027 8.503c-.702 1.156-1.681 1.411-2.622 1.297-1.615-.196-2.483-1.381-2.483-2.96a2.88 2.88 0 0 1 2.876-2.876h3.192a.41.41 0 0 0 .319-.184l1.15-2.01c.058-.101.01-.184-.107-.184H5.254A5.26 5.26 0 0 0 0 11.98c0 1.4.547 2.91 1.542 3.897.98.972 2.29 1.328 3.688 1.357.789.009 2.956-.009 3.972-1.817a18678.91 18678.91 0 0 1 5.79-10.277Zm7.467 2.984c-.98-.972-2.29-1.329-3.688-1.357-.789-.01-2.956.009-3.972 1.816-1.138 2.024-5.79 10.277-5.79 10.277-.057.102-.008.185.109.185l2.051-.001a.414.414 0 0 0 .321-.184l5.027-8.503c.702-1.156 1.681-1.411 2.622-1.297 1.615.196 2.483 1.381 2.483 2.96a2.88 2.88 0 0 1-2.876 2.876h-3.192a.406.406 0 0 0-.319.184l-1.15 2.01c-.058.101-.01.184.107.184h4.555A5.26 5.26 0 0 0 24 12.02c0-1.4-.547-2.91-1.542-3.896z"/></svg>
|
||||
|
After Width: | Height: | Size: 896 B |
1
material/templates/.icons/simple/scilab.svg
Normal file
1
material/templates/.icons/simple/scilab.svg
Normal file
@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.813 1.803c-1.103 0-1.99.888-1.99 1.99v16.414c0 1.102.887 1.99 1.99 1.99h16.375c1.102 0 1.99-.888 1.99-1.99V3.793c0-1.102-.888-1.99-1.99-1.99zm8.82 1.234a1.802 1.825 0 0 1 1.803 1.824 1.802 1.825 0 0 1-1.803 1.827A1.802 1.825 0 0 1 10.83 4.86a1.802 1.825 0 0 1 1.803-1.824Zm2.986 3.496a1.802 1.825 0 0 1 1.803 1.826 1.802 1.825 0 0 1-1.803 1.825 1.802 1.825 0 0 1-1.803-1.825 1.802 1.825 0 0 1 1.803-1.826Zm-7.346.26a1.802 1.825 0 0 1 1.803 1.824 1.802 1.825 0 0 1-1.803 1.826 1.802 1.825 0 0 1-1.802-1.826 1.802 1.825 0 0 1 1.802-1.824Zm3.98 2.633a1.802 1.825 0 0 1 1.804 1.826 1.802 1.825 0 0 1-1.803 1.824 1.802 1.825 0 0 1-1.803-1.824 1.802 1.825 0 0 1 1.803-1.826zm7.044.053a1.802 1.825 0 0 1 1.803 1.826 1.802 1.825 0 0 1-1.803 1.824 1.802 1.825 0 0 1-1.8-1.824 1.802 1.825 0 0 1 1.8-1.826zm-3.402 2.535a1.802 1.825 0 0 1 1.802 1.826 1.802 1.825 0 0 1-1.802 1.824 1.802 1.825 0 0 1-1.803-1.824 1.802 1.825 0 0 1 1.803-1.826zm-11.614.953a1.802 1.825 0 0 1 1.803 1.826 1.802 1.825 0 0 1-1.803 1.824 1.802 1.825 0 0 1-1.802-1.824 1.802 1.825 0 0 1 1.802-1.826Zm15.518.93a1.802 1.825 0 0 1 1.803 1.824 1.802 1.825 0 0 1-1.803 1.826 1.802 1.825 0 0 1-1.803-1.826 1.802 1.825 0 0 1 1.803-1.825zM7.81 15.665a1.802 1.825 0 0 1 1.802 1.824 1.802 1.825 0 0 1-1.802 1.826 1.802 1.825 0 0 1-1.803-1.826 1.802 1.825 0 0 1 1.803-1.824ZM3.564 0A3.556 3.556 0 0 0 0 3.564v16.872A3.556 3.556 0 0 0 3.564 24h16.872A3.556 3.556 0 0 0 24 20.436V3.564A3.556 3.556 0 0 0 20.436 0Zm-.002 1.021h16.875a2.536 2.536 0 0 1 2.542 2.542v16.875a2.536 2.536 0 0 1-2.542 2.54H3.563a2.536 2.536 0 0 1-2.54-2.54V3.563a2.536 2.536 0 0 1 2.54-2.542z"/></svg>
|
||||
|
After Width: | Height: | Size: 1.7 KiB |
1
material/templates/.icons/simple/sunrise.svg
Normal file
1
material/templates/.icons/simple/sunrise.svg
Normal file
@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12.001 0A12 12 0 1 0 24 11.999 12.011 12.011 0 0 0 12.001 0m0 2.464a9.53 9.53 0 0 1 9.514 8.889 9.53 9.53 0 0 1-.863 4.649H3.35a9.53 9.53 0 0 1 .616-9.14 9.53 9.53 0 0 1 8.036-4.398"/></svg>
|
||||
|
After Width: | Height: | Size: 260 B |
@ -27,8 +27,8 @@
|
||||
"meta.comments": "コメント",
|
||||
"meta.source": "ソース",
|
||||
"nav": "ナビゲーション",
|
||||
"readtime.one": "このページは約１分で読めます",
|
||||
"readtime.other": "このページは約＃分で読めます",
|
||||
"readtime.one": "このページは約1分で読めます",
|
||||
"readtime.other": "このページは約#分で読めます",
|
||||
"rss.created": "新しいページのRSSフィード",
|
||||
"rss.updated": "更新されたページのRSSフィード",
|
||||
"search": "検索",
|
||||
|
||||
14
package-lock.json
generated
14
package-lock.json
generated
@ -56,7 +56,7 @@
|
||||
"preact": "^10.20.2",
|
||||
"rimraf": "^5.0.5",
|
||||
"sass": "^1.75.0",
|
||||
"simple-icons": "^11.12.0",
|
||||
"simple-icons": "^11.13.0",
|
||||
"stylelint": "^15.11.0",
|
||||
"stylelint-config-recess-order": "4.2.0",
|
||||
"stylelint-config-recommended": "^13.0.0",
|
||||
@ -8862,9 +8862,9 @@
|
||||
}
|
||||
},
|
||||
"node_modules/simple-icons": {
|
||||
"version": "11.12.0",
|
||||
"resolved": "https://registry.npmjs.org/simple-icons/-/simple-icons-11.12.0.tgz",
|
||||
"integrity": "sha512-atQCGhobuIrxTd4rDGYCip/OZwIW4FYX3PRt4BXAZcbIW71hktvX4sF620T2QJyQsNLAYo3QpiHh8ey2IseA/g==",
|
||||
"version": "11.13.0",
|
||||
"resolved": "https://registry.npmjs.org/simple-icons/-/simple-icons-11.13.0.tgz",
|
||||
"integrity": "sha512-8YOM9r3S/LIRd+y/QFbVU0D9V6EHK9y46irUWCYjF6GVWrvKQ0L3sQ14fPNidxalOQVaFB6ibDVrZLIji6S4Cg==",
|
||||
"dev": true,
|
||||
"engines": {
|
||||
"node": ">=0.12.18"
|
||||
@ -16708,9 +16708,9 @@
|
||||
}
|
||||
},
|
||||
"simple-icons": {
|
||||
"version": "11.12.0",
|
||||
"resolved": "https://registry.npmjs.org/simple-icons/-/simple-icons-11.12.0.tgz",
|
||||
"integrity": "sha512-atQCGhobuIrxTd4rDGYCip/OZwIW4FYX3PRt4BXAZcbIW71hktvX4sF620T2QJyQsNLAYo3QpiHh8ey2IseA/g==",
|
||||
"version": "11.13.0",
|
||||
"resolved": "https://registry.npmjs.org/simple-icons/-/simple-icons-11.13.0.tgz",
|
||||
"integrity": "sha512-8YOM9r3S/LIRd+y/QFbVU0D9V6EHK9y46irUWCYjF6GVWrvKQ0L3sQ14fPNidxalOQVaFB6ibDVrZLIji6S4Cg==",
|
||||
"dev": true
|
||||
},
|
||||
"sisteransi": {
|
||||
|
||||
@ -86,7 +86,7 @@
|
||||
"preact": "^10.20.2",
|
||||
"rimraf": "^5.0.5",
|
||||
"sass": "^1.75.0",
|
||||
"simple-icons": "^11.12.0",
|
||||
"simple-icons": "^11.13.0",
|
||||
"stylelint": "^15.11.0",
|
||||
"stylelint-config-recess-order": "4.2.0",
|
||||
"stylelint-config-recommended": "^13.0.0",
|
||||
|
||||
53
setup.py
53
setup.py
@ -1,53 +0,0 @@
|
||||
# Copyright (c) 2016-2024 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.
|
||||
|
||||
import sys
|
||||
|
||||
from setuptools import setup
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# Do not use – only provided for compatibility
|
||||
# -----------------------------------------------------------------------------
|
||||
|
||||
sys.stderr.write(
|
||||
"""
|
||||
===============================
|
||||
Unsupported installation method
|
||||
===============================
|
||||
This version of mkdocs-material no longer supports
|
||||
installation with `python setup.py install`.
|
||||
Please use `python -m pip install .` instead.
|
||||
"""
|
||||
)
|
||||
sys.exit(1)
|
||||
|
||||
# The below code will never execute, however GitHub is particularly
|
||||
# picky about where it finds Python packaging metadata.
|
||||
# See: https://github.com/github/feedback/discussions/6456
|
||||
with open("requirements.txt") as f:
|
||||
install_requires = [
|
||||
line for line in f.read().split("\n")
|
||||
if line and not line.startswith("#")
|
||||
]
|
||||
|
||||
setup(
|
||||
name = "mkdocs-material",
|
||||
install_requires = install_requires,
|
||||
)
|
||||
@ -97,8 +97,10 @@ class TagsPlugin(BasePlugin[TagsConfig]):
|
||||
return self._render_tag_index(markdown)
|
||||
|
||||
# Add page to tags index
|
||||
for tag in page.meta.get("tags", []):
|
||||
self.tags[tag].append(page)
|
||||
tags = page.meta.get("tags", [])
|
||||
if tags:
|
||||
for tag in tags:
|
||||
self.tags[tag].append(page)
|
||||
|
||||
# Inject tags into page (after search and before minification)
|
||||
def on_page_context(self, context, page, config, nav):
|
||||
@ -110,7 +112,8 @@ class TagsPlugin(BasePlugin[TagsConfig]):
|
||||
return
|
||||
|
||||
# Provide tags for page
|
||||
if "tags" in page.meta:
|
||||
context["tags"] =[]
|
||||
if "tags" in page.meta and page.meta["tags"]:
|
||||
context["tags"] = [
|
||||
self._render_tag(tag)
|
||||
for tag in page.meta["tags"]
|
||||
|
||||
@ -47,8 +47,8 @@
|
||||
"meta.comments": "コメント",
|
||||
"meta.source": "ソース",
|
||||
"nav": "ナビゲーション",
|
||||
"readtime.one": "このページは約１分で読めます",
|
||||
"readtime.other": "このページは約＃分で読めます",
|
||||
"readtime.one": "このページは約1分で読めます",
|
||||
"readtime.other": "このページは約#分で読めます",
|
||||
"rss.created": "新しいページのRSSフィード",
|
||||
"rss.updated": "更新されたページのRSSフィード",
|
||||
"search": "検索",
|
||||
|
||||
Loading…
Reference in New Issue
Block a user