OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Prepare 9.4.0 release

Browse Source
This commit is contained in:
squidfunk 2023-09-21 18:56:35 +02:00
parent ac918d6a8b
commit a0cc06b112
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF
13 changed files with 46 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.vscode/settings.json vendored
View File

@ -14,8 +14,8 @@
"yaml.customTags": [ "yaml.customTags": [
"!ENV scalar", "!ENV scalar",
"!ENV sequence", "!ENV sequence",
"tag:yaml.org,2002:python/name:materialx.emoji.to_svg", "tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg",
"tag:yaml.org,2002:python/name:materialx.emoji.twemoji", "tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
"tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format" "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
] ]
} }

10
CHANGELOG
View File

@ -1,3 +1,13 @@
mkdocs-material-9.4.0 (2023-09-21)
* Added Belarusian translations
* Added version info to entrypoint of package
* Added emoji extension as a replacement for materialx
* Improved slate color scheme (dark mode) - now even darker
* Restructured project to improve development experience
* Updated MkDocs to 1.5.3
* Fixed #3890: Development mode crashes on Linux
mkdocs-material-9.3.2+insiders-4.42.0 (2023-09-19) mkdocs-material-9.3.2+insiders-4.42.0 (2023-09-19)
* Added support for using git submodules in projects plugin * Added support for using git submodules in projects plugin

10
docs/changelog/index.md
View File

@ -2,6 +2,16 @@
## Material for MkDocs ## Material for MkDocs
### 9.4.0 <small>September 21, 2023</small> { id="9.4.0" }
- Added Belarusian translations
- Added version info to entrypoint of package
- Added emoji extension as a replacement for materialx
- Improved slate color scheme (dark mode) - now even darker
- Restructured project to improve development experience
- Updated MkDocs to 1.5.3
- Fixed #3890: Development mode crash on Linux
### 9.3.2 <small>September 19, 2023</small> { id="9.3.2" } ### 9.3.2 <small>September 19, 2023</small> { id="9.3.2" }
- Updated Slovenian translations - Updated Slovenian translations

4
docs/creating-your-site.md
View File

@ -66,8 +66,8 @@ theme:
"yaml.customTags": [ // (1)! "yaml.customTags": [ // (1)!
"!ENV scalar", "!ENV scalar",
"!ENV sequence", "!ENV sequence",
"tag:yaml.org,2002:python/name:materialx.emoji.to_svg", "tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg",
"tag:yaml.org,2002:python/name:materialx.emoji.twemoji", "tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
"tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format" "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
] ]
} }

4
docs/reference/icons-emojis.md
View File

@ -41,8 +41,8 @@ lines to `mkdocs.yml`:
markdown_extensions: markdown_extensions:
- attr_list - attr_list
- pymdownx.emoji: - pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg emoji_generator: !!python/name:material.extensions.emoji.to_svg
``` ```
The following icon sets are bundled with Material for MkDocs: The following icon sets are bundled with Material for MkDocs:

4
docs/schema/extensions/pymdownx.json
View File

@ -168,11 +168,11 @@
"properties": { "properties": {
"emoji_generator": { "emoji_generator": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.emoji_generator", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.emoji_generator",
"default": "!!python/name:materialx.emoji.to_svg" "default": "!!python/name:material.extensions.emoji.to_svg"
}, },
"emoji_index": { "emoji_index": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.emoji_index", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.emoji_index",
"default": "!!python/name:materialx.emoji.twemoji" "default": "!!python/name:material.extensions.emoji.twemoji"
}, },
"options": { "options": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.options.custom_icons", "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.options.custom_icons",

4
docs/setup/changing-the-logo-and-icons.md
View File

@ -129,8 +129,8 @@ Then, add the following lines to `mkdocs.yml`:
``` yaml ``` yaml
markdown_extensions: markdown_extensions:
- pymdownx.emoji: - pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg emoji_generator: !!python/name:material.extensions.emoji.to_svg
options: options:
custom_icons: custom_icons:
- overrides/.icons - overrides/.icons

4
docs/setup/extensions/index.md
View File

@ -121,8 +121,8 @@ markdown_extensions:
- pymdownx.caret - pymdownx.caret
- pymdownx.details - pymdownx.details
- pymdownx.emoji: - pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight - pymdownx.highlight
- pymdownx.inlinehilite - pymdownx.inlinehilite
- pymdownx.keys - pymdownx.keys

12
docs/setup/extensions/python-markdown-extensions.md
View File

@ -222,8 +222,8 @@ in `*.svg` file format into the resulting HTML page. Enable it via `mkdocs.yml`:
``` yaml ``` yaml
markdown_extensions: markdown_extensions:
- pymdownx.emoji: - pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji # (1)! emoji_index: !!python/name:material.extensions.emoji.twemoji # (1)!
emoji_generator: !!python/name:materialx.emoji.to_svg emoji_generator: !!python/name:material.extensions.emoji.to_svg
``` ```
1. [Python Markdown Extensions] uses the `pymdownx` namespace, but in order to 1. [Python Markdown Extensions] uses the `pymdownx` namespace, but in order to
@ -241,7 +241,7 @@ The following configuration options are supported:
``` yaml ``` yaml
markdown_extensions: markdown_extensions:
- pymdownx.emoji: - pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji emoji_index: !!python/name:material.extensions.emoji.twemoji
``` ```
<!-- md:option pymdownx.emoji.emoji_generator --> <!-- md:option pymdownx.emoji.emoji_generator -->
@ -253,7 +253,7 @@ The following configuration options are supported:
``` yaml ``` yaml
markdown_extensions: markdown_extensions:
- pymdownx.emoji: - pymdownx.emoji:
emoji_generator: !!python/name:materialx.emoji.to_svg emoji_generator: !!python/name:material.extensions.emoji.to_svg
``` ```
<!-- md:option pymdownx.emoji.options.custom_icons --> <!-- md:option pymdownx.emoji.options.custom_icons -->
@ -265,8 +265,8 @@ The following configuration options are supported:
``` yaml ``` yaml
markdown_extensions: markdown_extensions:
- pymdownx.emoji: - pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg emoji_generator: !!python/name:material.extensions.emoji.to_svg
options: options:
custom_icons: custom_icons:
- overrides/.icons - overrides/.icons

2
material/__init__.py
View File

@ -18,4 +18,4 @@
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE. # IN THE SOFTWARE.
__version__ = "9.3.2" __version__ = "9.4.0"

2
material/templates/base.html
View File

@ -32,7 +32,7 @@
<link rel="alternate" type="application/rss+xml" title="{{ lang.t('rss.updated') }}" href="{{ 'feed_rss_updated.xml' | url }}"> <link rel="alternate" type="application/rss+xml" title="{{ lang.t('rss.updated') }}" href="{{ 'feed_rss_updated.xml' | url }}">
{% endif %} {% endif %}
<link rel="icon" href="{{ config.theme.favicon | url }}"> <link rel="icon" href="{{ config.theme.favicon | url }}">
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-9.3.2"> <meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-9.4.0">
{% endblock %} {% endblock %}
{% block htmltitle %} {% block htmltitle %}
{% if page.meta and page.meta.title %} {% if page.meta and page.meta.title %}

4
package-lock.json generated
View File

@ -1,12 +1,12 @@
{ {
"name": "mkdocs-material", "name": "mkdocs-material",
"version": "9.3.2", "version": "9.4.0",
"lockfileVersion": 2, "lockfileVersion": 2,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "mkdocs-material", "name": "mkdocs-material",
"version": "9.3.2", "version": "9.4.0",
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"clipboard": "^2.0.11", "clipboard": "^2.0.11",

2
package.json
View File

@ -1,6 +1,6 @@
{ {
"name": "mkdocs-material", "name": "mkdocs-material",
"version": "9.3.2", "version": "9.4.0",
"description": "Documentation that simply works", "description": "Documentation that simply works",
"keywords": [ "keywords": [
"mkdocs", "mkdocs",