From fe65a2da77e9294e7e536a73b563df5a2229cbe9 Mon Sep 17 00:00:00 2001 From: Aaron Date: Sun, 10 May 2026 20:28:31 +0800 Subject: [PATCH 1/2] Updated docs --- docs/installation.md | 4 ++-- docs/setup/adding-a-git-repository.md | 6 +++++- docs/setup/index.md | 4 ++-- 3 files changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/installation.md b/docs/installation.md index 6518b57ff..ef0df8863 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -27,7 +27,7 @@ Open up a terminal and install MaterialX with: === "Pin" ``` - pip install mkdocs-materialx==10.1.3 + pip install mkdocs-materialx==10.1.5 ``` === "Upgrade" @@ -62,7 +62,7 @@ and pull the image with: === "Pin" ``` - docker pull jaywhj/mkdocs-materialx:10.1.4 + docker pull jaywhj/mkdocs-materialx:10.1.5 ``` [Docker image]: https://hub.docker.com/r/jaywhj/mkdocs-materialx diff --git a/docs/setup/adding-a-git-repository.md b/docs/setup/adding-a-git-repository.md index 51669a6d3..7be8de710 100644 --- a/docs/setup/adding-a-git-repository.md +++ b/docs/setup/adding-a-git-repository.md @@ -186,7 +186,11 @@ After applying this configuration, an HTML link relation of type `text/markdown` !!! 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/` + - If the default branch of your GitHub repository is `main`, add the configuration: + + ``` yaml + edit_uri: edit/main/docs/ + ``` Related introduction: [Introducing Markdown for Agents](https://blog.cloudflare.com/zh-cn/markdown-for-agents/){target="_blank"} diff --git a/docs/setup/index.md b/docs/setup/index.md index 7b344401c..5f09f6991 100644 --- a/docs/setup/index.md +++ b/docs/setup/index.md @@ -42,8 +42,8 @@ configuration or alter the appearance.
-- :material-brush-variant: __[Colors]__ – Change colors with an existing color palette or customize with CSS -- :material-format-font: __[Fonts]__ – Choose among 1,000 Google Fonts or load self-hosted fonts +- :lucide-palette: __[Colors]__ – Change colors with an existing color palette or customize with CSS +- :material-format-text: __[Fonts]__ – Choose among 1,000 Google Fonts or load self-hosted fonts - :material-google-downasaur: __[Logo & Icons]__ – Change the logo, use any of the 8,000+ icons, or add new ones - :material-cards-variant: __[Social Cards]__ – Automatically create social media previews when sharing links From 6659415ff1c3daeebd1066dc10a26ee9ab58ee80 Mon Sep 17 00:00:00 2001 From: Aaron Date: Tue, 12 May 2026 10:14:39 +0800 Subject: [PATCH 2/2] Fixed link error --- .github/ISSUE_TEMPLATE/01-report-a-bug.yml | 24 +++++++++---------- .../ISSUE_TEMPLATE/02-report-a-docs-issue.yml | 12 +++++----- .../blog/posts/goodbye-github-discussions.md | 4 ++-- docs/contributing/making-a-pull-request.md | 3 +-- docs/tutorials/blogs/engage.md | 2 +- docs/tutorials/blogs/navigation.md | 2 +- 6 files changed, 23 insertions(+), 24 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/01-report-a-bug.yml b/.github/ISSUE_TEMPLATE/01-report-a-bug.yml index 18b83be4a..894b3a125 100644 --- a/.github/ISSUE_TEMPLATE/01-report-a-bug.yml +++ b/.github/ISSUE_TEMPLATE/01-report-a-bug.yml @@ -11,7 +11,7 @@ body: you want to report, helping us to understand what you are working on and what you are trying to achieve. If the context is not relevant, you can leave this field empty. - [More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug/#context) + [More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug#context) - type: textarea id: description @@ -22,7 +22,7 @@ body: for MkDocs does not behave as you would expect it to. Be as specific as possible. If you have found a workaround or a fix for the problem, please let us maintainers (and all other users) know. - [More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug/#bug-description) + [More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug#bug-description) validations: required: true @@ -38,9 +38,9 @@ body: and closed [issues](https://github.com/jaywhj/mkdocs-materialx/issues) and [discussions](https://github.com/jaywhj/mkdocs-materialx/discussions) you encountered when searching our issue tracker. - [More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug/#related-links) + [More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug#related-links) value: |- - - [Reporting a bug](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug/) + - [Reporting a bug](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug) - validations: required: true @@ -51,11 +51,11 @@ body: label: Reproduction description: >- Please create a __.zip file__ with a __minimal reproduction__ for the - bug. First, read our [reproduction guide](https://jaywhj.github.io/mkdocs-materialx/guides/creating-a-reproduction/) - that explains the necessary steps, then use the [built-in info plugin](https://jaywhj.github.io/mkdocs-materialx/plugins/info/) (mandatory) to create a self-contained + bug. First, read our [reproduction guide](https://jaywhj.github.io/mkdocs-materialx/guides/creating-a-reproduction) + that explains the necessary steps, then use the [built-in info plugin](https://jaywhj.github.io/mkdocs-materialx/plugins/info) (mandatory) to create a self-contained .zip file with the reproduction. We reserve the right to close issues without .zip files. - [More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug/#reproduction) + [More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug#reproduction) placeholder: |- Drag and drop the .zip file with the minimal reproduction here. validations: @@ -70,7 +70,7 @@ body: through the required steps, helping us to recreate the problem using the minimal reproduction you provided. Be as specific as possible and as verbose as necessary – try not to leave anything out. - [More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug/#steps-to-reproduce) + [More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug#steps-to-reproduce) placeholder: |- 1. ... 2. ... @@ -87,7 +87,7 @@ body: please select them from the dropdown below. If your browser is not listed or the version is relevant, you may select _Other_ and provide more details in the field above. - [More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug/#browser) + [More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug#browser) multiple: true options: - Chrome @@ -108,7 +108,7 @@ body: box. This will save the maintainers and you valuable time. options: - label: >- - I have read and followed the [bug reporting guidelines](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug/). + I have read and followed the [bug reporting guidelines](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug). required: true - label: >- I have attached links to [the documentation](https://jaywhj.github.io/mkdocs-materialx/), @@ -116,9 +116,9 @@ body: and [discussions](https://github.com/jaywhj/mkdocs-materialx/discussions). required: true - label: >- - I assure that I have [removed all customizations](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug/#remove-customizations) + I assure that I have [removed all customizations](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug#remove-customizations) before submitting this bug report. required: true - label: >- - I have attached a __.zip file__ with a [minimal reproduction](https://jaywhj.github.io/mkdocs-materialx/guides/creating-a-reproduction/) using the [built-in info plugin](https://jaywhj.github.io/mkdocs-materialx/plugins/info/). + I have attached a __.zip file__ with a [minimal reproduction](https://jaywhj.github.io/mkdocs-materialx/guides/creating-a-reproduction) using the [built-in info plugin](https://jaywhj.github.io/mkdocs-materialx/plugins/info). required: true diff --git a/.github/ISSUE_TEMPLATE/02-report-a-docs-issue.yml b/.github/ISSUE_TEMPLATE/02-report-a-docs-issue.yml index 9dc600e04..53a3c9a86 100644 --- a/.github/ISSUE_TEMPLATE/02-report-a-docs-issue.yml +++ b/.github/ISSUE_TEMPLATE/02-report-a-docs-issue.yml @@ -14,7 +14,7 @@ body: or indicate where you feel there is a need for improvement. Furthermore, explain the severity of the issue, i.e., its impact on you and potentially other users. - [More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-docs-issue/#description) + [More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-docs-issue#description) validations: required: true @@ -29,9 +29,9 @@ body: and closed [issues](https://github.com/jaywhj/mkdocs-materialx/issues) and [discussions](https://github.com/jaywhj/mkdocs-materialx/discussions) you encountered when searching our issue tracker. - [More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-docs-issue/#related-links) + [More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-docs-issue#related-links) value: |- - - [Reporting a docs issue](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-docs-issue/) + - [Reporting a docs issue](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-docs-issue) - validations: required: true @@ -44,7 +44,7 @@ body: This field is optional. You may provide an improvement proposal for our documentation by describing your suggestion in the text field below or creating a pull request after reporting this issue referencing the issue. - [More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-docs-issue/#proposed-change) + [More](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-docs-issue#proposed-change) - type: checkboxes id: checklist @@ -58,8 +58,8 @@ body: valuable time. options: - label: >- - I have read and followed the [documentation issue guidelines](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-docs-issue/). + I have read and followed the [documentation issue guidelines](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-docs-issue). required: true - label: >- - I have attached the links to the affected sections of [the documentation](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-docs-issue/#related-links) + I have attached the links to the affected sections of [the documentation](https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-docs-issue#related-links) required: true diff --git a/docs/archives/blog/posts/goodbye-github-discussions.md b/docs/archives/blog/posts/goodbye-github-discussions.md index 6467c7499..0ec45ad54 100644 --- a/docs/archives/blog/posts/goodbye-github-discussions.md +++ b/docs/archives/blog/posts/goodbye-github-discussions.md @@ -83,8 +83,8 @@ Despite these measures, we faced serveral structural challenges: [Community Experts Program]: https://github.com/squidfunk/mkdocs-material/discussions/6363 [GitHub Discussions]: https://github.com/features/discussions - [contribution guidelines]: https://jaywhj.github.io/mkdocs-materialx/contributing/ - [bug reporting guidelines]: https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug/ + [contribution guidelines]: https://jaywhj.github.io/mkdocs-materialx/contributing + [bug reporting guidelines]: https://jaywhj.github.io/mkdocs-materialx/contributing/reporting-a-bug ### Addressing these challenges diff --git a/docs/contributing/making-a-pull-request.md b/docs/contributing/making-a-pull-request.md index dff31e434..ff37dd497 100644 --- a/docs/contributing/making-a-pull-request.md +++ b/docs/contributing/making-a-pull-request.md @@ -336,13 +336,12 @@ shows how your new feature is meant to work. repository. [smoke tests]: https://en.wikipedia.org/wiki/Smoke_testing_(software) -[minimal reproduction]: https://jaywhj.github.io/mkdocs-materialx/guides/creating-a-reproduction/ +[minimal reproduction]: https://jaywhj.github.io/mkdocs-materialx/guides/creating-a-reproduction [MaterialX for MkDocs Examples]: https://github.com/mkdocs-material/examples - Ideally, also test the examples in the [examples repository]. [examples repository]: https://github.com/mkdocs-material/examples -[projects plugin]: https://jaywhj.github.io/mkdocs-materialx/plugins/projects/ ### Creating the pull request diff --git a/docs/tutorials/blogs/engage.md b/docs/tutorials/blogs/engage.md index 921dbef07..97a2aea12 100644 --- a/docs/tutorials/blogs/engage.md +++ b/docs/tutorials/blogs/engage.md @@ -365,5 +365,5 @@ provides comprehensive documentation for the plugin. You may also want to look at the [social plugin tutorial] to generate social cards for your blog posts that get displayed when you post links to social media systems. -[blog plugin reference]: https://jaywhj.github.io/mkdocs-materialx/plugins/blog/ +[blog plugin reference]: https://jaywhj.github.io/mkdocs-materialx/plugins/blog [social plugin tutorial]: ../social/basic.md diff --git a/docs/tutorials/blogs/navigation.md b/docs/tutorials/blogs/navigation.md index f3cd999a9..87c347d41 100644 --- a/docs/tutorials/blogs/navigation.md +++ b/docs/tutorials/blogs/navigation.md @@ -155,7 +155,7 @@ them accessible independently of the main navigation structure. Tags are useful for making related content easily discoverable even if it is in different parts of the navigation hierarchy. -[Tags plugin]: https://jaywhj.github.io/mkdocs-materialx/plugins/tags/ +[Tags plugin]: https://jaywhj.github.io/mkdocs-materialx/plugins/tags You may have a tutorial like this one as well as a more comprehensive setup guide and reference documentation. Adding the same tag to all three shows that they