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
1 change: 1 addition & 0 deletions docs/.dates_cache.jsonl
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
{"installation.md": {"created": "2026-02-27T13:22:22.397400+08:00"}}
{"license.md": {"created": "2016-02-09T21:59:37+01:00"}}
{"plugins/blog.md": {"created": "2023-09-14T19:09:18+02:00"}}
{"plugins/date-author.md": {"created": "2026-02-09T21:26:22.653692+08:00"}}
{"plugins/group.md": {"created": "2023-09-14T19:09:18+02:00"}}
{"plugins/index.md": {"created": "2023-09-14T19:09:18+02:00"}}
{"plugins/info.md": {"created": "2023-09-14T19:09:18+02:00"}}
Expand Down
Binary file added docs/assets/images/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
389 changes: 389 additions & 0 deletions docs/assets/images/git.drawio

Large diffs are not rendered by default.

126 changes: 126 additions & 0 deletions docs/assets/images/wiring.drawio
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
<mxfile host="drawio.min2k.com" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/147.0.0.0 Safari/537.36" version="@DRAWIO-VERSION@">
<diagram name="Page-1" id="7e0a89b8-554c-2b80-1dc8-d5c74ca68de4">
<mxGraphModel dx="954" dy="533" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="1100" pageHeight="850" background="none" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
<mxCell id="1cb643a89b7d889d-12" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;exitPerimeter=0;entryX=0;entryY=0.5;entryPerimeter=0;labelBackgroundColor=none;startArrow=none;startFill=0;startSize=5;endArrow=none;endFill=0;endSize=5;jettySize=auto;orthogonalLoop=1;strokeWidth=1;fontFamily=Verdana;fontSize=12;" parent="1" source="VuVPS5KJBOoQBnHny8Ev-2" target="1cb643a89b7d889d-2" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="1cb643a89b7d889d-1" value="40&amp;nbsp;&lt;b&gt;Ω&lt;/b&gt;" style="verticalLabelPosition=bottom;shadow=0;dashed=0;align=center;html=1;verticalAlign=top;strokeWidth=1;shape=mxgraph.electrical.resistors.resistor_2;rounded=1;comic=0;labelBackgroundColor=none;fontFamily=Verdana;fontSize=12" parent="1" vertex="1">
<mxGeometry x="322" y="120" width="100" height="20" as="geometry" />
</mxCell>
<mxCell id="1cb643a89b7d889d-15" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;exitX=1;exitY=0.5;exitPerimeter=0;labelBackgroundColor=none;startArrow=none;startFill=0;startSize=5;endArrow=none;endFill=0;endSize=5;jettySize=auto;orthogonalLoop=1;strokeWidth=1;fontFamily=Verdana;fontSize=12;" parent="1" source="1cb643a89b7d889d-2" target="VuVPS5KJBOoQBnHny8Ev-1" edge="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="612" y="170" as="targetPoint" />
<Array as="points">
<mxPoint x="582" y="130" />
<mxPoint x="582" y="170" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="1cb643a89b7d889d-2" value="20&amp;nbsp;&lt;b&gt;Ω&lt;/b&gt;" style="verticalLabelPosition=bottom;shadow=0;dashed=0;align=center;html=1;verticalAlign=top;strokeWidth=1;shape=mxgraph.electrical.resistors.resistor_2;rounded=1;comic=0;labelBackgroundColor=none;fontFamily=Verdana;fontSize=12" parent="1" vertex="1">
<mxGeometry x="462" y="120" width="100" height="20" as="geometry" />
</mxCell>
<mxCell id="1cb643a89b7d889d-13" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;exitX=1;exitY=0.5;exitPerimeter=0;labelBackgroundColor=none;startArrow=none;startFill=0;startSize=5;endArrow=none;endFill=0;endSize=5;jettySize=auto;orthogonalLoop=1;strokeWidth=1;fontFamily=Verdana;fontSize=12" parent="1" source="1cb643a89b7d889d-3" target="VuVPS5KJBOoQBnHny8Ev-8" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="1cb643a89b7d889d-3" value="70&amp;nbsp;&lt;b&gt;Ω&lt;/b&gt;" style="verticalLabelPosition=bottom;shadow=0;dashed=0;align=center;html=1;verticalAlign=top;strokeWidth=1;shape=mxgraph.electrical.resistors.resistor_2;rounded=1;comic=0;labelBackgroundColor=none;fontFamily=Verdana;fontSize=12" parent="1" vertex="1">
<mxGeometry x="322" y="210" width="100" height="20" as="geometry" />
</mxCell>
<mxCell id="1cb643a89b7d889d-14" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;exitX=1;exitY=0.5;exitPerimeter=0;labelBackgroundColor=none;startArrow=none;startFill=0;startSize=5;endArrow=none;endFill=0;endSize=5;jettySize=auto;orthogonalLoop=1;strokeWidth=1;fontFamily=Verdana;fontSize=12;" parent="1" source="1cb643a89b7d889d-4" target="VuVPS5KJBOoQBnHny8Ev-1" edge="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="670" y="180" as="targetPoint" />
<Array as="points">
<mxPoint x="582" y="220" />
<mxPoint x="582" y="170" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="1cb643a89b7d889d-4" value="20&amp;nbsp;&lt;b&gt;Ω&lt;/b&gt;" style="verticalLabelPosition=bottom;shadow=0;dashed=0;align=center;html=1;verticalAlign=top;strokeWidth=1;shape=mxgraph.electrical.resistors.resistor_2;rounded=1;comic=0;labelBackgroundColor=none;fontFamily=Verdana;fontSize=12" parent="1" vertex="1">
<mxGeometry x="462" y="210" width="100" height="20" as="geometry" />
</mxCell>
<mxCell id="1cb643a89b7d889d-10" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;entryX=0;entryY=0.5;entryPerimeter=0;labelBackgroundColor=none;startArrow=none;startFill=0;startSize=5;endArrow=none;endFill=0;endSize=5;jettySize=auto;orthogonalLoop=1;strokeWidth=1;fontFamily=Verdana;fontSize=12" parent="1" source="VuVPS5KJBOoQBnHny8Ev-4" target="1cb643a89b7d889d-1" edge="1">
<mxGeometry relative="1" as="geometry">
<Array as="points">
<mxPoint x="290" y="170" />
<mxPoint x="290" y="130" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="1cb643a89b7d889d-11" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;entryX=0;entryY=0.5;entryPerimeter=0;labelBackgroundColor=none;startArrow=none;startFill=0;startSize=5;endArrow=none;endFill=0;endSize=5;jettySize=auto;orthogonalLoop=1;strokeWidth=1;fontFamily=Verdana;fontSize=12;" parent="1" source="VuVPS5KJBOoQBnHny8Ev-4" target="1cb643a89b7d889d-3" edge="1">
<mxGeometry relative="1" as="geometry">
<Array as="points">
<mxPoint x="290" y="170" />
<mxPoint x="290" y="220" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="1cb643a89b7d889d-5" value="50&amp;nbsp;&lt;b&gt;Ω&lt;/b&gt;" style="verticalLabelPosition=bottom;shadow=0;dashed=0;align=center;html=1;verticalAlign=top;strokeWidth=1;shape=mxgraph.electrical.resistors.resistor_2;rounded=1;comic=0;labelBackgroundColor=none;fontFamily=Verdana;fontSize=12;" parent="1" vertex="1">
<mxGeometry x="162" y="160" width="100" height="20" as="geometry" />
</mxCell>
<mxCell id="1cb643a89b7d889d-9" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;exitX=0;exitY=0.5;exitPerimeter=0;labelBackgroundColor=none;startArrow=none;startFill=0;startSize=5;endArrow=none;endFill=0;endSize=5;jettySize=auto;orthogonalLoop=1;strokeWidth=1;fontFamily=Verdana;fontSize=12" parent="1" source="1cb643a89b7d889d-6" target="VuVPS5KJBOoQBnHny8Ev-5" edge="1">
<mxGeometry relative="1" as="geometry">
<Array as="points">
<mxPoint x="122" y="300" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="1cb643a89b7d889d-6" value="20&amp;nbsp;&lt;b&gt;Ω&lt;/b&gt;" style="verticalLabelPosition=bottom;shadow=0;dashed=0;align=center;html=1;verticalAlign=top;strokeWidth=1;shape=mxgraph.electrical.resistors.resistor_2;rounded=1;comic=0;labelBackgroundColor=none;fontFamily=Verdana;fontSize=12" parent="1" vertex="1">
<mxGeometry x="162" y="290" width="100" height="20" as="geometry" />
</mxCell>
<mxCell id="1cb643a89b7d889d-8" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;exitX=1;exitY=0.5;exitPerimeter=0;entryX=1;entryY=0.5;entryPerimeter=0;labelBackgroundColor=none;startArrow=none;startFill=0;startSize=5;endArrow=none;endFill=0;endSize=5;jettySize=auto;orthogonalLoop=1;strokeWidth=1;fontFamily=Verdana;fontSize=12" parent="1" source="1cb643a89b7d889d-7" target="1cb643a89b7d889d-6" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="1cb643a89b7d889d-16" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;exitX=0;exitY=0.5;exitPerimeter=0;labelBackgroundColor=none;startArrow=none;startFill=0;startSize=5;endArrow=none;endFill=0;endSize=5;jettySize=auto;orthogonalLoop=1;strokeWidth=1;fontFamily=Verdana;fontSize=12" parent="1" source="1cb643a89b7d889d-7" target="VuVPS5KJBOoQBnHny8Ev-1" edge="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="612" y="170" as="targetPoint" />
<Array as="points">
<mxPoint x="632" y="300" />
<mxPoint x="632" y="170" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="1cb643a89b7d889d-7" value="220 V" style="verticalLabelPosition=bottom;shadow=0;dashed=0;align=center;fillColor=default;html=1;verticalAlign=top;strokeWidth=1;shape=mxgraph.electrical.miscellaneous.monocell_battery;rounded=1;comic=0;labelBackgroundColor=none;fontFamily=Verdana;fontSize=12;flipH=1;" parent="1" vertex="1">
<mxGeometry x="442" y="270" width="100" height="60" as="geometry" />
</mxCell>
<mxCell id="VuVPS5KJBOoQBnHny8Ev-1" value="B" style="shape=waypoint;sketch=0;fillStyle=solid;size=6;pointerEvents=1;points=[];fillColor=none;resizable=0;rotatable=0;perimeter=centerPerimeter;snapToPoint=1;verticalAlign=top;spacingBottom=0;spacingTop=-5;fontFamily=Verdana;fontSize=12;" parent="1" vertex="1">
<mxGeometry x="592" y="150" width="40" height="40" as="geometry" />
</mxCell>
<mxCell id="VuVPS5KJBOoQBnHny8Ev-2" value="C" style="shape=waypoint;sketch=0;fillStyle=solid;size=6;pointerEvents=1;points=[];fillColor=none;resizable=0;rotatable=0;perimeter=centerPerimeter;snapToPoint=1;verticalAlign=top;spacingBottom=0;spacingTop=-5;fontFamily=Verdana;fontSize=12;" parent="1" vertex="1">
<mxGeometry x="423" y="110" width="40" height="40" as="geometry" />
</mxCell>
<mxCell id="VuVPS5KJBOoQBnHny8Ev-3" value="" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;exitX=1;exitY=0.5;exitPerimeter=0;entryPerimeter=0;labelBackgroundColor=none;startArrow=none;startFill=0;startSize=5;endArrow=none;endFill=0;endSize=5;jettySize=auto;orthogonalLoop=1;strokeWidth=1;fontFamily=Verdana;fontSize=12;" parent="1" source="1cb643a89b7d889d-1" target="VuVPS5KJBOoQBnHny8Ev-2" edge="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="422" y="130.00000000000006" as="sourcePoint" />
<mxPoint x="462" y="130.00000000000006" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="VuVPS5KJBOoQBnHny8Ev-4" value="A" style="shape=waypoint;sketch=0;fillStyle=solid;size=6;pointerEvents=1;points=[];fillColor=none;resizable=0;rotatable=0;perimeter=centerPerimeter;snapToPoint=1;verticalAlign=top;spacingBottom=0;spacingTop=-5;fontFamily=Verdana;fontSize=12;" parent="1" vertex="1">
<mxGeometry x="242" y="150" width="40" height="40" as="geometry" />
</mxCell>
<mxCell id="VuVPS5KJBOoQBnHny8Ev-5" value="E" style="shape=waypoint;sketch=0;fillStyle=solid;size=6;pointerEvents=1;points=[];fillColor=none;resizable=0;rotatable=0;perimeter=centerPerimeter;snapToPoint=1;verticalAlign=middle;spacingBottom=0;spacingTop=0;fontFamily=Verdana;fontSize=12;labelPosition=center;verticalLabelPosition=middle;align=left;spacingRight=0;spacingLeft=6;" parent="1" vertex="1">
<mxGeometry x="102" y="214" width="40" height="40" as="geometry" />
</mxCell>
<mxCell id="VuVPS5KJBOoQBnHny8Ev-7" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;labelBackgroundColor=none;startArrow=none;startFill=0;startSize=5;endArrow=none;endFill=0;endSize=5;jettySize=auto;orthogonalLoop=1;strokeWidth=1;fontFamily=Verdana;fontSize=12;entryX=0;entryY=0.5;entryDx=0;entryDy=0;entryPerimeter=0;" parent="1" source="VuVPS5KJBOoQBnHny8Ev-5" target="1cb643a89b7d889d-5" edge="1">
<mxGeometry relative="1" as="geometry">
<Array as="points">
<mxPoint x="122" y="170" />
</Array>
<mxPoint x="172" y="310" as="sourcePoint" />
<mxPoint x="132" y="244" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="VuVPS5KJBOoQBnHny8Ev-8" value="D" style="shape=waypoint;sketch=0;fillStyle=solid;size=6;pointerEvents=1;points=[];fillColor=none;resizable=0;rotatable=0;perimeter=centerPerimeter;snapToPoint=1;verticalAlign=top;spacingBottom=0;spacingTop=-5;fontFamily=Verdana;fontSize=12;" parent="1" vertex="1">
<mxGeometry x="422" y="200" width="40" height="40" as="geometry" />
</mxCell>
<mxCell id="VuVPS5KJBOoQBnHny8Ev-9" style="edgeStyle=orthogonalEdgeStyle;rounded=0;html=1;labelBackgroundColor=none;startArrow=none;startFill=0;startSize=5;endArrow=none;endFill=0;endSize=5;jettySize=auto;orthogonalLoop=1;strokeWidth=1;fontFamily=Verdana;fontSize=12;entryX=0;entryY=0.5;entryDx=0;entryDy=0;entryPerimeter=0;" parent="1" source="VuVPS5KJBOoQBnHny8Ev-8" target="1cb643a89b7d889d-4" edge="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="432" y="230" as="sourcePoint" />
<mxPoint x="452" y="230" as="targetPoint" />
</mxGeometry>
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>
Binary file removed docs/assets/images/zensical.png
Binary file not shown.
20 changes: 13 additions & 7 deletions docs/assets/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ copyright: Copyright &copy; 2016 - 2026 Aaron Wang

