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
2 changes: 1 addition & 1 deletion .github/DISCUSSION_TEMPLATE/_.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ body:
>
> **Discussions closed as of November 18, 2025**
>
> As outlined in our [blog post](https://squidfunk.github.io/mkdocs-material/blog/2025/11/18/goodbye-github-discussions/), we're closing our discussion board, giving the community a new home in our [Discord channel](https://discord.gg/hqXRNq9CjT) at [Zensical](https://zensical.org/). This means that it's not possible to create new discussions, or comment on existing ones. You can join our [Discord channel](https://discord.gg/hqXRNq9CjT) to continue the conversation, or, if you are a professional user, consider joining [Zensical Spark](https://zensical.org/spark/), our collaborative space for professionals.
> As outlined in our [blog post](https://mkdocs-ng.github.io/mkdocs-material/blog/2025/11/18/goodbye-github-discussions/), we're closing our discussion board, giving the community a new home in our [Discord channel](https://discord.gg/hqXRNq9CjT) at [Zensical](https://zensical.org/). This means that it's not possible to create new discussions, or comment on existing ones. You can join our [Discord channel](https://discord.gg/hqXRNq9CjT) to continue the conversation, or, if you are a professional user, consider joining [Zensical Spark](https://zensical.org/spark/), our collaborative space for professionals.
>
> Thank you for your understanding.
>
Expand Down
2 changes: 1 addition & 1 deletion .github/DISCUSSION_TEMPLATE/general.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ body:
>
> **Discussions closed as of November 18, 2025**
>
> As outlined in our [blog post](https://squidfunk.github.io/mkdocs-material/blog/2025/11/18/goodbye-github-discussions/), we're closing our discussion board, giving the community a new home in our [Discord channel](https://discord.gg/hqXRNq9CjT) at [Zensical](https://zensical.org/). This means that it's not possible to create new discussions, or comment on existing ones. You can join our [Discord channel](https://discord.gg/hqXRNq9CjT) to continue the conversation, or, if you are a professional user, consider joining [Zensical Spark](https://zensical.org/spark/), our collaborative space for professionals.
> As outlined in our [blog post](https://mkdocs-ng.github.io/mkdocs-material/blog/2025/11/18/goodbye-github-discussions/), we're closing our discussion board, giving the community a new home in our [Discord channel](https://discord.gg/hqXRNq9CjT) at [Zensical](https://zensical.org/). This means that it's not possible to create new discussions, or comment on existing ones. You can join our [Discord channel](https://discord.gg/hqXRNq9CjT) to continue the conversation, or, if you are a professional user, consider joining [Zensical Spark](https://zensical.org/spark/), our collaborative space for professionals.
>
> Thank you for your understanding.
>
Expand Down
2 changes: 1 addition & 1 deletion .github/DISCUSSION_TEMPLATE/ideas.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ body:
>
> **Discussions closed as of November 18, 2025**
>
> As outlined in our [blog post](https://squidfunk.github.io/mkdocs-material/blog/2025/11/18/goodbye-github-discussions/), we're closing our discussion board, giving the community a new home in our [Discord channel](https://discord.gg/hqXRNq9CjT) at [Zensical](https://zensical.org/). This means that it's not possible to create new discussions, or comment on existing ones. You can join our [Discord channel](https://discord.gg/hqXRNq9CjT) to continue the conversation, or, if you are a professional user, consider joining [Zensical Spark](https://zensical.org/spark/), our collaborative space for professionals.
> As outlined in our [blog post](https://mkdocs-ng.github.io/mkdocs-material/blog/2025/11/18/goodbye-github-discussions/), we're closing our discussion board, giving the community a new home in our [Discord channel](https://discord.gg/hqXRNq9CjT) at [Zensical](https://zensical.org/). This means that it's not possible to create new discussions, or comment on existing ones. You can join our [Discord channel](https://discord.gg/hqXRNq9CjT) to continue the conversation, or, if you are a professional user, consider joining [Zensical Spark](https://zensical.org/spark/), our collaborative space for professionals.
>
> Thank you for your understanding.
>
Expand Down
2 changes: 1 addition & 1 deletion .github/DISCUSSION_TEMPLATE/q-a.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ body:
>
> **Discussions closed as of November 18, 2025**
>
> As outlined in our [blog post](https://squidfunk.github.io/mkdocs-material/blog/2025/11/18/goodbye-github-discussions/), we're closing our discussion board, giving the community a new home in our [Discord channel](https://discord.gg/hqXRNq9CjT) at [Zensical](https://zensical.org/). This means that it's not possible to create new discussions, or comment on existing ones. You can join our [Discord channel](https://discord.gg/hqXRNq9CjT) to continue the conversation, or, if you are a professional user, consider joining [Zensical Spark](https://zensical.org/spark/), our collaborative space for professionals.
> As outlined in our [blog post](https://mkdocs-ng.github.io/mkdocs-material/blog/2025/11/18/goodbye-github-discussions/), we're closing our discussion board, giving the community a new home in our [Discord channel](https://discord.gg/hqXRNq9CjT) at [Zensical](https://zensical.org/). This means that it's not possible to create new discussions, or comment on existing ones. You can join our [Discord channel](https://discord.gg/hqXRNq9CjT) to continue the conversation, or, if you are a professional user, consider joining [Zensical Spark](https://zensical.org/spark/), our collaborative space for professionals.
>
> Thank you for your understanding.
>
Expand Down
2 changes: 1 addition & 1 deletion .github/DISCUSSION_TEMPLATE/show-and-tell.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ body:
>
> **Discussions closed as of November 18, 2025**
>
> As outlined in our [blog post](https://squidfunk.github.io/mkdocs-material/blog/2025/11/18/goodbye-github-discussions/), we're closing our discussion board, giving the community a new home in our [Discord channel](https://discord.gg/hqXRNq9CjT) at [Zensical](https://zensical.org/). This means that it's not possible to create new discussions, or comment on existing ones. You can join our [Discord channel](https://discord.gg/hqXRNq9CjT) to continue the conversation, or, if you are a professional user, consider joining [Zensical Spark](https://zensical.org/spark/), our collaborative space for professionals.
> As outlined in our [blog post](https://mkdocs-ng.github.io/mkdocs-material/blog/2025/11/18/goodbye-github-discussions/), we're closing our discussion board, giving the community a new home in our [Discord channel](https://discord.gg/hqXRNq9CjT) at [Zensical](https://zensical.org/). This means that it's not possible to create new discussions, or comment on existing ones. You can join our [Discord channel](https://discord.gg/hqXRNq9CjT) to continue the conversation, or, if you are a professional user, consider joining [Zensical Spark](https://zensical.org/spark/), our collaborative space for professionals.
>
> Thank you for your understanding.
>
Expand Down
36 changes: 18 additions & 18 deletions .github/ISSUE_TEMPLATE/01-report-a-bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#context)
[More](https://mkdocs-ng.github.io/mkdocs-material/contributing/reporting-a-bug/#context)

- type: textarea
id: description
Expand All @@ -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://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#bug-description)
[More](https://mkdocs-ng.github.io/mkdocs-material/contributing/reporting-a-bug/#bug-description)
validations:
required: true

Expand All @@ -32,15 +32,15 @@ body:
label: Related links
description: >-
Please list all links to the sections of
[our documentation](https://squidfunk.github.io/mkdocs-material/) that
[our documentation](https://mkdocs-ng.github.io/mkdocs-material/) that
are relevant to the bug in order to show that you have consulted and
thoroughly read it. Additionally, list links to possibly related open
and closed [issues](https://github.com/squidfunk/mkdocs-material/issues)
and [discussions](https://github.com/squidfunk/mkdocs-material/discussions)
and closed [issues](https://github.com/mkdocs-ng/mkdocs-material/issues)
and [discussions](https://github.com/mkdocs-ng/mkdocs-material/discussions)
you encountered when searching our issue tracker.
[More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#related-links)
[More](https://mkdocs-ng.github.io/mkdocs-material/contributing/reporting-a-bug/#related-links)
value: |-
- [Reporting a bug](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/)
- [Reporting a bug](https://mkdocs-ng.github.io/mkdocs-material/contributing/reporting-a-bug/)
-
validations:
required: true
Expand All @@ -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://squidfunk.github.io/mkdocs-material/guides/creating-a-reproduction/)
that explains the necessary steps, then use the [built-in info plugin](https://squidfunk.github.io/mkdocs-material/plugins/info/) (mandatory) to create a self-contained
bug. First, read our [reproduction guide](https://mkdocs-ng.github.io/mkdocs-material/guides/creating-a-reproduction/)
that explains the necessary steps, then use the [built-in info plugin](https://mkdocs-ng.github.io/mkdocs-material/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://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#reproduction)
[More](https://mkdocs-ng.github.io/mkdocs-material/contributing/reporting-a-bug/#reproduction)
placeholder: |-
Drag and drop the .zip file with the minimal reproduction here.
validations:
Expand All @@ -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://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#steps-to-reproduce)
[More](https://mkdocs-ng.github.io/mkdocs-material/contributing/reporting-a-bug/#steps-to-reproduce)
placeholder: |-
1. ...
2. ...
Expand All @@ -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://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#browser)
[More](https://mkdocs-ng.github.io/mkdocs-material/contributing/reporting-a-bug/#browser)
multiple: true
options:
- Chrome
Expand All @@ -108,17 +108,17 @@ body:
box. This will save the maintainers and you valuable time.
options:
- label: >-
I have read and followed the [bug reporting guidelines](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/).
I have read and followed the [bug reporting guidelines](https://mkdocs-ng.github.io/mkdocs-material/contributing/reporting-a-bug/).
required: true
- label: >-
I have attached links to [the documentation](https://squidfunk.github.io/mkdocs-material/),
and possibly related [issues](https://github.com/squidfunk/mkdocs-material/issues)
and [discussions](https://github.com/squidfunk/mkdocs-material/discussions).
I have attached links to [the documentation](https://mkdocs-ng.github.io/mkdocs-material/),
and possibly related [issues](https://github.com/mkdocs-ng/mkdocs-material/issues)
and [discussions](https://github.com/mkdocs-ng/mkdocs-material/discussions).
required: true
- label: >-
I assure that I have [removed all customizations](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/#remove-customizations)
I assure that I have [removed all customizations](https://mkdocs-ng.github.io/mkdocs-material/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://squidfunk.github.io/mkdocs-material/guides/creating-a-reproduction/) using the [built-in info plugin](https://squidfunk.github.io/mkdocs-material/plugins/info/).
I have attached a __.zip file__ with a [minimal reproduction](https://mkdocs-ng.github.io/mkdocs-material/guides/creating-a-reproduction/) using the [built-in info plugin](https://mkdocs-ng.github.io/mkdocs-material/plugins/info/).
required: true
20 changes: 10 additions & 10 deletions .github/ISSUE_TEMPLATE/02-report-a-docs-issue.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ body:
label: Description
description: >-
Please describe the inconsistency or issue you have found in
[our documentation](https://squidfunk.github.io/mkdocs-material/)
[our documentation](https://mkdocs-ng.github.io/mkdocs-material/)
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://squidfunk.github.io/mkdocs-material/contributing/reporting-a-docs-issue/#description)
[More](https://mkdocs-ng.github.io/mkdocs-material/contributing/reporting-a-docs-issue/#description)
validations:
required: true

Expand All @@ -23,15 +23,15 @@ body:
attributes:
label: Related links
description: >-
Please list all links to the sections of [our documentation](https://squidfunk.github.io/mkdocs-material/)
Please list all links to the sections of [our documentation](https://mkdocs-ng.github.io/mkdocs-material/)
that are impacted by the issue you described above. If applicable,
add screenshots. Additionally, list links to possibly related open
and closed [issues](https://github.com/squidfunk/mkdocs-material/issues)
and [discussions](https://github.com/squidfunk/mkdocs-material/discussions)
and closed [issues](https://github.com/mkdocs-ng/mkdocs-material/issues)
and [discussions](https://github.com/mkdocs-ng/mkdocs-material/discussions)
you encountered when searching our issue tracker.
[More](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-docs-issue/#related-links)
[More](https://mkdocs-ng.github.io/mkdocs-material/contributing/reporting-a-docs-issue/#related-links)
value: |-
- [Reporting a docs issue](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-docs-issue/)
- [Reporting a docs issue](https://mkdocs-ng.github.io/mkdocs-material/contributing/reporting-a-docs-issue/)
-
validations:
required: true
Expand All @@ -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://squidfunk.github.io/mkdocs-material/contributing/reporting-a-docs-issue/#proposed-change)
[More](https://mkdocs-ng.github.io/mkdocs-material/contributing/reporting-a-docs-issue/#proposed-change)

- type: checkboxes
id: checklist
Expand All @@ -58,8 +58,8 @@ body:
valuable time.
options:
- label: >-
I have read and followed the [documentation issue guidelines](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-docs-issue/).
I have read and followed the [documentation issue guidelines](https://mkdocs-ng.github.io/mkdocs-material/contributing/reporting-a-docs-issue/).
required: true
- label: >-
I have attached the links to the affected sections of [the documentation](https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-docs-issue/#related-links)
I have attached the links to the affected sections of [the documentation](https://mkdocs-ng.github.io/mkdocs-material/contributing/reporting-a-docs-issue/#related-links)
required: true
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
blank_issues_enabled: false
contact_links:
- name: Ask a question
url: https://github.com/squidfunk/mkdocs-material/discussions
url: https://github.com/mkdocs-ng/mkdocs-material/discussions
about: >
Have a question or need help? Connect with our community on the
discussion board
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,9 @@ jobs:
# env:
# GH_TOKEN: ${{ secrets.GH_TOKEN }}
# run: |
# # Warning: this method is used only for squidfunk/mkdocs-material
# # Warning: this method is used only for mkdocs-ng/mkdocs-material
# # documentation builds. For your own site, see the publishing guide.
# git clone --depth 1 https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
# git clone --depth 1 https://${GH_TOKEN}@github.com/mkdocs-ng/mkdocs-material-insiders.git
# pip install -e mkdocs-material-insiders
# cp mkdocs-material-insiders/mkdocs.yml mkdocs.yml
# rm -rf material
Expand Down
3 changes: 2 additions & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ further defined and clarified by project maintainers.
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team privately at hello@squidfunk.com. The
reported by contacting the project team via GitHub Issues at
https://github.com/mkdocs-ng/mkdocs-material/issues. The
project team will review and investigate all complaints, and will respond in a
way that it deems appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an
Expand Down
8 changes: 4 additions & 4 deletions docs/blog/.authors.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
authors:
squidfunk:
name: Martin Donath
description: Creator
mkdocs-ng:
name: MkDocs NG Team
description: Maintainer
avatar: https://avatars.githubusercontent.com/u/932156
url: https://github.com/squidfunk
url: https://github.com/mkdocs-ng
alexvoss:
name: Alex Voss
description: Solutions Architect
Expand Down
4 changes: 2 additions & 2 deletions docs/blog/posts/adding-a-badge-to-your-project.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Adding a badge to your project
date: 2023-11-30
authors: [squidfunk]
authors: [mkdocs-ng]
slug: adding-a-badge-to-your-project
description: >
Share the love – you can now add a badge to your README, showing that your
Expand Down Expand Up @@ -29,7 +29,7 @@ you can add to your project's README:
Just copy the following snippet and paste it into your project's `README.md`:

``` markdown
[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge&logo=MaterialForMkDocs&logoColor=white)](https://squidfunk.github.io/mkdocs-material/)
[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge&logo=MaterialForMkDocs&logoColor=white)](https://mkdocs-ng.github.io/mkdocs-material/)
```

[Simple Icons]: https://simpleicons.org/
Expand Down
2 changes: 1 addition & 1 deletion docs/blog/posts/blog-support-just-landed.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
date: 2022-09-12
authors: [squidfunk]
authors: [mkdocs-ng]
description: >
Our new blog is built with the brand new built-in blog plugin. You can build
a blog alongside your documentation or standalone
Expand Down
Loading
Loading