tox
It will attempt to run the tests against all of the Python versions we support. So don't be concerned if you are missing some and they fail. The rest -will be verified by Travis when you submit a pull request.
+will be verified by Github Actions when you submit a pull request.To localize a theme to your favorite language, follow the guide on Translating Themes. We welcome translation Pull Requests!
Once you are happy with your changes or you are ready for some feedback, push +
If you're considering a large code contribution to MkDocs, please prefer to +open an issue first to get early feedback on the idea.
+Once you think the code is ready to be reviewed, push it to your fork and send a pull request. For a change to be accepted it will most likely need to have tests and documentation if it is a new feature.
When installed with i18n support (pip install mkdocs[i18n]), MkDocs allows
themes to support being translated into various languages (referred to as
-locales) if they respect Jinja's i18n extension by wrapping text placeholders
+locales) if they respect Jinja's i18n extension by wrapping text placeholders
with {% trans %} and {% endtrans %} tags.
Each time a translatable text placeholder is added, removed or changed in a
theme template, the theme's Portable Object Template (pot) file needs to be
diff --git a/about/release-notes/index.html b/about/release-notes/index.html
index 4bd40f49..850c1fa3 100644
--- a/about/release-notes/index.html
+++ b/about/release-notes/index.html
@@ -174,6 +174,10 @@
Built-in themes now also support these languages:
+ +Third-party plugins will take precedence over built-in plugins with the same + name (#2591)
+Bugfix: Fix ability to load translations for some languages: + core support (#2565) and search plugin support with fallbacks (#2602)
+Bugfix (regression in 1.2): Prevent directory traversal in the dev server + (#2604)
+Bugfix (regression in 1.2): Prevent webserver warnings from being treated as + a build failure in strict mode (#2607)
+Bugfix: Correctly print colorful messages in the terminal on Windows (#2606)
+Bugfix: Python version 3.10 was displayed incorrectly in --version (#2618)
Other small improvements; see +commit log.
The env event is called after the Jinja template environment is created
-and can be used to alter the Jinja environment.
Plugins need to be packaged as Python libraries (distributed on PyPI separate
-from MkDocs) and each must register as a Plugin via a setuptools entry_point.
+from MkDocs) and each must register as a Plugin via a setuptools entry_points.
Add the following to your setup.py script:
entry_points={
'mkdocs.plugins': [
@@ -639,7 +639,7 @@ Add the following to your setup.py script:
(from path.to.some_plugin import SomePluginClass) where SomePluginClass is a
subclass of BasePlugin which defines the plugin behavior. Naturally, multiple
Plugin classes could exist in the same module. Simply define each as a separate
-entry_point.
+entry point.
entry_points={
'mkdocs.plugins': [
'featureA = path.to.my_plugins:PluginA',
diff --git a/dev-guide/themes/index.html b/dev-guide/themes/index.html
index e84a63b8..45aae104 100644
--- a/dev-guide/themes/index.html
+++ b/dev-guide/themes/index.html
@@ -595,7 +595,7 @@ following extra configuration:
{% endif %}
Template Filters
-In addition to Jinja's default filters, the following custom filters are
+
In addition to Jinja's default filters, the following custom filters are
available to use in MkDocs templates:
url
Normalizes a URL. Absolute URLs are passed through unaltered. If the URL is
@@ -749,9 +749,9 @@ setup(
)
Fill in the URL, license, description, author and author email address.
-The name should follow the convention mkdocs-themename (like mkdocs-
-bootstrap and mkdocs-bootswatch), starting with MkDocs, using hyphens to
-separate words and including the name of your theme.
The name should follow the convention mkdocs-themename (like
+mkdocs-bootstrap and mkdocs-bootswatch), starting with MkDocs, using
+hyphens to separate words and including the name of your theme.
Most of the rest of the file can be left unedited. The last section we need to change is the entry_points. This is how MkDocs finds the theme(s) you are including in the package. The name on the left is the one that users will use @@ -822,7 +822,8 @@ templates to this list, the user cannot remove templates included in the theme's config.
Defines a parent theme that this theme inherits from. The value should be -the string name of the parent theme. Normal Jinja inheritance rules apply.
+the string name of the parent theme. Normal Jinja inheritance rules +apply.Plugins may also define some options which allow the theme to inform a plugin about which set of plugin options it expects. See the documentation for any diff --git a/index.html b/index.html index 67acf221..9086d3d3 100644 --- a/index.html +++ b/index.html @@ -201,7 +201,8 @@ configuration file. Start by reading the introductory href="user-guide/choosing-your-theme/#mkdocs">mkdocs and readthedocs, select one of the third-party themes listed on the MkDocs Themes wiki page, or build your + href="https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes">MkDocs + Themes wiki page, or build your own.
@@ -335,6 +336,6 @@ configuration file. Start by reading the introductory