extra:
status:
new: Recently added
new: Recently updated
deprecated: Deprecated
social:
- icon: fontawesome/brands/github
Expand Down Expand Up @@ -119,12 +119,18 @@ theme:
git:
icon: simple/git
color: '#f34f29'
desc:
icon: octicons/sort-desc-24
color: rgba(158, 158, 158, 0.7)
pied-piper:
icon: fontawesome/brands/pied-piper-alt
color: '#2b9b46'
copyright:
icon: material/copyright
color: '#2b9b9b'
heart:
icon: octicons/heart-24
color: '#9b2b9b'
lyrics:
icon: material/microphone
color: '#2b2b9b'
soundcloud:
icon: simple/soundcloud
color: '#ff7700'


#---- 4. Plugins ----
Expand Down
Binary file modified docs/assets/screenshots/consent.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/screenshots/creating-your-site.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/screenshots/navigation-tabs-collapsed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/screenshots/social-cards-layer-background-image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/screenshots/social-cards-layer-background.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/screenshots/social-cards-layer-icon-circles.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 19 additions & 7 deletions docs/changelog/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,23 @@ icon: material/layers-triple-outline

## MaterialX

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

- Added official Docker image
- Updated documentation workflow
- Restored build workflow
- Optimized the date loading mechanism of the blog plugin
- Manual date configuration for each post is no longer required, and the date plugin no longer needs to be enabled
- Fixed inconsistent icon rendering sizes across different icon families when customizing Admonitions
- Fixed the issue where annotation tooltips inside admonitions were clipped
- Fixed issues arising from incorrect mounting logic for Code Annotations
- Significantly updated project documentation, including plugins, setup, admonitions and more

