Skip to content

add(integrations): support integrations with MaterialX theme, fork of Material for Mkdocs#437

Merged
Guts merged 2 commits intomainfrom
integration/add-support-for-materialx-theme
Apr 17, 2026
Merged

add(integrations): support integrations with MaterialX theme, fork of Material for Mkdocs#437
Guts merged 2 commits intomainfrom
integration/add-support-for-materialx-theme

Conversation

@Guts
Copy link
Copy Markdown
Owner

@Guts Guts commented Apr 16, 2026

FYI @jaywhj

@github-actions github-actions Bot added documentation Improvements or additions to documentation quality Tests, project resiliency, etc. labels Apr 16, 2026
@Guts Guts force-pushed the integration/add-support-for-materialx-theme branch from 9837d3b to e16d297 Compare April 16, 2026 18:36
@github-actions github-actions Bot added the dependencies Pull requests that update a dependency file label Apr 16, 2026
@Guts Guts marked this pull request as draft April 16, 2026 19:47
@jaywhj
Copy link
Copy Markdown

jaywhj commented Apr 17, 2026

@Guts Excellent 👍

This PR uses dynamic retrieval of the theme name instead, which definitely offers better compatibility.

I will add the mkdocs-rss-plugin to the plugin recommendations in the MaterialX documentation.

@Guts
Copy link
Copy Markdown
Owner Author

Guts commented Apr 17, 2026

Thanks for your fork.

I will add the mkdocs-rss-plugin to the plugin recommendations in the MaterialX documentation.

It's already done since it's was in Material https://jaywhj.github.io/mkdocs-materialx/setup/setting-up-a-blog.html#rss

@Guts Guts force-pushed the integration/add-support-for-materialx-theme branch from e16d297 to aa91213 Compare April 17, 2026 08:36
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 17, 2026

Codecov Report

❌ Patch coverage is 76.92308% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 83.24%. Comparing base (eea4e16) to head (1432ed6).
⚠️ Report is 3 commits behind head on main.

Files with missing lines Patch % Lines
...ocs_rss_plugin/integrations/theme_material_base.py 57.14% 2 Missing and 1 partial ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #437      +/-   ##
==========================================
- Coverage   83.52%   83.24%   -0.28%     
==========================================
  Files          11       11              
  Lines         783      788       +5     
  Branches      132      133       +1     
==========================================
+ Hits          654      656       +2     
- Misses         84       86       +2     
- Partials       45       46       +1     
Flag Coverage Δ
unittests 83.24% <76.92%> (-0.28%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
..._plugin/integrations/theme_material_blog_plugin.py 80.00% <100.00%> (ø)
...lugin/integrations/theme_material_social_plugin.py 87.17% <100.00%> (ø)
...ocs_rss_plugin/integrations/theme_material_base.py 78.26% <57.14%> (-10.63%) ⬇️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Guts Guts self-assigned this Apr 17, 2026
@Guts Guts added the enhancement New feature or request label Apr 17, 2026
@github-actions github-actions Bot removed the enhancement New feature or request label Apr 17, 2026
@Guts Guts marked this pull request as ready for review April 17, 2026 08:44
@sonarqubecloud
Copy link
Copy Markdown

@Guts Guts merged commit 6dc7f76 into main Apr 17, 2026
14 checks passed
@Guts Guts deleted the integration/add-support-for-materialx-theme branch April 17, 2026 08:46
@Guts Guts added the enhancement New feature or request label Apr 17, 2026
@jaywhj
Copy link
Copy Markdown

jaywhj commented Apr 24, 2026

@Guts

I have another suggestion you could try.

I noticed that mkdocs-rss-plugin uses the creation and update dates of documents. You can obtain accurate dates directly via the API provided by MaterialX.

All of these date-related issues should be resolved, for example: #377 #317

In the past, neither MkDocs, mkdocs-material, nor other similar static site generators had a perfect solution for this.

MaterialX has now solved this (via its built-in plugin). It can accurately retrieve the original document timestamps in any environment (with or without Git) delivering a much better user experience. This data capability is already used to generate the lastmod field in sitemap.xml.

for detail, see developer-api

@Guts
Copy link
Copy Markdown
Owner Author

Guts commented Apr 25, 2026

Can you fill an issue please?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation enhancement New feature or request quality Tests, project resiliency, etc.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants