Skip to content

Commit

Permalink
Prepare 9.4.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
squidfunk committed Sep 21, 2023
1 parent ac918d6 commit a0cc06b
Show file tree
Hide file tree
Showing 13 changed files with 46 additions and 26 deletions.
4 changes: 2 additions & 2 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
"yaml.customTags": [
"!ENV scalar",
"!ENV sequence",
"tag:yaml.org,2002:python/name:materialx.emoji.to_svg",
"tag:yaml.org,2002:python/name:materialx.emoji.twemoji",
"tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg",
"tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
"tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
]
}
10 changes: 10 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -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)

* Added support for using git submodules in projects plugin
Expand Down
10 changes: 10 additions & 0 deletions docs/changelog/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@

## 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" }

- Updated Slovenian translations
Expand Down
4 changes: 2 additions & 2 deletions docs/creating-your-site.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ theme:
"yaml.customTags": [ // (1)!
"!ENV scalar",
"!ENV sequence",
"tag:yaml.org,2002:python/name:materialx.emoji.to_svg",
"tag:yaml.org,2002:python/name:materialx.emoji.twemoji",
"tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg",
"tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
"tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
]
}
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/icons-emojis.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ lines to `mkdocs.yml`:
markdown_extensions:
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
```
The following icon sets are bundled with Material for MkDocs:
Expand Down
4 changes: 2 additions & 2 deletions docs/schema/extensions/pymdownx.json
Original file line number Diff line number Diff line change
Expand Up @@ -168,11 +168,11 @@
"properties": {
"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": {
"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": {
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.options.custom_icons",
Expand Down
4 changes: 2 additions & 2 deletions docs/setup/changing-the-logo-and-icons.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,8 @@ Then, add the following lines to `mkdocs.yml`:
``` yaml
markdown_extensions:
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- overrides/.icons
Expand Down
10 changes: 5 additions & 5 deletions docs/setup/extensions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ syntax extensions for technical writing.

## Supported extensions

The following extensions are all supported by Material for MkDocs and therefore
The following extensions are all supported by Material for MkDocs and therefore
strongly recommended. Click on each extension to learn about its purpose and
configuration:

Expand Down Expand Up @@ -77,8 +77,8 @@ your documentation project.

### Minimal configuration

This configuration is a good starting point for when you're using Material for
MkDocs for the first time. The best idea is to explore the [reference], and
This configuration is a good starting point for when you're using Material for
MkDocs for the first time. The best idea is to explore the [reference], and
gradually add what you want to use:

``` yaml
Expand Down Expand Up @@ -121,8 +121,8 @@ markdown_extensions:
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.keys
Expand Down
12 changes: 6 additions & 6 deletions docs/setup/extensions/python-markdown-extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,8 +222,8 @@ in `*.svg` file format into the resulting HTML page. Enable it via `mkdocs.yml`:
``` yaml
markdown_extensions:
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji # (1)!
emoji_generator: !!python/name:materialx.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji # (1)!
emoji_generator: !!python/name:material.extensions.emoji.to_svg
```

1. [Python Markdown Extensions] uses the `pymdownx` namespace, but in order to
Expand All @@ -241,7 +241,7 @@ The following configuration options are supported:
``` yaml
markdown_extensions:
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_index: !!python/name:material.extensions.emoji.twemoji
```

<!-- md:option pymdownx.emoji.emoji_generator -->
Expand All @@ -253,7 +253,7 @@ The following configuration options are supported:
``` yaml
markdown_extensions:
- 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 -->
Expand All @@ -265,8 +265,8 @@ The following configuration options are supported:
``` yaml
markdown_extensions:
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- overrides/.icons
Expand Down
2 changes: 1 addition & 1 deletion material/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.

__version__ = "9.3.2"
__version__ = "9.4.0"
2 changes: 1 addition & 1 deletion material/templates/base.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
<link rel="alternate" type="application/rss+xml" title="{{ lang.t('rss.updated') }}" href="{{ 'feed_rss_updated.xml' | url }}">
{% endif %}
<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 %}
{% block htmltitle %}
{% if page.meta and page.meta.title %}
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "mkdocs-material",
"version": "9.3.2",
"version": "9.4.0",
"description": "Documentation that simply works",
"keywords": [
"mkdocs",
Expand Down

0 comments on commit a0cc06b

Please sign in to comment.