### 10.1.3 <small>April 10, 2026</small> { id="10.1.3" }

- Feature: Bundled icons can now be used as favicon, see [Favicon](../setup/changing-the-logo-and-icons.md#favicon){target="_blank"}
- Feature: Bundled icons can now be used as favicon, see [Favicon](../setup/changing-the-logo-and-icons.md#favicon-icon-bundled){target="_blank"}
- Feature: Modularized Admonition for easier extensibility
- Customizing a new admonition can now be done simply by configuring it in `mkdocs.yml`, see [Customization](../reference/admonitions.md#customization){target="_blank"}
- Customizing a new admonition can now be done simply by configuring it in `mkdocs.yml`, see [Customization](../reference/admonitions.md#custom-icons-and-colors-example-2-create-new-admonitions){target="_blank"}
- Fixed compatibility issue with the `lastmod` value in `sitemap.xml`
- When used with the `document-dates` plugin, `sitemap.xml` can now generate the exact `lastmod`, see [sitemap.xml](https://github.com/jaywhj/mkdocs-materialx/blob/main/src/templates/sitemap.xml){target="_blank"}
- Optimized inline code block style
Expand All @@ -19,22 +31,22 @@ icon: material/layers-triple-outline

- Fixed the robustness of the `document-dates` plugin when running with the blog plugin
- Fixed the border gap issue for `admonitions` & `details`
- Updated the usage documentation for the `document-dates` plugin, see [Configuration](../setup/adding-document-dates-authors.md#configuration){target="_blank"}
- Updated project development setup
- Archived unnecessary docs and exclude them from the build, see [Archives](https://github.com/jaywhj/mkdocs-materialx/tree/main/docs/archives){target="_blank"}

### 10.1.1 <small>March 29, 2026</small> { id="10.1.1" }

- Added support for ProperDocs
- Date & time infrastructure (provided by the built-in plugin `document-dates`; remember to enable it in the `plugins` section)
- Date & time infrastructure (provided by the built-in plugin [Date and Authors](../setup/adding-document-dates-authors.md))
- It's **20-500 times faster** than `git-revision-date-localized` and `git-authors`, and works in any environment (no-Git, Git environments, Docker, all CI/CD build systems, etc.)
- Completely resolved date and time infrastructure issues, enabling the project to support automated date processing. Manual date configuration is no longer required for any feature, including: page date display, blog post dates, blog date archives, blog list sorting, sitemap.xml (lastmod - SEO improvements), RSS feeds, recently updated section, search ranking, and more
- Added an override template for `sitemap.xml` that supports dynamically loading the exact lastmod to improve SEO, see [sitemap.xml](https://github.com/jaywhj/mkdocs-materialx/blob/main/src/templates/sitemap.xml){target="_blank"}
- Updated the processing logic for blog post dates, manual date specification is no longer required
- These date values can be accessed via template variables in any template or plugin, see [Template Variables](../setup/adding-document-dates-authors.md#template-variables){target="_blank"}
- These date values can be accessed via template variables in any template or plugin, see [Template Variables](../plugins/date-author.md#template-variables){target="_blank"}
- Recently updated list
- Added high-performance readtime & summary parsers
- Added `readtime` and `tag` rendering, for readtime calculation details see [Reading-Time-Estimation](../setup/adding-document-dates-authors.md#reading-time-estimation){target="_blank"}
- Added line count configuration for `summary`, see [Summary-Line-Configuration](../setup/adding-document-dates-authors.md#summary-line-configuration){target="_blank"}
- Added `readtime` and `tag` rendering, for readtime calculation details see [Reading-Time-Estimation](../plugins/date-author.md#reading-time-estimation){target="_blank"}
- Added line count configuration for `summary`, see [Summary-Line-Configuration](../plugins/date-author.md#summary-line-configuration){target="_blank"}
- Improved layout styling for mixed text and image content
- Tags
- Fixed a bug in tag list parsing
Expand Down
Loading