Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@

mkdocs-materialx-10.1.5 (2026-05-10)

- Added Markdown page support for AI agents, see [Markdown for AI agents](https://jaywhj.github.io/mkdocs-materialx/setup/adding-a-git-repository#markdown-for-ai-agents)
- Added download functionality for fenced code blocks, see [Code download button](https://jaywhj.github.io/mkdocs-materialx/reference/code-blocks#code-download-button)
- Added Lucide icons, see [Search](https://jaywhj.github.io/mkdocs-materialx/reference/icons-emojis#search)
- Updated dependency versions

mkdocs-materialx-10.1.4 (2026-04-26)

- Added official Docker image, see [installation with docker](https://jaywhj.github.io/mkdocs-materialx/installation#with-docker)
Expand Down
7 changes: 7 additions & 0 deletions docs/changelog/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ icon: material/layers-triple-outline

## MaterialX

### 10.1.5 <small>May 10, 2026</small> { id="10.1.5" }

- Added Markdown page support for AI agents, see [Markdown for AI agents](../setup/adding-a-git-repository.md#markdown-for-ai-agents){target="_blank"}
- Added download functionality for fenced code blocks, see [Code download button](../reference/code-blocks.md#code-download-button){target="_blank"}
- Added Lucide icons, see [Search](../reference/icons-emojis.md#search){target="_blank"}
- Updated dependency versions

### 10.1.4 <small>April 26, 2026</small> { id="10.1.4" }

- Added official Docker image, see [installation with docker](../installation.md#with-docker){target="_blank"}
Expand Down
6 changes: 6 additions & 0 deletions docs/setup/adding-a-git-repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,12 @@ theme:
- content.action.agents
```

After applying this configuration, an HTML link relation of type `text/markdown` will be automatically generated in the page header:

``` html
<link rel="alternate" type="text/markdown" href="https://github.com/xxx.md">
```

!!! warning "Note"
- This feature relies on the [`repo_url`][repo_url]{target="_blank"} and [`edit_uri`][edit_uri]{target="_blank"} settings, you need to configure both properties correctly
- If the default branch of your GitHub repository is `main`, add the configuration: `edit_uri: edit/main/docs/`
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__ = "10.1.4"
__version__ = "10.1.5"

Large diffs are not rendered by default.

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions material/templates/base.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
<link rel="icon" href="{{ config.theme.favicon | url }}">
{% endif %}
{% endif %}
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-materialx-10.1.4">
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-materialx-10.1.5">
{% endblock %}
{% block htmltitle %}
{% if page.meta and page.meta.title %}
Expand Down Expand Up @@ -280,7 +280,7 @@
</script>
{% endblock %}
{% block scripts %}
<script src="{{ 'assets/javascripts/bundle.759a5869.min.js' | url }}"></script>
<script src="{{ 'assets/javascripts/bundle.1a8646e9.min.js' | url }}"></script>
{% for script in config.extra_javascript %}
{{ script | script_tag }}
{% endfor %}
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "mkdocs-materialx",
"version": "10.1.4",
"version": "10.1.5",
"description": "Documentation that simply works",
"keywords": [
"mkdocs",
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ dependencies = [
"paginate>=0.5",
"backrefs>=5.7.post1",
"requests>=2.30",
"mkdocs-document-dates==3.8.0"
"mkdocs-document-dates==3.8.2"
]

classifiers = [
Expand Down