From a4d4cdf0802bf1b1c5b7c66f01f286369117d370 Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Mon, 27 Apr 2026 14:34:36 +0300 Subject: [PATCH 1/2] Rebrand to mkdocs-ng ecosystem - Remove MkDocs 2.0 warning, replace with mkdocs-ng maintainership notice - Update all www.mkdocs.org URLs to mkdocs-ng.github.io/mkdocs/ - Update all squidfunk.github.io/mkdocs-material URLs to mkdocs-ng.github.io/mkdocs-material/ - Update all github.com/squidfunk/mkdocs-material* references to github.com/mkdocs-ng/mkdocs-material* - Update pip install command to mkdocs-ng-material - Update announcement bar, social links, issue URLs, and author metadata - Update schema JSON files, GitHub templates, and build tool URLs - CLI command remains mkdocs; Python imports remain unchanged --- .github/DISCUSSION_TEMPLATE/_.yaml | 2 +- .github/DISCUSSION_TEMPLATE/general.yaml | 2 +- .github/DISCUSSION_TEMPLATE/ideas.yaml | 2 +- .github/DISCUSSION_TEMPLATE/q-a.yaml | 2 +- .../DISCUSSION_TEMPLATE/show-and-tell.yaml | 2 +- .github/ISSUE_TEMPLATE/01-report-a-bug.yml | 36 +++--- .../ISSUE_TEMPLATE/02-report-a-docs-issue.yml | 20 ++-- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/assets/.!26306!screenshot.png | 0 .github/workflows/documentation.yml | 4 +- CODE_OF_CONDUCT.md | 3 +- docs/blog/.authors.yml | 8 +- .../posts/adding-a-badge-to-your-project.md | 4 +- docs/blog/posts/blog-support-just-landed.md | 2 +- docs/blog/posts/chinese-search-support.md | 6 +- .../posts/excluding-content-from-search.md | 2 +- docs/blog/posts/git-sparse-checkout.md | 2 +- docs/blog/posts/goodbye-github-discussions.md | 10 +- .../posts/insiders-now-free-for-everyone.md | 8 +- docs/blog/posts/mkdocs-2.0.md | 6 +- .../posts/search-better-faster-smaller.md | 16 +-- docs/blog/posts/sunsetting-gitter.md | 6 +- .../blog/posts/the-past-present-and-future.md | 18 +-- .../posts/transforming-material-for-mkdocs.md | 34 +++--- docs/blog/posts/zensical.md | 4 +- docs/browser-support.md | 2 +- docs/changelog/index.md | 6 +- docs/contributing/reporting-a-bug.md | 12 +- docs/contributing/requesting-a-change.md | 2 +- docs/creating-your-site.md | 4 +- docs/customization.md | 8 +- docs/insiders/getting-started.md | 14 +-- docs/insiders/upgrade.md | 6 +- docs/plugins/blog.md | 10 +- docs/plugins/index.md | 2 +- docs/plugins/info.md | 2 +- docs/plugins/meta.md | 2 +- docs/plugins/offline.md | 4 +- docs/plugins/projects.md | 2 +- docs/plugins/requirements/image-processing.md | 16 +-- docs/plugins/social.md | 4 +- docs/plugins/typeset.md | 2 +- docs/publishing-your-site.md | 6 +- docs/reference/admonitions.md | 2 +- docs/reference/code-blocks.md | 6 +- docs/reference/grids.md | 2 +- docs/reference/icons-emojis.md | 2 +- docs/reference/index.md | 6 +- docs/schema.json | 56 ++++----- docs/schema/assets/icons.json | 2 +- docs/schema/extensions.json | 2 +- docs/schema/extensions/markdown.json | 32 +++--- docs/schema/extensions/pymdownx.json | 104 ++++++++--------- docs/schema/extra.json | 84 +++++++------- docs/schema/nav.json | 8 +- docs/schema/plugins.json | 2 +- docs/schema/plugins/blog.json | 106 +++++++++--------- .../plugins/external/git-committers.json | 6 +- docs/schema/plugins/group.json | 6 +- docs/schema/plugins/info.json | 12 +- docs/schema/plugins/meta.json | 8 +- docs/schema/plugins/offline.json | 6 +- docs/schema/plugins/optimize.json | 36 +++--- docs/schema/plugins/privacy.json | 36 +++--- docs/schema/plugins/projects.json | 26 ++--- docs/schema/plugins/search.json | 14 +-- docs/schema/plugins/social.json | 44 ++++---- docs/schema/plugins/tags.json | 72 ++++++------ docs/schema/plugins/typeset.json | 6 +- docs/schema/theme.json | 104 ++++++++--------- docs/schema/validation.json | 6 +- docs/setup/adding-a-comment-system.md | 2 +- docs/setup/adding-a-git-repository.md | 10 +- docs/setup/building-an-optimized-site.md | 2 +- docs/setup/building-for-offline-usage.md | 4 +- docs/setup/changing-the-language.md | 2 +- docs/setup/changing-the-logo-and-icons.md | 4 +- .../extensions/python-markdown-extensions.md | 2 +- docs/setup/extensions/python-markdown.md | 2 +- docs/setup/setting-up-a-blog.md | 10 +- docs/setup/setting-up-navigation.md | 2 +- docs/setup/setting-up-social-cards.md | 6 +- docs/setup/setting-up-the-footer.md | 10 +- docs/tutorials/blogs/basic.md | 4 +- docs/tutorials/blogs/engage.md | 6 +- docs/tutorials/blogs/navigation.md | 6 +- docs/tutorials/index.md | 2 +- docs/tutorials/social/basic.md | 2 +- docs/upgrade.md | 20 ++-- includes/mkdocs.md | 26 ++--- .../assets/javascripts/custom.f46acd93.min.js | 2 +- material/overrides/hooks/translations.py | 2 +- material/overrides/main.html | 18 +-- material/plugins/info/plugin.py | 6 +- material/templates/__init__.py | 30 ++--- material/templates/partials/copyright.html | 2 +- src/overrides/hooks/translations.py | 2 +- src/overrides/main.html | 18 +-- src/plugins/info/plugin.py | 6 +- src/templates/__init__.py | 30 ++--- .../integrations/version/findurl/index.ts | 2 +- .../javascripts/integrations/version/index.ts | 2 +- src/templates/partials/copyright.html | 2 +- tools/build/index.ts | 4 +- 104 files changed, 659 insertions(+), 690 deletions(-) create mode 100644 .github/assets/.!26306!screenshot.png diff --git a/.github/DISCUSSION_TEMPLATE/_.yaml b/.github/DISCUSSION_TEMPLATE/_.yaml index 34910abbd3..d5b9ed615d 100644 --- a/.github/DISCUSSION_TEMPLATE/_.yaml +++ b/.github/DISCUSSION_TEMPLATE/_.yaml @@ -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. > diff --git a/.github/DISCUSSION_TEMPLATE/general.yaml b/.github/DISCUSSION_TEMPLATE/general.yaml index 34910abbd3..d5b9ed615d 100644 --- a/.github/DISCUSSION_TEMPLATE/general.yaml +++ b/.github/DISCUSSION_TEMPLATE/general.yaml @@ -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. > diff --git a/.github/DISCUSSION_TEMPLATE/ideas.yaml b/.github/DISCUSSION_TEMPLATE/ideas.yaml index 34910abbd3..d5b9ed615d 100644 --- a/.github/DISCUSSION_TEMPLATE/ideas.yaml +++ b/.github/DISCUSSION_TEMPLATE/ideas.yaml @@ -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. > diff --git a/.github/DISCUSSION_TEMPLATE/q-a.yaml b/.github/DISCUSSION_TEMPLATE/q-a.yaml index 34910abbd3..d5b9ed615d 100644 --- a/.github/DISCUSSION_TEMPLATE/q-a.yaml +++ b/.github/DISCUSSION_TEMPLATE/q-a.yaml @@ -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. > diff --git a/.github/DISCUSSION_TEMPLATE/show-and-tell.yaml b/.github/DISCUSSION_TEMPLATE/show-and-tell.yaml index 34910abbd3..d5b9ed615d 100644 --- a/.github/DISCUSSION_TEMPLATE/show-and-tell.yaml +++ b/.github/DISCUSSION_TEMPLATE/show-and-tell.yaml @@ -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. > diff --git a/.github/ISSUE_TEMPLATE/01-report-a-bug.yml b/.github/ISSUE_TEMPLATE/01-report-a-bug.yml index 7658f4e10c..31374dbad7 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://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 @@ -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 @@ -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 @@ -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: @@ -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. ... @@ -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 @@ -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 diff --git a/.github/ISSUE_TEMPLATE/02-report-a-docs-issue.yml b/.github/ISSUE_TEMPLATE/02-report-a-docs-issue.yml index 3ea1c79fd7..546644847e 100644 --- a/.github/ISSUE_TEMPLATE/02-report-a-docs-issue.yml +++ b/.github/ISSUE_TEMPLATE/02-report-a-docs-issue.yml @@ -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 @@ -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 @@ -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 @@ -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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 432544f21a..26a500a722 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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 diff --git a/.github/assets/.!26306!screenshot.png b/.github/assets/.!26306!screenshot.png new file mode 100644 index 0000000000..e69de29bb2 diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 35b230f7d3..7c687f6dae 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -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 diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index c0ab1ca275..ab1c6f5bae 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -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 diff --git a/docs/blog/.authors.yml b/docs/blog/.authors.yml index a2a5dd4300..239cc107d4 100644 --- a/docs/blog/.authors.yml +++ b/docs/blog/.authors.yml @@ -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 diff --git a/docs/blog/posts/adding-a-badge-to-your-project.md b/docs/blog/posts/adding-a-badge-to-your-project.md index 26fd7bd9b5..2f055e745a 100644 --- a/docs/blog/posts/adding-a-badge-to-your-project.md +++ b/docs/blog/posts/adding-a-badge-to-your-project.md @@ -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 @@ -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/ diff --git a/docs/blog/posts/blog-support-just-landed.md b/docs/blog/posts/blog-support-just-landed.md index 8d83ecf307..f7fe2fddde 100644 --- a/docs/blog/posts/blog-support-just-landed.md +++ b/docs/blog/posts/blog-support-just-landed.md @@ -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 diff --git a/docs/blog/posts/chinese-search-support.md b/docs/blog/posts/chinese-search-support.md index 541da997c9..382a9e5d5a 100644 --- a/docs/blog/posts/chinese-search-support.md +++ b/docs/blog/posts/chinese-search-support.md @@ -1,6 +1,6 @@ --- date: 2022-05-05 -authors: [squidfunk] +authors: [mkdocs-ng] title: Chinese search support description: > Insiders adds Chinese language support for the built-in search plugin – a @@ -71,7 +71,7 @@ built-in search plugin. --- -Note that this is an experimental feature, and I, @squidfunk, am not +Note that this is an experimental feature, and I, @mkdocs-ng, am not proficient in Chinese (yet?). If you find a bug or think something can be improved, please [open an issue]. @@ -79,4 +79,4 @@ improved, please [open an issue]. [zero-width whitespace]: https://en.wikipedia.org/wiki/Zero-width_space [separator]: ../../plugins/search.md#config.separator [q=支持]: ?q=支持 - [open an issue]: https://github.com/squidfunk/mkdocs-material/issues/new/choose + [open an issue]: https://github.com/mkdocs-ng/mkdocs-material/issues/new/choose diff --git a/docs/blog/posts/excluding-content-from-search.md b/docs/blog/posts/excluding-content-from-search.md index b838008126..22ea205e0b 100644 --- a/docs/blog/posts/excluding-content-from-search.md +++ b/docs/blog/posts/excluding-content-from-search.md @@ -1,6 +1,6 @@ --- date: 2021-09-26 -authors: [squidfunk] +authors: [mkdocs-ng] description: > Three new simple ways to exclude dedicated parts of a document from the search index, allowing for more fine-grained control diff --git a/docs/blog/posts/git-sparse-checkout.md b/docs/blog/posts/git-sparse-checkout.md index e16b2a6aec..a32bcbb7c3 100644 --- a/docs/blog/posts/git-sparse-checkout.md +++ b/docs/blog/posts/git-sparse-checkout.md @@ -1,6 +1,6 @@ --- date: 2023-09-22 -authors: [squidfunk] +authors: [mkdocs-ng] categories: - Build - Performance diff --git a/docs/blog/posts/goodbye-github-discussions.md b/docs/blog/posts/goodbye-github-discussions.md index dc3e1db2fe..c98c203e36 100644 --- a/docs/blog/posts/goodbye-github-discussions.md +++ b/docs/blog/posts/goodbye-github-discussions.md @@ -1,7 +1,7 @@ --- date: 2025-11-18 authors: - - squidfunk + - mkdocs-ng - alexvoss - katharinalisalin - pawamoy @@ -29,7 +29,7 @@ _You can subscribe to [our newsletter] to stay in the loop_. [Our new approach]: https://zensical.org/docs/community/how-we-work/ - [maintenance mode]: https://github.com/squidfunk/mkdocs-material/issues/8523 + [maintenance mode]: https://github.com/mkdocs-ng/mkdocs-material/issues/8523 [Zensical]: https://zensical.org [two weeks ago]: zensical.md [our newsletter]: https://zensical.org/about/newsletter/ @@ -83,10 +83,10 @@ Despite these measures, we faced serveral structural challenges: 5. __Bug reports on our discussion board__ – From time to time, our [contribution guidelines] were ignored, leading to spurious bug reports on our discussion board instead of our issue tracker – "search doesn't work" is not an actionable bug report. However, when users followed our [bug reporting guidelines], we were able to fix most bugs within 24-48 hours. - [Community Experts Program]: https://github.com/squidfunk/mkdocs-material/discussions/6363 + [Community Experts Program]: https://github.com/mkdocs-ng/mkdocs-material/discussions/6363 [GitHub Discussions]: https://github.com/features/discussions - [contribution guidelines]: https://squidfunk.github.io/mkdocs-material/contributing/ - [bug reporting guidelines]: https://squidfunk.github.io/mkdocs-material/contributing/reporting-a-bug/ + [contribution guidelines]: https://mkdocs-ng.github.io/mkdocs-material/contributing/ + [bug reporting guidelines]: https://mkdocs-ng.github.io/mkdocs-material/contributing/reporting-a-bug/ ### Addressing these challenges diff --git a/docs/blog/posts/insiders-now-free-for-everyone.md b/docs/blog/posts/insiders-now-free-for-everyone.md index 078e48a5f6..305dcc7ff1 100644 --- a/docs/blog/posts/insiders-now-free-for-everyone.md +++ b/docs/blog/posts/insiders-now-free-for-everyone.md @@ -1,7 +1,7 @@ --- date: 2025-11-11 authors: - - squidfunk + - mkdocs-ng - alexvoss - katharinalisalin - pawamoy @@ -34,7 +34,7 @@ _You can subscribe to [our newsletter] to stay in the loop_. [9.7.0]: ../../changelog/index.md#9.7.0 [Zensical]: https://zensical.org - [maintenance mode]: https://github.com/squidfunk/mkdocs-material/issues/8523 + [maintenance mode]: https://github.com/mkdocs-ng/mkdocs-material/issues/8523 [goodbye to GitHub Sponsors]: zensical.md#goodbye-github-sponsors [compatibility with Material for MkDocs]: zensical.md#maximum-compatibility [Open Source, licensed under MIT]: https://zensical.org/about/license/ @@ -133,7 +133,7 @@ __From now on, bug fixes that we make to Material for MkDocs will only be releas Thus, please adjust your `requirements.txt` and GitHub Actions workflows: ```diff -- pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders. git +- pip install git+https://${GH_TOKEN}@github.com/mkdocs-ng/mkdocs-material-insiders. git + pip install mkdocs-material ``` @@ -185,7 +185,7 @@ Material for MkDocs has used semver version ranges for dependencies to ensure co ### Security -We will not transfer ownership of the Material for MkDocs repository to another individual or organization. The repository and PyPI package will remain under the ownership of @squidfunk, which preserves the trusted supply chain our users depend on. +We will not transfer ownership of the Material for MkDocs repository to another individual or organization. The repository and PyPI package will remain under the ownership of @mkdocs-ng, which preserves the trusted supply chain our users depend on. Thus, if you wish to take on maintenance of Material for MkDocs, please create a fork. diff --git a/docs/blog/posts/mkdocs-2.0.md b/docs/blog/posts/mkdocs-2.0.md index a6b4b31c5c..fe6bc972ee 100644 --- a/docs/blog/posts/mkdocs-2.0.md +++ b/docs/blog/posts/mkdocs-2.0.md @@ -3,7 +3,7 @@ date: created: 2026-02-18 updated: 2026-04-13 authors: - - squidfunk + - mkdocs-ng - alexvoss - katharinalisalin categories: @@ -73,13 +73,13 @@ Based on the [official announcement], the published [roadmap], and several prior A release date has not been announced, so planning around a specific timeline remains difficult. However, the direction of travel has been hinted at by the maintainer on several occasions, and the pre-release version already confirms the impact of these changes on existing projects. [official announcement]: https://github.com/mkdocs/mkdocs/discussions/4077 - [roadmap]: https://github.com/squidfunk/mkdocs-material/issues/8478#issuecomment-3778358483 + [roadmap]: https://github.com/mkdocs-ng/mkdocs-material/issues/8478#issuecomment-3778358483 [asked not to open issues or pull requests]: https://github.com/encode/mkdocs?tab=contributing-ov-file#maintainer-driven-issues [removing plugin support to simplify the codebase]: https://github.com/mkdocs/mkdocs/discussions/3815#discussioncomment-10398312 [the plugin ecosystem]: https://github.com/mkdocs/catalog?tab=readme-ov-file#contents [navigation is passed to themes as pre-rendered HTML]: https://www.encode.io/mkdocs/styling/#templates [MkDocs 1.x is unmaintained]: https://github.com/mkdocs/mkdocs/discussions/4010 - [live-reload problems]: https://github.com/squidfunk/mkdocs-material/issues/8478 + [live-reload problems]: https://github.com/mkdocs-ng/mkdocs-material/issues/8478 ## What this means for you diff --git a/docs/blog/posts/search-better-faster-smaller.md b/docs/blog/posts/search-better-faster-smaller.md index 498a5670c2..1b34539617 100644 --- a/docs/blog/posts/search-better-faster-smaller.md +++ b/docs/blog/posts/search-better-faster-smaller.md @@ -1,6 +1,6 @@ --- date: 2021-09-13 -authors: [squidfunk] +authors: [mkdocs-ng] readtime: 15 description: > How we rebuilt client-side search, delivering a better user experience while @@ -166,7 +166,7 @@ search experience for theme authors, which is why Material for MkDocs (up to now) did some [monkey patching] to be able to render slightly more meaningful search previews. - [monkey patching]: https://github.com/squidfunk/mkdocs-material/blob/ec7ccd2b2d15dd033740f388912f7be7738feec2/src/assets/javascripts/integrations/search/document/index.ts#L68-L71 + [monkey patching]: https://github.com/mkdocs-ng/mkdocs-material/blob/ec7ccd2b2d15dd033740f388912f7be7738feec2/src/assets/javascripts/integrations/search/document/index.ts#L68-L71 ### Search worker @@ -207,8 +207,8 @@ into and out of the index. [separator]: ../../plugins/search.md#config.separator [default tokenizer]: https://github.com/olivernn/lunr.js/blob/aa5a878f62a6bba1e8e5b95714899e17e8150b38/lunr.js#L413-L456 - [post-processed]: https://github.com/squidfunk/mkdocs-material/blob/ec7ccd2b2d15dd033740f388912f7be7738feec2/src/assets/javascripts/integrations/search/_/index.ts#L249-L272 - [rescored]: https://github.com/squidfunk/mkdocs-material/blob/ec7ccd2b2d15dd033740f388912f7be7738feec2/src/assets/javascripts/integrations/search/_/index.ts#L274-L275 + [post-processed]: https://github.com/mkdocs-ng/mkdocs-material/blob/ec7ccd2b2d15dd033740f388912f7be7738feec2/src/assets/javascripts/integrations/search/_/index.ts#L249-L272 + [rescored]: https://github.com/mkdocs-ng/mkdocs-material/blob/ec7ccd2b2d15dd033740f388912f7be7738feec2/src/assets/javascripts/integrations/search/_/index.ts#L274-L275 ### Search previews @@ -261,7 +261,7 @@ carefully considered: China and Japan are both within the top 5 countries of origin of users of Material for MkDocs. - [truncated]: https://github.com/squidfunk/mkdocs-material/blob/main/src/templates/assets/javascripts/templates/search/index.tsx#L90 + [truncated]: https://github.com/mkdocs-ng/mkdocs-material/blob/main/src/templates/assets/javascripts/templates/search/index.tsx#L90 [search preview]: search-better-faster-smaller/search-preview.png [Just the Docs]: https://just-the-docs.com [Docusaurus]: https://github.com/lelouch77/docusaurus-lunr-search @@ -435,7 +435,7 @@ explain the remainder of the regular expression.[^4] multiple characters were never supported by [lunr's default tokenizer][default tokenizer]. - [default value]: https://www.mkdocs.org/user-guide/configuration/#separator + [default value]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#separator #### Case changes @@ -543,7 +543,7 @@ powerful as tokenization: see, for example, the results of [:octicons-search-24: twitter][q=twitter]. - [regular expressions]: https://github.com/squidfunk/mkdocs-material/blob/ec7ccd2b2d15dd033740f388912f7be7738feec2/src/assets/javascripts/integrations/search/highlighter/index.ts#L61-L91 + [regular expressions]: https://github.com/mkdocs-ng/mkdocs-material/blob/ec7ccd2b2d15dd033740f388912f7be7738feec2/src/assets/javascripts/integrations/search/highlighter/index.ts#L61-L91 [dedicated segmenter]: http://chasen.org/~taku/software/TinySegmenter/ [new tokenization approach]: #tokenizer-lookahead [case changes]: #case-changes @@ -626,4 +626,4 @@ for MkDocs! This is the first blog article that I decided to write after a short [Twitter survey] made me to. You're invited to leave a comment to share your experiences with the new search implementation. - [X survey]: https://x.com/squidfunk/status/1434477478823743488 + [X survey]: https://x.com/mkdocs-ng/status/1434477478823743488 diff --git a/docs/blog/posts/sunsetting-gitter.md b/docs/blog/posts/sunsetting-gitter.md index 4cc9660197..5717641ed7 100644 --- a/docs/blog/posts/sunsetting-gitter.md +++ b/docs/blog/posts/sunsetting-gitter.md @@ -1,6 +1,6 @@ --- date: 2023-10-02 -authors: [squidfunk, alexvoss] +authors: [mkdocs-ng, alexvoss] categories: - General --- @@ -18,8 +18,8 @@ allow to ask the community for support and to discuss ideas and issues. In the past weeks, we have begun to question whether this duplication is in the best interest of our project. This post explains the rationale behind our decision. - [Gitter]: https://gitter.im/squidfunk/mkdocs-material - [GitHub discussions]: https://github.com/squidfunk/mkdocs-material/discussions + [Gitter]: https://gitter.im/mkdocs-ng/mkdocs-material + [GitHub discussions]: https://github.com/mkdocs-ng/mkdocs-material/discussions diff --git a/docs/blog/posts/the-past-present-and-future.md b/docs/blog/posts/the-past-present-and-future.md index f3ec9645e8..bca01d50b1 100644 --- a/docs/blog/posts/the-past-present-and-future.md +++ b/docs/blog/posts/the-past-present-and-future.md @@ -1,6 +1,6 @@ --- date: 2021-12-27 -authors: [squidfunk] +authors: [mkdocs-ng] description: > 2021 was a fantastic year for this project as we shipped many new awesome features and made this project sustainable @@ -29,7 +29,7 @@ _This article showcases all features that were added in 2021 and gives an outlook on what's going to drop in 2022. Additionally, it provides some context on the history of the project._ - [MkDocs]: https://www.mkdocs.org + [MkDocs]: https://mkdocs-ng.github.io/mkdocs ## A little history @@ -87,10 +87,10 @@ free._ Making Open Source sustainable is, after all, possible in 2021. - [the first version]: https://github.com/squidfunk/mkdocs-material/releases/tag/0.1.0 + [the first version]: https://github.com/mkdocs-ng/mkdocs-material/releases/tag/0.1.0 [Material for MkDocs 0.1.0]: the-past-present-and-future/mkdocs-material-0.1.0.png [Material for MkDocs 0.1.0 Search]: the-past-present-and-future/mkdocs-material-0.1.0-search.png - [protobluff]: https://github.com/squidfunk/protobluff + [protobluff]: https://github.com/mkdocs-ng/protobluff ## 2021 in numbers @@ -252,12 +252,12 @@ features that will see the light of day in 2022: Material for MkDocs. This list is incomplete. Additionally, many new smaller features will be added -next year, just as in 2021. You can follow [@squidfunk on X] to stay +next year, just as in 2021. You can follow [@mkdocs-ng on X] to stay updated. __Happy new year!__ :tada: - [Instant previews]: https://x.com/squidfunk/status/1466794654213492743 - [card grids]: https://github.com/squidfunk/mkdocs-material/issues/3018 - [under investigation]: https://github.com/squidfunk/mkdocs-material/issues/3353 - [@squidfunk on X]: https://x.com/squidfunk + [Instant previews]: https://x.com/mkdocs-ng/status/1466794654213492743 + [card grids]: https://github.com/mkdocs-ng/mkdocs-material/issues/3018 + [under investigation]: https://github.com/mkdocs-ng/mkdocs-material/issues/3353 + [@mkdocs-ng on X]: https://x.com/mkdocs-ng diff --git a/docs/blog/posts/transforming-material-for-mkdocs.md b/docs/blog/posts/transforming-material-for-mkdocs.md index 4390aec5c9..68c19a4265 100644 --- a/docs/blog/posts/transforming-material-for-mkdocs.md +++ b/docs/blog/posts/transforming-material-for-mkdocs.md @@ -1,7 +1,7 @@ --- date: 2024-08-19 authors: - - squidfunk + - mkdocs-ng - alexvoss - katharinalisalin categories: @@ -41,18 +41,18 @@ __This is the first article in a series:__ ## A success story -In 2024, Material for MkDocs has firmly established itself as a leading tool in the documentation framework landscape, with more than 5 million downloads each month as of this writing. What began as @squidfunk's personal project has evolved into a versatile resource for creating comprehensive documentation sites, personal websites, blogs, and notably, for managing knowledge both within and outside of organizations. +In 2024, Material for MkDocs has firmly established itself as a leading tool in the documentation framework landscape, with more than 5 million downloads each month as of this writing. What began as @mkdocs-ng's personal project has evolved into a versatile resource for creating comprehensive documentation sites, personal websites, blogs, and notably, for managing knowledge both within and outside of organizations. With almost [50,000] public GitHub projects depending on Material for MkDocs, it's clear that the framework has made a substantial impact. Tens of thousands of authors rely on us to deliver documentation to millions of users each month.[^1] Beyond its adoption by [many popular Open Source projects], Material for MkDocs is trusted and financially supported by major corporations such as [AWS], [Microsoft], and [Siemens], among many other companies and individuals. We're very grateful for the continued support we receive, which allows us to devote our time to this project, making writing documentation enjoyable. [^1]: We've collected invaluable feedback from enterprises and other Open Source maintainers, which revealed that the actual numbers are even higher. Many organizations leverage the framework within private infrastructures, such as self-hosted platforms like GitLab, for internal knowledge management. This suggests that the true reach of Material for MkDocs extends far beyond what is publicly visible. - [50,000]: https://github.com/squidfunk/mkdocs-material/network/dependents - [many popular Open Source projects]: https://github.com/squidfunk/mkdocs-material?tab=readme-ov-file#trusted-by- - [AWS]: https://x.com/squidfunk/status/1740389441284579767 - [Microsoft]: https://x.com/squidfunk/status/1801909506391105840 - [Siemens]: https://x.com/squidfunk/status/1699799988069646761 + [50,000]: https://github.com/mkdocs-ng/mkdocs-material/network/dependents + [many popular Open Source projects]: https://github.com/mkdocs-ng/mkdocs-material?tab=readme-ov-file#trusted-by- + [AWS]: https://x.com/mkdocs-ng/status/1740389441284579767 + [Microsoft]: https://x.com/mkdocs-ng/status/1801909506391105840 + [Siemens]: https://x.com/mkdocs-ng/status/1699799988069646761 Our users particularly appreciate Material for MkDocs for its ease of use and straightforward setup. It simplifies the process by handling the complexities of web technologies for you, so you can build a production-ready static site in minutes without needing to invest years into mastering frontend development or JavaScript. This makes it accessible to a wide range of users, regardless of their technical background. Additionally, Material for MkDocs is MIT-licensed and free to use, which has contributed to its widespread adoption, and allows everybody to build sophisticated documentation sites at no cost. @@ -69,11 +69,11 @@ Our vision is to provide you with the tools that allow you to __own your docs__, ## Challenges -Now, let's talk about our journey and the particular challenges we're addressing. With "we", we're referring to the incredible team that @squidfunk was fortunate to build around his original work, thanks to the financial support he receives from his [sponsors]. This remarkable team includes @alexvoss and @katharinalisalin, whose invaluable contributions in research, development, and community support have been essential to the project's ongoing success. +Now, let's talk about our journey and the particular challenges we're addressing. With "we", we're referring to the incredible team that @mkdocs-ng was fortunate to build around his original work, thanks to the financial support he receives from his [sponsors]. This remarkable team includes @alexvoss and @katharinalisalin, whose invaluable contributions in research, development, and community support have been essential to the project's ongoing success. Together, we've started exploring new technologies, incorporating the feedback we received from our users, and rethinking critical components from first principles, serving our growing community one of the best frameworks to create documentation. - [sponsors]: https://github.com/sponsors/squidfunk + [sponsors]: https://github.com/sponsors/mkdocs-ng This section highlights the key areas we've been focusing on. @@ -119,7 +119,7 @@ We're excited to share more details about this update in one of the next posts i Supporting multi-language sites in MkDocs is the [most requested feature on our discussion board] and in conversations with users, yet it presents significant challenges, as MkDocs does not natively support it. The same applies to versioning, which also involves synchronisation of multi-project builds. While the MkDocs ecosystem has developed [various plugins and tools] to address these issues, there is still substantial untapped potential. We began exploring these areas but quickly encountered problems that hindered our progress. - [most requested feature on our discussion board]: https://github.com/squidfunk/mkdocs-material/discussions/2346 + [most requested feature on our discussion board]: https://github.com/mkdocs-ng/mkdocs-material/discussions/2346 [various plugins and tools]: https://github.com/mkdocs/catalog?tab=readme-ov-file#-site-building-site-management As you may know, our initial effort involved the [projects plugin] that aims to extend MkDocs to add support for multi-project environments as a solid foundation to support multi-language sites and versioning. Unfortunately, we encountered significant challenges due to MkDocs' internal architecture and design constraints, which we're working actively on resolving.[^5] @@ -130,22 +130,22 @@ As you may know, our initial effort involved the [projects plugin] that aims to Implementing multi-project support in MkDocs is particularly challenging due to the lack of an official programmatic API, which complicates efforts to extend its functionality. Moreover, resolving navigation issues before building projects is crucial for ensuring proper interconnectivity. These challenges combined made the development of the projects plugin a complex endeavor. [projects plugin]: ../../plugins/projects.md - [good progress]: https://github.com/squidfunk/mkdocs-material/discussions/5800 + [good progress]: https://github.com/mkdocs-ng/mkdocs-material/discussions/5800 __:octicons-goal-16: Goal – Enable scaling documentation to any size or team structure by offering seamless methods for integrating multiple documentation projects, whether they involve different languages, versions, or distinct sections of an overall body of work.__ As a result, we are developing a new approach to offer a more comprehensive and robust solution for both multi-language support and versioning. This new approach also intersects with adjacent functionalities like search, as many of our users are interested in [federated search] capabilities that combine results from multiple documentation sites into a unified search interface. Overcoming this challenge is one of the major hurdles we need to address before releasing the new search system. - [federated search]: https://github.com/squidfunk/mkdocs-material/issues/5230 + [federated search]: https://github.com/mkdocs-ng/mkdocs-material/issues/5230 ### Editing and collaboration We had considered developing a live editor in response to MkDocs' [performance issues with large projects], which in most cases stem from compute-intensive plugins that don't employ caching. A [proof of concept] based on [Pyodide] (= running Python in the browser) [generated significant interest] among users and prompted many organizations and individuals to share their collaborative workflows for feedback. Sadly, implementing this live editor proved to be very challenging, as it would require rebuilding substantial parts of MkDocs.[^6] After discontinuing work on this approach, our progress with multi-project support has renewed our belief that we can finally solve the sluggish editing experience that was reported several times over the last years.[^7] [performance issues with large projects]: https://github.com/mkdocs/mkdocs/issues/3695#issuecomment-2093299518 - [proof of concept]: https://x.com/squidfunk/status/1338252230265360391 + [proof of concept]: https://x.com/mkdocs-ng/status/1338252230265360391 [Pyodide]: https://pyodide.org/ - [generated significant interest]: https://github.com/squidfunk/mkdocs-material/issues/2110 + [generated significant interest]: https://github.com/mkdocs-ng/mkdocs-material/issues/2110 [^6]: Our [proof of concept] supported some features of Material for MkDocs but didn't cover them all. For instance, integrating support for icons or linking between documents would have necessitated reimplementing parts of MkDocs to bypass a full rebuild — something we obviously wanted to avoid. Additionally, certain links, such as those to blog posts generated from schemas, are not merely translated but computed dynamically, which means they cannot be inferred by replacing the `.md` extension with `.html`. @@ -190,7 +190,7 @@ Almost a year ago, we introduced an [experimental chatbot] on our documentation __:octicons-goal-16: Goal – We're envisioning creating a unified interface that seamlessly integrates advanced search, chat, and summarization features, providing an interactive documentation experience.__ - [experimental chatbot]: https://github.com/squidfunk/mkdocs-material/discussions/6240 + [experimental chatbot]: https://github.com/mkdocs-ng/mkdocs-material/discussions/6240 As we delved into this ambitious project, we gained valuable insights from user feedback. Users began interacting with the chatbot in their native languages, an outcome we hadn't anticipated given that our documentation is in English. Remarkably (or obviously to those that work on LLMs year round), the chatbot responded in the same language. This ability of LLMs is one of the genuinely exciting features of these machine learning models as it has the potential to improve the accessibility of the documentation. However, while we employed state-of-the-art RAG methodologies, the results were mixed, and occasional hallucinations surfaced. @@ -202,7 +202,7 @@ While we navigate the challenges and explore the opportunities of this project, Thanks to the generous support from our sponsors, we're fortunate to be assembling a team capable of dedicating significant time and expertise to this endeavor. This newfound capacity allows us to delve deeper into core development while also engaging more comprehensively with our user community. A special mention goes to @kamilkrzyskow, one of our invaluable community experts, who has been essential in supporting users and fostering discussions on our platform. -With the team's support, @squidfunk can concentrate on the heart of development, while we have begun investing in user research. This effort is helping us understand how organizations and individuals interact with our tools, guiding the project's future direction based on real feedback from numerous conversations with users and companies. +With the team's support, @mkdocs-ng can concentrate on the heart of development, while we have begun investing in user research. This effort is helping us understand how organizations and individuals interact with our tools, guiding the project's future direction based on real feedback from numerous conversations with users and companies. Looking to expand our team further, we are committed to improving transparency and communication. Our previous work often happened behind the scenes due to time constraints, but we're now focused on making our processes more open and inviting for new contributors. By embracing this collaborative approach, we aim to enhance our tools and ensure they meet the evolving needs of our community. @@ -218,7 +218,7 @@ In the coming months, we'll be sharing more details about our plans and how they - Our [organic approach to growth] is part of this strategy as it keeps us independent of individual funding sources and pressures to provide a return on investment, which is what causes many other projects to turn away from the principles of Open Source. - [organic approach to growth]: https://star-history.com/#squidfunk/mkdocs-material + [organic approach to growth]: https://star-history.com/#mkdocs-ng/mkdocs-material - Likewise, we are driven by the needs of the community for a rich ecosystem of adaptations of the core framework. Extensibility and modularity are key for this and we are working hard to improve the developer experience by providing clear interfaces. diff --git a/docs/blog/posts/zensical.md b/docs/blog/posts/zensical.md index 961dd14cf1..a53f966bb2 100644 --- a/docs/blog/posts/zensical.md +++ b/docs/blog/posts/zensical.md @@ -1,7 +1,7 @@ --- date: 2025-11-05 authors: - - squidfunk + - mkdocs-ng - alexvoss - katharinalisalin - pawamoy @@ -71,7 +71,7 @@ Although we haven't reached full feature parity yet, you can already use Zensica _You can jump to the [compatibility] section to learn what is already supported._ - [update on our foundational work]: https://github.com/squidfunk/mkdocs-material/discussions/8461 + [update on our foundational work]: https://github.com/mkdocs-ng/mkdocs-material/discussions/8461 ## What you can expect diff --git a/docs/browser-support.md b/docs/browser-support.md index 7cf4f5af9f..c5b65df904 100644 --- a/docs/browser-support.md +++ b/docs/browser-support.md @@ -44,7 +44,7 @@ Note that the usage data is based on global browser market share, so it could in fact be entirely different for your target demographic. It's a good idea to check the distribution of browser types and versions among your users. - [open an issue]: https://github.com/squidfunk/mkdocs-material/issues/new/choose + [open an issue]: https://github.com/mkdocs-ng/mkdocs-material/issues/new/choose [caniuse.com]: https://caniuse.com/ [:is pseudo selector]: https://caniuse.com/css-matches-pseudo [browser support]: #supported-browsers diff --git a/docs/changelog/index.md b/docs/changelog/index.md index b6b5911385..5302eb2982 100644 --- a/docs/changelog/index.md +++ b/docs/changelog/index.md @@ -581,7 +581,7 @@ Merged Insiders features of 'Goat's Horn' funding goal - Fixed #6094: Blog post metadata overlaps with footer on small screens - Fixed #6069: Blog plugin crashes for categories with non-ASCII names -__Updated templates__ ([diff](https://github.com/squidfunk/mkdocs-material/compare/9.4.2...9.4.3)) +__Updated templates__ ([diff](https://github.com/mkdocs-ng/mkdocs-material/compare/9.4.2...9.4.3)) - `base.html` @@ -601,7 +601,7 @@ __Updated templates__ ([diff](https://github.com/squidfunk/mkdocs-material/compa - Fixed #5954: Repeated click on anchor ignored when using instant navigation - Fixed #5742: Keyboard navigation broken when using instant navigation -__Updated templates__ ([diff](https://github.com/squidfunk/mkdocs-material/compare/9.4.1...9.4.2)) +__Updated templates__ ([diff](https://github.com/mkdocs-ng/mkdocs-material/compare/9.4.1...9.4.2)) - `partials/nav-item.html` - `blog-post.html` @@ -1022,7 +1022,7 @@ __Fixes__ ### 8.5.11 November 30, 2022 { id="8.5.11" } -- Let it snow, see https://x.com/squidfunk/status/1597939243090788352 +- Let it snow, see https://x.com/mkdocs-ng/status/1597939243090788352 ### 8.5.10 November 11, 2022 { id="8.5.10" } diff --git a/docs/contributing/reporting-a-bug.md b/docs/contributing/reporting-a-bug.md index baa3ccf2b4..b103934b35 100644 --- a/docs/contributing/reporting-a-bug.md +++ b/docs/contributing/reporting-a-bug.md @@ -62,10 +62,10 @@ problems.__ [additional CSS]: ../customization.md#additional-css [JavaScript]: ../customization.md#additional-javascript [theme extension]: ../customization.md#extending-the-theme - [theme.custom_dir]: https://www.mkdocs.org/user-guide/configuration/#custom_dir - [hooks]: https://www.mkdocs.org/user-guide/configuration/#hooks - [extra_css]: https://www.mkdocs.org/user-guide/configuration/#extra_css - [extra_javascript]: https://www.mkdocs.org/user-guide/configuration/#extra_javascript + [theme.custom_dir]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#custom_dir + [hooks]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#hooks + [extra_css]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#extra_css + [extra_javascript]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#extra_javascript [discussion board]: https://github.com/mkdocs-ng/mkdocs-material/discussions [StackOverflow]: https://stackoverflow.com [that our documentation explicitly mentions]: ?q="extends+base" @@ -203,10 +203,10 @@ we maintainers can fix the bug in our code base. > need a clear description of it and quantify its impact, which is essential > for triage and prioritization. - [MkDocs]: https://www.mkdocs.org + [MkDocs]: https://mkdocs-ng.github.io/mkdocs [Python Markdown]: https://python-markdown.github.io/extensions/ [Python Markdown Extensions]: https://facelessuser.github.io/pymdown-extensions/ - [theme.name]: https://www.mkdocs.org/user-guide/configuration/#theme + [theme.name]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#theme ### Related links diff --git a/docs/contributing/requesting-a-change.md b/docs/contributing/requesting-a-change.md index f5f31445fb..b48e3db401 100644 --- a/docs/contributing/requesting-a-change.md +++ b/docs/contributing/requesting-a-change.md @@ -228,7 +228,7 @@ To maintain clarity and ensure that our roadmap remains focused and achievable, we've introduced a structured process and use a dedicated [backlog] to track and organize change requests, and how they fit into our roadmap. - [backlog]: https://github.com/users/squidfunk/projects/4/views/1 + [backlog]: https://github.com/users/mkdocs-ng/projects/4/views/1 Here’s how we handle new change requests: diff --git a/docs/creating-your-site.md b/docs/creating-your-site.md index 6d582c251e..5a6dcb2e6c 100644 --- a/docs/creating-your-site.md +++ b/docs/creating-your-site.md @@ -103,7 +103,7 @@ plugins require the `site_url` to be set, so you should always do this. If you already have a schema defined, or wish to self-host your schema to reduce duplication, you can add it via [$ref]. - [configuration validation and auto-complete]: https://x.com/squidfunk/status/1487746003692400642 + [configuration validation and auto-complete]: https://x.com/mkdocs-ng/status/1487746003692400642 [schema.json]: schema.json [vscode-yaml]: https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml [settings.json]: https://code.visualstudio.com/docs/getstarted/settings @@ -226,7 +226,7 @@ Point your browser to [localhost:8000][live preview] and you should see: [![Creating your site]][Creating your site] - [--dirtyreload]: https://www.mkdocs.org/about/release-notes/#support-for-dirty-builds-990 + [--dirtyreload]: https://mkdocs-ng.github.io/mkdocs/about/release-notes/#support-for-dirty-builds-990 [live preview]: http://localhost:8000 [Creating your site]: assets/screenshots/creating-your-site.png diff --git a/docs/customization.md b/docs/customization.md index 987881554a..7f72d3ba37 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -11,7 +11,7 @@ necessary to preserve your brand's style. small tweaks to Material for MkDocs, you can just add CSS and JavaScript files to the `docs` directory. - [MkDocs]: https://www.mkdocs.org + [MkDocs]: https://mkdocs-ng.github.io/mkdocs ### Additional CSS @@ -84,7 +84,7 @@ extend the theme. MkDocs supports [theme extension], an easy way to override parts of Material for MkDocs without forking from git. This ensures that you can update to the latest version more easily. - [theme extension]: https://www.mkdocs.org/user-guide/customizing-your-theme/#using-the-theme-custom_dir + [theme extension]: https://mkdocs-ng.github.io/mkdocs/user-guide/customizing-your-theme/#using-the-theme-custom_dir ### Setup and theme structure @@ -159,8 +159,8 @@ assets may also be put in the `overrides` directory: └─ main.html # Default page ``` - [custom_dir]: https://www.mkdocs.org/user-guide/configuration/#custom_dir - [name]: https://www.mkdocs.org/user-guide/configuration/#name + [custom_dir]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#custom_dir + [name]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#name ### Overriding partials diff --git a/docs/insiders/getting-started.md b/docs/insiders/getting-started.md index 97dfaa2144..003c84b61b 100644 --- a/docs/insiders/getting-started.md +++ b/docs/insiders/getting-started.md @@ -50,16 +50,16 @@ Make sure you have the `GH_TOKEN` variable set as instructed above. end of the URL with the one you want. ``` sh - pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git@9.4.2-insiders-4.42.0 + pip install git+https://${GH_TOKEN}@github.com/mkdocs-ng/mkdocs-material-insiders.git@9.4.2-insiders-4.42.0 ``` === "Latest" ``` sh - pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git + pip install git+https://${GH_TOKEN}@github.com/mkdocs-ng/mkdocs-material-insiders.git ``` -[list of tags]: https://github.com/squidfunk/mkdocs-material-insiders/tags +[list of tags]: https://github.com/mkdocs-ng/mkdocs-material-insiders/tags ### with docker @@ -119,7 +119,7 @@ outlined in the [Getting Started guide](../getting-started.md#with-docker). Of course, you can use Material for MkDocs Insiders directly from `git`: ``` -git clone git@github.com:squidfunk/mkdocs-material-insiders.git mkdocs-material +git clone git@github.com:mkdocs-ng/mkdocs-material-insiders.git mkdocs-material ``` The theme will reside in the folder `mkdocs-material/material`. When cloning @@ -131,13 +131,13 @@ pip install -e mkdocs-material ``` [GitHub Container Registry]: https://docs.github.com/en/packages/guides/about-github-container-registry - [Fork the Insiders repository]: https://github.com/squidfunk/mkdocs-material-insiders/fork + [Fork the Insiders repository]: https://github.com/mkdocs-ng/mkdocs-material-insiders/fork [GitHub Actions]: https://docs.github.com/en/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository [packages scope]: https://docs.github.com/en/developers/apps/scopes-for-oauth-apps#available-scopes [GitHub Actions secret]: https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository [Create a new release]: https://docs.github.com/en/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release [Pull App]: https://github.com/apps/pull - [build]: https://github.com/squidfunk/mkdocs-material-insiders/blob/master/.github/workflows/build.yml + [build]: https://github.com/mkdocs-ng/mkdocs-material-insiders/blob/master/.github/workflows/build.yml ## Built-in plugins @@ -173,4 +173,4 @@ CI=true INSIDERS=true mkdocs build ``` [built-in group plugin]: ../plugins/group.md - [configuration inheritance]: https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance + [configuration inheritance]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#configuration-inheritance diff --git a/docs/insiders/upgrade.md b/docs/insiders/upgrade.md index ec86ad9701..48371e3514 100644 --- a/docs/insiders/upgrade.md +++ b/docs/insiders/upgrade.md @@ -13,7 +13,7 @@ guide] and go through the steps to ensure your configuration is up to date and all necessary changes have been made. [upgrade guide]: ../upgrade.md - [list of tags]: https://github.com/squidfunk/mkdocs-material-insiders/tags + [list of tags]: https://github.com/mkdocs-ng/mkdocs-material-insiders/tags Depending on how you installed and what you want to upgrade to you need to run different commands: @@ -25,7 +25,7 @@ need to run different commands: the tag at the end of the URL of the command given below: ``` - pip install --upgrade git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git@9.4.2-insiders-4.42.0 + pip install --upgrade git+https://${GH_TOKEN}@github.com/mkdocs-ng/mkdocs-material-insiders.git@9.4.2-insiders-4.42.0 ``` === "pip upgrade to latest development" @@ -34,7 +34,7 @@ need to run different commands: latest development version, run: ``` - pip install --upgrade --force-reinstall git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git + pip install --upgrade --force-reinstall git+https://${GH_TOKEN}@github.com/mkdocs-ng/mkdocs-material-insiders.git ``` The `--force-reinstall` option serves to make sure `pip` does, in fact, diff --git a/docs/plugins/blog.md b/docs/plugins/blog.md index fff5cd6cc7..7cd0fd3b66 100644 --- a/docs/plugins/blog.md +++ b/docs/plugins/blog.md @@ -1085,12 +1085,12 @@ The provided path is resolved from the [`docs` directory][mkdocs.docs_dir]. ``` Note that `` must be set to an identifier for associating authors - with posts, e.g., a GitHub username like `squidfunk`. This identifier can + with posts, e.g., a GitHub username like `mkdocs-ng`. This identifier can then be used in the [`authors`][meta.authors] metadata property of a post. Multiple authors are supported. As an example, see [the `.authors.yml` file][.authors.yml] we're using for our blog. - [.authors.yml]: https://github.com/squidfunk/mkdocs-material/blob/main/docs/blog/.authors.yml + [.authors.yml]: https://github.com/mkdocs-ng/mkdocs-material/blob/main/docs/blog/.authors.yml --- @@ -1457,7 +1457,7 @@ author can't be resolved, the plugin will terminate with an error: ``` yaml --- authors: - - squidfunk # (1)! + - mkdocs-ng # (1)! --- # Post title @@ -1718,6 +1718,6 @@ Slugs are passed to [`post_url_format`][config.post_url_format]. ask a question, or create a [change request] on our [issue tracker], so we can find out if it might be a good fit for the plugin. - [open a discussion]: https://github.com/squidfunk/mkdocs-material/discussions + [open a discussion]: https://github.com/mkdocs-ng/mkdocs-material/discussions [change request]: ../contributing/requesting-a-change.md - [issue tracker]: https://github.com/squidfunk/mkdocs-material/issues + [issue tracker]: https://github.com/mkdocs-ng/mkdocs-material/issues diff --git a/docs/plugins/index.md b/docs/plugins/index.md index 8bf6a8a045..99809e2a75 100644 --- a/docs/plugins/index.md +++ b/docs/plugins/index.md @@ -26,7 +26,7 @@ developing built-in plugins, we always adhere to the following design principles builds. This is particularly important for large documentation projects with thousands of pages. - [mkdocs]: https://www.mkdocs.org/ + [mkdocs]: https://mkdocs-ng.github.io/mkdocs/ [design principles]: ../design-principles.md [offline-capable documentation]: ../setup/building-for-offline-usage.md diff --git a/docs/plugins/info.md b/docs/plugins/info.md index b422daa712..ac6a51ab65 100644 --- a/docs/plugins/info.md +++ b/docs/plugins/info.md @@ -152,4 +152,4 @@ unsure, please ask us first by [creating a discussion]. [requirements]: #how-it-works [explicitly mentioned in our documentation]: ?q=%22extends+base%22 - [creating a discussion]: https://github.com/squidfunk/mkdocs-material/discussions + [creating a discussion]: https://github.com/mkdocs-ng/mkdocs-material/discussions diff --git a/docs/plugins/meta.md b/docs/plugins/meta.md index 4ef92ffde5..003ec1ce0f 100644 --- a/docs/plugins/meta.md +++ b/docs/plugins/meta.md @@ -78,7 +78,7 @@ of the meta plugin and other built-in plugins are: ``` yaml title=".meta.yml" authors: - - squidfunk + - mkdocs-ng ``` - :material-tag-text:   __[Built-in tags plugin][tags]__ diff --git a/docs/plugins/offline.md b/docs/plugins/offline.md index 243954d4c1..9104e94f6c 100644 --- a/docs/plugins/offline.md +++ b/docs/plugins/offline.md @@ -33,7 +33,7 @@ Cross origin requests are only supported for protocol schemes: http, [...] While browsers impose those restriction for security reasons, it reduces the interactivity of your project. The offline plugin makes sure that site search keeps working by moving the search index to a JavaScript file, and leveraging -@squidfunk's [iframe-worker] shim. +@mkdocs-ng's [iframe-worker] shim. Additionally, the plugin automatically disables the [`use_directory_urls`] [mkdocs.use_directory_urls] setting, ensuring that users can open your @@ -43,7 +43,7 @@ There are some [limitations]. [building your project]: ../creating-your-site.md#building-your-site [Fetch API]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API - [iframe-worker]: https://github.com/squidfunk/iframe-worker + [iframe-worker]: https://github.com/mkdocs-ng/iframe-worker [limitations]: #limitations ### When to use it diff --git a/docs/plugins/projects.md b/docs/plugins/projects.md index 5a36247c11..4515caa88d 100644 --- a/docs/plugins/projects.md +++ b/docs/plugins/projects.md @@ -22,7 +22,7 @@ be used to split very large projects into smaller parts. __If you're considering the projects plugin, please be aware that known issues will not be fixed.__ - [Material for MkDocs is in maintenance mode]: https://github.com/squidfunk/mkdocs-material/issues/8523 + [Material for MkDocs is in maintenance mode]: https://github.com/mkdocs-ng/mkdocs-material/issues/8523 [Zensical]: ../blog/posts/zensical.md [Insiders]: ../insiders/index.md diff --git a/docs/plugins/requirements/image-processing.md b/docs/plugins/requirements/image-processing.md index 27d438504b..eb0139a605 100644 --- a/docs/plugins/requirements/image-processing.md +++ b/docs/plugins/requirements/image-processing.md @@ -98,7 +98,7 @@ The following environments come with a preinstalled version of [Cairo Graphics]: [installation guide]: https://www.cairographics.org/download/ [MSYS2]: https://www.msys2.org/ [UCRT64]: https://www.msys2.org/docs/environments/ - [Docker image]: https://hub.docker.com/r/squidfunk/mkdocs-material/ + [Docker image]: https://hub.docker.com/r/mkdocs-ng/mkdocs-material/ [GitHub Actions]: ../../publishing-your-site.md#with-github-actions ### pngquant @@ -193,7 +193,7 @@ process is different: View source code of [cairo-lookup-macos.py] ```bash title="Python Debug macOS Script" - curl "https://raw.githubusercontent.com/squidfunk/mkdocs-material/main/includes/debug/cairo-lookup-macos.py" | python - + curl "https://raw.githubusercontent.com/mkdocs-ng/mkdocs-material/main/includes/debug/cairo-lookup-macos.py" | python - ``` === ":fontawesome-brands-windows: Windows" @@ -225,7 +225,7 @@ process is different: View source code of [cairo-lookup-windows.py] ```powershell title="PowerShell - Python Debug Windows Script" - (Invoke-WebRequest "https://raw.githubusercontent.com/squidfunk/mkdocs-material/main/includes/debug/cairo-lookup-windows.py").Content | python - + (Invoke-WebRequest "https://raw.githubusercontent.com/mkdocs-ng/mkdocs-material/main/includes/debug/cairo-lookup-windows.py").Content | python - ``` === ":material-linux: Linux" @@ -253,7 +253,7 @@ process is different: View source code of [cairo-lookup-linux.py] ```bash title="Python Debug Linux Script" - curl "https://raw.githubusercontent.com/squidfunk/mkdocs-material/main/includes/debug/cairo-lookup-linux.py" | python - + curl "https://raw.githubusercontent.com/mkdocs-ng/mkdocs-material/main/includes/debug/cairo-lookup-linux.py" | python - ``` [PyPi CairoSVG]: https://pypi.org/project/CairoSVG @@ -262,11 +262,11 @@ process is different: [ubuntu-ldconfig]: https://manpages.ubuntu.com/manpages/focal/en/man8/ldconfig.8.html [ubuntu-ld]: https://manpages.ubuntu.com/manpages/xenial/man1/ld.1.html [ubuntu-gcc]: https://manpages.ubuntu.com/manpages/trusty/man1/gcc.1.html - [cffi-issue]: https://github.com/squidfunk/mkdocs-material/issues/5121 + [cffi-issue]: https://github.com/mkdocs-ng/mkdocs-material/issues/5121 [cffi-dopen]: https://github.com/Kozea/cairocffi/blob/f1984d644bbc462ef0ec33b97782cf05733d7b53/cairocffi/__init__.py#L24-L49 [find-library-macOS]: https://github.com/python/cpython/blob/4d58a1d8fb27048c11bcbda3da1bebf78f979335/Lib/ctypes/util.py#L70-L81 [find-library-Windows]: https://github.com/python/cpython/blob/4d58a1d8fb27048c11bcbda3da1bebf78f979335/Lib/ctypes/util.py#L59-L67 [find-library-Linux]: https://github.com/python/cpython/blob/4d58a1d8fb27048c11bcbda3da1bebf78f979335/Lib/ctypes/util.py#L92 - [cairo-lookup-macos.py]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/main/includes/debug/cairo-lookup-macos.py - [cairo-lookup-windows.py]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/main/includes/debug/cairo-lookup-windows.py - [cairo-lookup-linux.py]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/main/includes/debug/cairo-lookup-linux.py + [cairo-lookup-macos.py]: https://raw.githubusercontent.com/mkdocs-ng/mkdocs-material/main/includes/debug/cairo-lookup-macos.py + [cairo-lookup-windows.py]: https://raw.githubusercontent.com/mkdocs-ng/mkdocs-material/main/includes/debug/cairo-lookup-windows.py + [cairo-lookup-linux.py]: https://raw.githubusercontent.com/mkdocs-ng/mkdocs-material/main/includes/debug/cairo-lookup-linux.py diff --git a/docs/plugins/social.md b/docs/plugins/social.md index 36377f20f5..68e7c4366f 100644 --- a/docs/plugins/social.md +++ b/docs/plugins/social.md @@ -1058,6 +1058,6 @@ plugins: on our [issue tracker], so we can find out if it might be a good fit for the plugin. - [open a discussion]: https://github.com/squidfunk/mkdocs-material/discussions + [open a discussion]: https://github.com/mkdocs-ng/mkdocs-material/discussions [change request]: ../contributing/requesting-a-change.md - [issue tracker]: https://github.com/squidfunk/mkdocs-material/issues + [issue tracker]: https://github.com/mkdocs-ng/mkdocs-material/issues diff --git a/docs/plugins/typeset.md b/docs/plugins/typeset.md index dcde297134..3d1b7eb933 100644 --- a/docs/plugins/typeset.md +++ b/docs/plugins/typeset.md @@ -22,7 +22,7 @@ as defined in the page's content. __If you're considering the typeset plugin, please be aware that known issues will not be fixed.__ - [Material for MkDocs is in maintenance mode]: https://github.com/squidfunk/mkdocs-material/issues/8523 + [Material for MkDocs is in maintenance mode]: https://github.com/mkdocs-ng/mkdocs-material/issues/8523 [Zensical]: ../blog/posts/zensical.md [Insiders]: ../insiders/index.md diff --git a/docs/publishing-your-site.md b/docs/publishing-your-site.md index cf690c50f4..d6f55f2965 100644 --- a/docs/publishing-your-site.md +++ b/docs/publishing-your-site.md @@ -98,7 +98,7 @@ To publish your site on a custom domain, please refer to the [MkDocs documentati [publishing source branch]: https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site [manual page]: https://man7.org/linux/man-pages/man1/date.1.html [caching]: plugins/requirements/caching.md - [MkDocs documentation]: https://www.mkdocs.org/user-guide/deploying-your-docs/#custom-domains + [MkDocs documentation]: https://mkdocs-ng.github.io/mkdocs/user-guide/deploying-your-docs/#custom-domains ### with MkDocs @@ -114,8 +114,8 @@ This will build your documentation and deploy it to a branch documentation] for more information. For a description of the arguments, see [the documentation for the command]. - [this overview in the MkDocs documentation]: https://www.mkdocs.org/user-guide/deploying-your-docs/#project-pages - [the documentation for the command]: https://www.mkdocs.org/user-guide/cli/#mkdocs-gh-deploy + [this overview in the MkDocs documentation]: https://mkdocs-ng.github.io/mkdocs/user-guide/deploying-your-docs/#project-pages + [the documentation for the command]: https://mkdocs-ng.github.io/mkdocs/user-guide/cli/#mkdocs-gh-deploy ## GitLab Pages diff --git a/docs/reference/admonitions.md b/docs/reference/admonitions.md index 94aa2193df..bb298f2068 100644 --- a/docs/reference/admonitions.md +++ b/docs/reference/admonitions.md @@ -535,5 +535,5 @@ After applying the customization, you can use the custom admonition type: - [custom icons]: https://github.com/squidfunk/mkdocs-material/tree/main/material/templates/.icons + [custom icons]: https://github.com/mkdocs-ng/mkdocs-material/tree/main/material/templates/.icons [additional style sheet]: ../customization.md#additional-css diff --git a/docs/reference/code-blocks.md b/docs/reference/code-blocks.md index 40b15f60c5..bd60e2d5f1 100644 --- a/docs/reference/code-blocks.md +++ b/docs/reference/code-blocks.md @@ -197,7 +197,7 @@ Now, code annotations can be used from within strings in JSON: text__, images, ... basically anything that can be written in Markdown. [placed in comments]: #adding-annotations - [s2]: https://github.com/squidfunk/mkdocs-material/blob/87d5ca487b9d9ab95c41ee72813149d214048693/src/assets/stylesheets/main/extensions/pymdownx/_highlight.scss#L45 + [s2]: https://github.com/mkdocs-ng/mkdocs-material/blob/87d5ca487b9d9ab95c41ee72813149d214048693/src/assets/stylesheets/main/extensions/pymdownx/_highlight.scss#L45 ## Usage @@ -506,11 +506,11 @@ override it as part of your [additional style sheet]: - stylesheets/extra.css ``` - [colors]: https://github.com/squidfunk/mkdocs-material/blob/main/src/templates/assets/stylesheets/main/_colors.scss + [colors]: https://github.com/mkdocs-ng/mkdocs-material/blob/main/src/templates/assets/stylesheets/main/_colors.scss [color schemes]: ../setup/changing-the-colors.md#color-scheme [types of string tokens]: https://pygments.org/docs/tokens/#literals [additional style sheet]: ../customization.md#additional-css - [syntax theme definition]: https://github.com/squidfunk/mkdocs-material/blob/main/src/templates/assets/stylesheets/main/extensions/pymdownx/_highlight.scss + [syntax theme definition]: https://github.com/mkdocs-ng/mkdocs-material/blob/main/src/templates/assets/stylesheets/main/extensions/pymdownx/_highlight.scss ### Annotation tooltip width diff --git a/docs/reference/grids.md b/docs/reference/grids.md index 10af8d55b3..b3ea2be599 100644 --- a/docs/reference/grids.md +++ b/docs/reference/grids.md @@ -176,7 +176,7 @@ when [hiding both sidebars]. [reference]: ../reference/index.md [customization]: ../customization.md [license]: ../license.md - [GitHub]: https://github.com/squidfunk/mkdocs-material + [GitHub]: https://github.com/mkdocs-ng/mkdocs-material [hiding both sidebars]: ../setup/setting-up-navigation.md#hiding-the-sidebars #### Block syntax diff --git a/docs/reference/icons-emojis.md b/docs/reference/icons-emojis.md index cf704ca9af..9221a577e4 100644 --- a/docs/reference/icons-emojis.md +++ b/docs/reference/icons-emojis.md @@ -110,7 +110,7 @@ a valid path to any icon bundled with the theme, which are located in the - [custom icons]: https://github.com/squidfunk/mkdocs-material/tree/main/material/templates/.icons + [custom icons]: https://github.com/mkdocs-ng/mkdocs-material/tree/main/material/templates/.icons #### with colors diff --git a/docs/reference/index.md b/docs/reference/index.md index a278dab8d4..7128f6165c 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -31,10 +31,10 @@ title: Lorem ipsum dolor sit amet # (1)! dash. [social cards]: ../setup/setting-up-social-cards.md - [four step process]: https://www.mkdocs.org/user-guide/writing-your-docs/#meta-data + [four step process]: https://mkdocs-ng.github.io/mkdocs/user-guide/writing-your-docs/#meta-data [title]: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/title [head]: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/head - [site_name]: https://www.mkdocs.org/user-guide/configuration/#site_name + [site_name]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#site_name ### Setting the page `description` @@ -55,7 +55,7 @@ description: Nullam urna elit, malesuada eget finibus ut, ac tortor. # (1)! 1. This line sets the `meta` tag containing the description inside the document `head` for the current page to the provided value. - [site_description]: https://www.mkdocs.org/user-guide/configuration/#site_description + [site_description]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#site_description ### Setting the page `icon` diff --git a/docs/schema.json b/docs/schema.json index 24bef893ed..6bd2338bc6 100644 --- a/docs/schema.json +++ b/docs/schema.json @@ -6,79 +6,79 @@ "properties": { "INHERIT": { "title": "Inherit from configuration", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#configuration-inheritance", "pattern": "\\.yml$" }, "site_name": { "title": "Site name, used in header, title and drawer", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#site_name", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#site_name", "type": "string" }, "site_url": { "title": "Site URL", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#site_url", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#site_url", "type": "string" }, "site_author": { "title": "Site author, used in document head", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#site_author", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#site_author", "type": "string" }, "site_description": { "title": "Site description, used in document head and in social cards", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#site_description", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#site_description", "type": "string" }, "repo_name": { "title": "Repository name, used in header", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#repository-name", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/adding-a-git-repository/#repository-name", "type": "string" }, "repo_url": { "title": "Repository URL", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#repository", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/adding-a-git-repository/#repository", "type": "string" }, "edit_uri": { "title": "Path from repository root to directory containing Markdown", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#edit_uri", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#edit_uri", "type": "string" }, "edit_uri_template": { "title": "More flexible variant of edit_uri", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#edit_uri_template", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#edit_uri_template", "type": "string" }, "copyright": { "title": "Copyright, used in footer", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#copyright-notice", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-the-footer/#copyright-notice", "type": "string" }, "docs_dir": { "title": "Directory containing the Markdown sources", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#docs_dir", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#docs_dir", "type": "string", "default": "docs" }, "site_dir": { "title": "Directory containing the HTML output", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#site_dir", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#site_dir", "type": "string", "default": "site" }, "use_directory_urls": { "title": "Pages are located in their own directories", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#use_directory_urls", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#use_directory_urls", "type": "boolean", "default": false }, "extra_templates": { "title": "Additional HTML files to include", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#extra_templates", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#extra_templates", "type": "array", "items": { "title": "Path to HTML file", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#extra_templates", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#extra_templates", "pattern": "\\.html$" }, "uniqueItems": true, @@ -86,11 +86,11 @@ }, "extra_css": { "title": "Additional CSS files to include", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/customization/#additional-css", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/customization/#additional-css", "type": "array", "items": { "title": "Path to CSS file", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/customization/#additional-css", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/customization/#additional-css", "pattern": "\\.css($|\\?)" }, "uniqueItems": true, @@ -98,22 +98,22 @@ }, "extra_javascript": { "title": "Additional JavaScript files to include", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/customization/#additional-javascript", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/customization/#additional-javascript", "type": "array", "items": { "title": "Path to JavaScript file (may be local or absolute URL to external JS)", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/customization/#additional-javascript" + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/customization/#additional-javascript" }, "uniqueItems": true, "minItems": 1 }, "hooks": { "title": "Hooks", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#hooks", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#hooks", "type": "array", "items": { "title": "Path to Python file", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#hooks", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#hooks", "pattern": "\\.py$" }, "uniqueItems": true, @@ -121,25 +121,25 @@ }, "strict": { "title": "Strict mode", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#strict", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#strict", "type": "boolean", "default": false }, "dev_addr": { "title": "Development IP Address", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#dev_addr", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#dev_addr", "type": "string", "default": "127.0.0.1:8000" }, "remote_branch": { "title": "Remote branch to deploy to", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#remote_branch", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#remote_branch", "type": "string", "default": "gh-pages" }, "remote_name": { "title": "Remote origin to deploy to", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#remote_name", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#remote_name", "type": "string", "default": "origin" }, @@ -163,17 +163,17 @@ }, "exclude_docs": { "title": "Pattern to declare files to exclude from build", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#exclude_docs", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#exclude_docs", "type": "string" }, "draft_docs": { "title": "Pattern to declare draft documents", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#draft_docs", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#draft_docs", "type": "string" }, "not_in_nav": { "title": "Pattern to declare pages that do not appear in the navigation", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#not_in_nav", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#not_in_nav", "type": "string" }, "watch": { diff --git a/docs/schema/assets/icons.json b/docs/schema/assets/icons.json index c3050f9fce..5263e6349b 100644 --- a/docs/schema/assets/icons.json +++ b/docs/schema/assets/icons.json @@ -1,7 +1,7 @@ { "$schema": "https://json-schema.org/draft-07/schema", "title": "Icon", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/#search", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/reference/icons-emojis/#search", "type": "string", "enum": [ "fontawesome/brands/11ty", diff --git a/docs/schema/extensions.json b/docs/schema/extensions.json index 6d9c727867..d1806ae9a7 100644 --- a/docs/schema/extensions.json +++ b/docs/schema/extensions.json @@ -1,7 +1,7 @@ { "$schema": "https://json-schema.org/draft-07/schema", "title": "Markdown extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/", "type": "array", "items": { "anyOf": [ diff --git a/docs/schema/extensions/markdown.json b/docs/schema/extensions/markdown.json index 879fee7727..5ed7175cc8 100644 --- a/docs/schema/extensions/markdown.json +++ b/docs/schema/extensions/markdown.json @@ -1,11 +1,11 @@ { "$schema": "https://json-schema.org/draft-07/schema", "title": "Markdown extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown/", "oneOf": [ { "title": "Abbreviations – Python Markdown", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#abbreviations", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown/#abbreviations", "enum": [ "markdown.extensions.abbr", "abbr" @@ -13,7 +13,7 @@ }, { "title": "Admonition – Python Markdown", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#admonition", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown/#admonition", "enum": [ "markdown.extensions.admonition", "admonition" @@ -21,7 +21,7 @@ }, { "title": "Attribute Lists – Python Markdown", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#attribute-lists", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown/#attribute-lists", "enum": [ "markdown.extensions.attr_list", "attr_list" @@ -38,7 +38,7 @@ }, { "title": "Definition Lists – Python Markdown", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#definition-lists", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown/#definition-lists", "enum": [ "markdown.extensions.def_list", "def_list" @@ -46,7 +46,7 @@ }, { "title": "Footnotes – Python Markdown", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#footnotes", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown/#footnotes", "enum": [ "markdown.extensions.footnotes", "footnotes" @@ -54,7 +54,7 @@ }, { "title": "Markdown in HTML – Python Markdown", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#markdown-in-html", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown/#markdown-in-html", "enum": [ "markdown.extensions.md_in_html", "md_in_html" @@ -70,7 +70,7 @@ }, { "title": "Tables – Python Markdown", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#tables", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown/#tables", "enum": [ "markdown.extensions.tables", "tables" @@ -92,7 +92,7 @@ }, { "title": "Table Of Contents – Python Markdown", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#table-of-contents", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown/#table-of-contents", "enum": [ "markdown.extensions.toc", "toc" @@ -104,21 +104,21 @@ "$defs": { "toc": { "title": "Table Of Contents – Python Markdown", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#table-of-contents", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown/#table-of-contents", "type": "object", "properties": { "title": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#+toc.title", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown/#+toc.title", "type": "string" }, "permalink": { "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#+toc.permalink", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown/#+toc.permalink", "type": "boolean" }, { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#+toc.permalink", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown/#+toc.permalink", "type": "string" } ], @@ -130,15 +130,15 @@ "default": false }, "permalink_title": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#+toc.permalink_title", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown/#+toc.permalink_title", "type": "string" }, "slugify": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#+toc.slugify", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown/#+toc.slugify", "default": "!!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}" }, "toc_depth": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#+toc.toc_depth", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown/#+toc.toc_depth", "type": "number", "enum": [ 0, diff --git a/docs/schema/extensions/pymdownx.json b/docs/schema/extensions/pymdownx.json index 137bb304f4..fd785a6a0c 100644 --- a/docs/schema/extensions/pymdownx.json +++ b/docs/schema/extensions/pymdownx.json @@ -1,7 +1,7 @@ { "$schema": "https://json-schema.org/draft-07/schema", "title": "Markdown extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/", "oneOf": [ { "oneOf": [ @@ -10,7 +10,7 @@ "properties": { "pymdownx.arithmatex": { "title": "Arithmatex – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#arithmatex", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#arithmatex", "type": "object", "properties": { "generic": { @@ -26,7 +26,7 @@ }, { "title": "Arithmatex – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#arithmatex", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#arithmatex", "const": "pymdownx.arithmatex" } ] @@ -38,7 +38,7 @@ "properties": { "pymdownx.betterem": { "title": "BetterEm – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#betterem", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#betterem", "type": "object", "properties": { "smart_enable": { @@ -60,7 +60,7 @@ }, { "title": "BetterEm – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#betterem", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#betterem", "const": "pymdownx.betterem" } ] @@ -72,7 +72,7 @@ "properties": { "pymdownx.blocks.caption": { "title": "Caption – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caption", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caption", "type": "object", "properties": { "types": { @@ -127,7 +127,7 @@ }, { "title": "Caption – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caption", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caption", "const": "pymdownx.blocks.caption" } ] @@ -136,7 +136,7 @@ "oneOf": [ { "title": "Caret – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caret-mark-tilde", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caret-mark-tilde", "const": "pymdownx.caret" }, { @@ -144,7 +144,7 @@ "properties": { "pymdownx.caret": { "title": "Caret – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caret-mark-tilde", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caret-mark-tilde", "type": "object", "properties": { "smart_insert": { @@ -174,7 +174,7 @@ "oneOf": [ { "title": "Critic – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#critic", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#critic", "const": "pymdownx.critic" }, { @@ -182,11 +182,11 @@ "properties": { "pymdownx.critic": { "title": "Critic – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#critic", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#critic", "type": "object", "properties": { "mode": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.critic.mode", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.critic.mode", "enum": [ "view", "accept", @@ -203,14 +203,14 @@ }, { "title": "Details – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#details", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#details", "const": "pymdownx.details" }, { "oneOf": [ { "title": "Emoji – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#emoji", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#emoji", "const": "pymdownx.emoji" }, { @@ -218,26 +218,26 @@ "properties": { "pymdownx.emoji": { "title": "Emoji – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#emoji", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#emoji", "type": "object", "properties": { "emoji_generator": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.emoji_generator", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.emoji_generator", "default": "!!python/name:material.extensions.emoji.to_svg" }, "emoji_index": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.emoji_index", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.emoji_index", "default": "!!python/name:material.extensions.emoji.twemoji" }, "options": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.options.custom_icons", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.options.custom_icons", "type": "object", "properties": { "custom_icons": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.options.custom_icons", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.options.custom_icons", "type": "array", "items": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.options.custom_icons", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.emoji.options.custom_icons", "type": "string" }, "uniqueItems": true, @@ -262,7 +262,7 @@ "oneOf": [ { "title": "Highlight – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#highlight", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#highlight", "const": "pymdownx.highlight" }, { @@ -270,19 +270,19 @@ "properties": { "pymdownx.highlight": { "title": "Highlight – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#highlight", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#highlight", "type": "object", "properties": { "use_pygments": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.use_pygments", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.use_pygments", "type": "boolean" }, "pygments_lang_class": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.pygments_lang_class", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.pygments_lang_class", "type": "boolean" }, "auto_title": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.auto_title", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.auto_title", "type": "boolean" }, "auto_title_map": { @@ -290,11 +290,11 @@ "type": "object" }, "linenums": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.linenums", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.linenums", "type": "boolean" }, "linenums_style": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.linenums_style", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.linenums_style", "enum": [ "inline", "pymdownx-inline", @@ -302,11 +302,11 @@ ] }, "anchor_linenums": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.anchor_linenums", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.anchor_linenums", "type": "boolean" }, "line_spans": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.line_spans", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.line_spans", "type": "string" } }, @@ -319,14 +319,14 @@ }, { "title": "InlineHilite – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#inlinehilite", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#inlinehilite", "const": "pymdownx.inlinehilite" }, { "oneOf": [ { "title": "Keys – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#keys", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#keys", "const": "pymdownx.keys" }, { @@ -334,7 +334,7 @@ "properties": { "pymdownx.keys": { "title": "Keys – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#keys", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#keys", "type": "object", "properties": { "separator": { @@ -456,7 +456,7 @@ "oneOf": [ { "title": "Mark – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caret-mark-tilde", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caret-mark-tilde", "const": "pymdownx.mark" }, { @@ -464,7 +464,7 @@ "properties": { "pymdownx.mark": { "title": "Mark – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caret-mark-tilde", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caret-mark-tilde", "type": "object", "properties": { "smart_mark": { @@ -484,7 +484,7 @@ "oneOf": [ { "title": "SmartSymbols – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#smartsymbols", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#smartsymbols", "const": "pymdownx.smartsymbols" }, { @@ -492,7 +492,7 @@ "properties": { "pymdownx.smartsymbols": { "title": "SmartSymbols – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#smartsymbols", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#smartsymbols", "type": "object", "properties": { "trademark": { @@ -555,7 +555,7 @@ "properties": { "pymdownx.snippets": { "title": "Snippets – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#snippets", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#snippets", "type": "object", "properties": { "base_path": { @@ -611,7 +611,7 @@ }, { "title": "Snippets – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#snippets", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#snippets", "const": "pymdownx.snippets" } ] @@ -620,7 +620,7 @@ "oneOf": [ { "title": "SuperFences – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#superfences", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#superfences", "const": "pymdownx.superfences" }, { @@ -628,14 +628,14 @@ "properties": { "pymdownx.superfences": { "title": "SuperFences – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#superfences", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#superfences", "type": "object", "properties": { "custom_fences": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.superfences.custom_fences", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.superfences.custom_fences", "type": "array", "items": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.superfences.custom_fences", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.superfences.custom_fences", "type": "object", "properties": { "name": { @@ -668,11 +668,11 @@ "properties": { "pymdownx.tabbed": { "title": "Tabbed – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tabbed", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tabbed", "type": "object", "properties": { "alternate_style": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.tabbed.alternate_style", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.tabbed.alternate_style", "type": "boolean", "enum": [ true @@ -680,12 +680,12 @@ "default": true }, "combine_header_slug": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.tabbed.combine_header_slug", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.tabbed.combine_header_slug", "type": "boolean", "default": true }, "slugify": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.tabbed.slugify", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.tabbed.slugify", "default": "!!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}" } }, @@ -701,7 +701,7 @@ "oneOf": [ { "title": "Tasklist – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tasklist", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tasklist", "const": "pymdownx.tasklist" }, { @@ -709,16 +709,16 @@ "properties": { "pymdownx.tasklist": { "title": "Tasklist – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tasklist", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tasklist", "type": "object", "properties": { "custom_checkbox": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.tasklist.custom_checkbox", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.tasklist.custom_checkbox", "type": "boolean", "default": true }, "clickable_checkbox": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.tasklist.clickable_checkbox", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.tasklist.clickable_checkbox", "type": "boolean" } }, @@ -733,7 +733,7 @@ "oneOf": [ { "title": "Tilde – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caret-mark-tilde", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caret-mark-tilde", "const": "pymdownx.tilde" }, { @@ -741,7 +741,7 @@ "properties": { "pymdownx.tilde": { "title": "Tilde – Python Markdown Extensions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caret-mark-tilde", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caret-mark-tilde", "type": "object", "properties": { "smart_delete": { diff --git a/docs/schema/extra.json b/docs/schema/extra.json index ac2ae10822..8fae45bcd7 100644 --- a/docs/schema/extra.json +++ b/docs/schema/extra.json @@ -1,17 +1,17 @@ { "$schema": "https://json-schema.org/draft-07/schema", "title": "Extra configuration", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/", "type": "object", "properties": { "homepage": { "title": "Homepage link (when clicking on logo)", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#logo", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#logo", "type": "string" }, "analytics": { "title": "Analytics provider", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics", "type": "object", "allOf": [ { @@ -26,19 +26,19 @@ "properties": { "provider": { "title": "Google Analytics", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics", "const": "google" }, "property": { "anyOf": [ { "title": "Google Analytics 4", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics", "pattern": "^G-\\w{10}$" }, { "title": "Unknown property", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-site-analytics/#google-analytics", "type": "string" } ] @@ -66,7 +66,7 @@ "properties": { "provider": { "title": "Custom analytics provider", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#custom-site-analytics", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-site-analytics/#custom-site-analytics", "type": "string" }, "feedback": { @@ -106,12 +106,12 @@ }, "annotate": { "title": "Custom selectors for annotations", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#custom-selectors", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/reference/code-blocks/#custom-selectors", "type": "object", "patternProperties": { ".*": { "title": "Custom selector", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#custom-selectors", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/reference/code-blocks/#custom-selectors", "type": "array", "items": { "type": "string", @@ -122,23 +122,23 @@ }, "consent": { "title": "Cookie consent", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent", "type": "object", "properties": { "title": { "title": "Cookie consent title", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.title", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.title", "type": "string", "default": "Cookie consent" }, "description": { "title": "Cookie consent description", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.description", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.description", "type": "string" }, "cookies": { "title": "Cookies", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.cookies", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.cookies", "type": "object", "properties": { "analytics": { @@ -157,7 +157,7 @@ "defaultSnippets": [ { "label": "analytics (default)", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.cookies", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.cookies", "body": { "analytics": { "name": "Google Analytics", @@ -167,7 +167,7 @@ }, { "label": "github (default)", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.cookies", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.cookies", "body": { "analytics": { "name": "GitHub", @@ -179,7 +179,7 @@ }, "actions": { "title": "Cookie consent actions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.actions", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.actions", "type": "array", "items": { "oneOf": [ @@ -204,7 +204,7 @@ "defaultSnippets": [ { "label": "actions (default)", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.actions", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/ensuring-data-privacy/#+consent.actions", "body": { "actions": [ "accept", @@ -220,7 +220,7 @@ }, "social": { "title": "Social links", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#social-links", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-the-footer/#social-links", "type": "array", "items": { "title": "Social link", @@ -231,12 +231,12 @@ }, "link": { "title": "Social link", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#+social.link", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-the-footer/#+social.link", "type": "string" }, "name": { "title": "Social link name", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#+social.name", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-the-footer/#+social.name", "type": "string" } }, @@ -249,26 +249,26 @@ }, "alternate": { "title": "Site language selector", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language-selector", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/changing-the-language/#site-language-selector", "type": "array", "items": { "title": "Alternate language", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language-selector", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/changing-the-language/#site-language-selector", "type": "object", "properties": { "name": { "title": "Alternate language name", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#+alternate.name", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/changing-the-language/#+alternate.name", "type": "string" }, "link": { "title": "Alternate language link", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#+alternate.link", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/changing-the-language/#+alternate.link", "type": "string" }, "lang": { "title": "Alternate language code (ISO 639-1)", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#+alternate.lang", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/changing-the-language/#+alternate.lang", "type": "string" } }, @@ -282,29 +282,29 @@ }, "tags": { "title": "Tag identifiers", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#tag-icons-and-identifiers", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-tags/#tag-icons-and-identifiers", "type": "object", "patternProperties": { ".*": { "title": "Tag identifier mapping", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#tag-icons-and-identifiers", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-tags/#tag-icons-and-identifiers", "pattern": "^[\\w-]+$" } } }, "version": { "title": "Versioning", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/#versioning", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-versioning/#versioning", "type": "object", "properties": { "provider": { "title": "Versioning provider", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/#versioning", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-versioning/#versioning", "const": "mike" }, "default": { "title": "Default version", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/#version-warning", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-versioning/#version-warning", "oneOf": [ { "type": "string" @@ -320,7 +320,7 @@ }, "alias": { "title": "Show alias next to version number", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-versioning/#version-alias", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-the-versioning/#version-alias", "type": "boolean", "default": true } @@ -328,7 +328,7 @@ }, "generator": { "title": "Generator notice", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#generator-notice", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-the-footer/#generator-notice", "type": "boolean", "default": true } @@ -337,19 +337,19 @@ "$defs": { "cookie": { "title": "Cookie", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent", "oneOf": [ { "type": "object", "properties": { "name": { "title": "Cookie name", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent", "type": "string" }, "checked": { "title": "Initial state", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent", "type": "boolean", "default": true } @@ -361,7 +361,7 @@ }, { "title": "Cookie name", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent", "type": "string" } ] @@ -379,18 +379,18 @@ }, "feedback": { "title": "Was this page helpful?", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#was-this-page-helpful", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-site-analytics/#was-this-page-helpful", "type": "object", "properties": { "title": { "title": "Feedback widget title", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#was-this-page-helpful", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-site-analytics/#was-this-page-helpful", "type": "string", "default": "Was this page helpful?" }, "ratings": { "title": "Feedback ratings", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#was-this-page-helpful", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-site-analytics/#was-this-page-helpful", "type": "array", "items": { "title": "Feedback rating", @@ -401,17 +401,17 @@ }, "name": { "title": "Feedback rating name", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#+analytics.feedback.ratings.name", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-site-analytics/#+analytics.feedback.ratings.name", "type": "string" }, "data": { "title": "Feedback rating data", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#+analytics.feedback.ratings.data", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-site-analytics/#+analytics.feedback.ratings.data", "type": "number" }, "note": { "title": "Feedback rating data", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#+analytics.feedback.ratings.note", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-site-analytics/#+analytics.feedback.ratings.note", "type": "string" } }, diff --git a/docs/schema/nav.json b/docs/schema/nav.json index 8e17feff81..e802907695 100644 --- a/docs/schema/nav.json +++ b/docs/schema/nav.json @@ -1,24 +1,24 @@ { "$schema": "https://json-schema.org/draft-07/schema", "title": "Navigation tree", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#nav", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#nav", "type": "array", "items": { "anyOf": [ { "title": "Navigation item", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#nav", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#nav", "pattern": "\\.md$" }, { "type": "object", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#nav", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#nav", "patternProperties": { ".*": { "oneOf": [ { "title": "Navigation item", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#nav", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#nav", "pattern": "\\.md$" }, { diff --git a/docs/schema/plugins.json b/docs/schema/plugins.json index 4d019eb051..42d48ac1e7 100644 --- a/docs/schema/plugins.json +++ b/docs/schema/plugins.json @@ -1,7 +1,7 @@ { "$schema": "https://json-schema.org/draft-07/schema", "title": "Plugins", - "markdownDescription": "https://www.mkdocs.org/dev-guide/plugins/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/dev-guide/plugins/", "type": "array", "items": { "anyOf": [ diff --git a/docs/schema/plugins/blog.json b/docs/schema/plugins/blog.json index ef46b43ee6..471f4788e6 100644 --- a/docs/schema/plugins/blog.json +++ b/docs/schema/plugins/blog.json @@ -3,43 +3,43 @@ "title": "Built-in blog plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/", "const": "blog" }, { "type": "object", "properties": { "blog": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/", "type": "object", "properties": { "enabled": { "title": "Enable plugin", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.enabled", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.enabled", "type": "boolean", "default": true }, "blog_dir": { "title": "Blog directory", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.blog_dir", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.blog_dir", "type": "string", "default": "blog" }, "blog_toc": { "title": "Table of contents", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.blog_toc", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.blog_toc", "type": "boolean", "default": false }, "post_dir": { "title": "Post directory", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_dir", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.post_dir", "type": "string", "default": "\"{blog\\}/posts\"" }, "post_date_format": { "title": "Format string for post dates", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_date_format", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.post_date_format", "default": "long", "oneOf": [ { @@ -57,7 +57,7 @@ }, "post_url_date_format": { "title": "Format string for post dates in URLs", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_url_date_format", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.post_url_date_format", "oneOf": [ { "enum": [ @@ -74,7 +74,7 @@ }, "post_url_format": { "title": "Format string for post URLs", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_url_format", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.post_url_format", "oneOf": [ { "enum": [ @@ -91,24 +91,24 @@ }, "post_url_max_categories": { "title": "Number of categories in post URLs", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_url_max_categories", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.post_url_max_categories", "type": "number", "default": 1 }, "post_slugify": { "title": "Post slugify function", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_slugify", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.post_slugify", "default": "!!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}" }, "post_slugify_separator": { "title": "Post slugify separator", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_slugify_separator", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.post_slugify_separator", "type": "string", "default": "\"-\"" }, "post_excerpt": { "title": "Post excerpts", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_excerpt", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.post_excerpt", "oneOf": [ { "title": "Post excerpts are optional", @@ -123,49 +123,49 @@ }, "post_excerpt_max_authors": { "title": "Number of authors to render in post excerpts", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_excerpt_max_authors", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.post_excerpt_max_authors", "type": "number", "default": 1 }, "post_excerpt_max_categories": { "title": "Number of categories to render in post excerpts", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_excerpt_max_categories", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.post_excerpt_max_categories", "type": "number", "default": 5 }, "post_excerpt_separator": { "title": "Post excerpt separator", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_excerpt_separator", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.post_excerpt_separator", "type": "string", "default": "" }, "post_readtime": { "title": "Post reading time computation", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_readtime", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.post_readtime", "type": "boolean", "default": true }, "post_readtime_words_per_minute": { "title": "Post reading time words per minute", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.post_readtime_words_per_minute", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.post_readtime_words_per_minute", "type": "number", "default": 265 }, "archive": { "title": "Archive", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.archive", "type": "boolean", "default": true }, "archive_name": { "title": "Archive name", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_name", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.archive_name", "type": "string", "default": "Archive" }, "archive_date_format": { "title": "Format string for archive dates", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_date_format", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.archive_date_format", "oneOf": [ { "enum": [ @@ -181,7 +181,7 @@ }, "archive_url_date_format": { "title": "Format string for archive dates in URLs", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_url_date_format", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.archive_url_date_format", "oneOf": [ { "enum": [ @@ -197,7 +197,7 @@ }, "archive_url_format": { "title": "Format string for archive URLs", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_url_format", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.archive_url_format", "oneOf": [ { "enum": [ @@ -211,37 +211,37 @@ }, "archive_pagination": { "title": "Pagination for archive", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_pagination", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.archive_pagination", "type": "boolean", "default": true }, "archive_pagination_per_page": { "title": "Posts per page for archive", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_pagination_per_page", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.archive_pagination_per_page", "type": "number", "default": 10 }, "archive_toc": { "title": "Table of contents for archive", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.archive_toc", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.archive_toc", "type": "boolean", "default": false }, "categories": { "title": "Categories", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.categories", "type": "boolean", "default": true }, "categories_name": { "title": "Categories name", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_name", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.categories_name", "type": "string", "default": "Categories" }, "categories_url_format": { "title": "Format string for category URLs", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_url_format", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.categories_url_format", "oneOf": [ { "enum": [ @@ -256,18 +256,18 @@ }, "categories_slugify": { "title": "Categories slugify function", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_slugify", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.categories_slugify", "default": "!!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}" }, "categories_slugify_separator": { "title": "Categories slugify separator", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_slugify_separator", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.categories_slugify_separator", "type": "string", "default": "\"-\"" }, "categories_sort_by": { "title": "Sort categories by this function", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_sort_by", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.categories_sort_by", "default": "!!python/name:material.plugins.blog.view_name", "oneOf": [ { @@ -283,12 +283,12 @@ }, "categories_sort_reverse": { "title": "Soft categories in reverse", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_sort_reverse", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.categories_sort_reverse", "default": false }, "categories_allowed": { "title": "Allowed categories", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_allowed", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.categories_allowed", "type": "array", "items": { "type": "string" @@ -298,49 +298,49 @@ }, "categories_pagination": { "title": "Pagination for categories", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_pagination", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.categories_pagination", "type": "boolean", "default": true }, "categories_pagination_per_page": { "title": "Posts per page for categories", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_pagination_per_page", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.categories_pagination_per_page", "type": "number", "default": 10 }, "categories_toc": { "title": "Table of contents for categories", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.categories_toc", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.categories_toc", "type": "boolean", "default": false }, "authors": { "title": "Author info", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.authors", "type": "boolean", "default": true }, "authors_file": { "title": "Authors file", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_file", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.authors_file", "type": "string", "default": "\"{blog}/.authors.yml\"" }, "authors_profiles": { "title": "Author profiles", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_profiles", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.authors_profiles", "type": "boolean", "default": false }, "authors_profiles_name": { "title": "Authors profiles name", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_profiles_name", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.authors_profiles_name", "type": "string", "default": "Authors" }, "authors_profiles_url_format": { "title": "Format string for author profile URLs", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_profiles_url_format", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.authors_profiles_url_format", "oneOf": [ { "enum": [ @@ -355,37 +355,37 @@ }, "authors_profiles_pagination": { "title": "Pagination for author profiles", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_profiles_pagination", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.authors_profiles_pagination", "type": "boolean", "default": true }, "authors_profiles_pagination_per_page": { "title": "Posts per page for author profiles", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_profiles_pagination_per_page", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.authors_profiles_pagination_per_page", "type": "number", "default": 10 }, "authors_profiles_toc": { "title": "Table of contents for author profiles", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.authors_profiles_toc", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.authors_profiles_toc", "type": "boolean", "default": false }, "pagination": { "title": "Pagination", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.pagination", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.pagination", "type": "boolean", "default": true }, "pagination_per_page": { "title": "Posts per page", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.pagination_per_page", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.pagination_per_page", "type": "number", "default": 10 }, "pagination_url_format": { "title": "Format string for pagination URLs", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.pagination_url_format", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.pagination_url_format", "oneOf": [ { "enum": [ @@ -400,7 +400,7 @@ }, "pagination_template": { "title": "Template string for pagination", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.pagination_template", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.pagination_template", "oneOf": [ { "enum": [ @@ -417,25 +417,25 @@ }, "pagination_keep_content": { "title": "Paginated indexes inherit content", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.pagination_keep_content", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.pagination_keep_content", "type": "boolean", "default": false }, "draft": { "title": "Render posts marked as drafts", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.draft", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.draft", "type": "boolean", "default": false }, "draft_on_serve": { "title": "Render posts marked as drafts when previewing", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.draft_on_serve", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.draft_on_serve", "type": "boolean", "default": true }, "draft_if_future_date": { "title": "Automatically mark posts with future dates as drafts", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/blog/#config.draft_if_future_date", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/#config.draft_if_future_date", "type": "boolean", "default": false } diff --git a/docs/schema/plugins/external/git-committers.json b/docs/schema/plugins/external/git-committers.json index 06a70f41a2..9c32ace677 100644 --- a/docs/schema/plugins/external/git-committers.json +++ b/docs/schema/plugins/external/git-committers.json @@ -15,18 +15,18 @@ "properties": { "enabled": { "title": "Enable plugin", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#+git-committers.enabled", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/adding-a-git-repository/#+git-committers.enabled", "type": "boolean", "default": true }, "repository": { "title": "Repository slug", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#+git-committers.repository", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/adding-a-git-repository/#+git-committers.repository", "type": "string" }, "branch": { "title": "Repository branch", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#+git-committers.branch", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/adding-a-git-repository/#+git-committers.branch", "type": "string", "default": "master" } diff --git a/docs/schema/plugins/group.json b/docs/schema/plugins/group.json index f5c5647037..744fa0e44d 100644 --- a/docs/schema/plugins/group.json +++ b/docs/schema/plugins/group.json @@ -6,17 +6,17 @@ "type": "object", "properties": { "group": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/group/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/group/", "type": "object", "properties": { "enabled": { "title": "Enable plugin", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/group/#config.enabled", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/group/#config.enabled", "type": "boolean", "default": true }, "plugins": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/group/#config.plugins", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/group/#config.plugins", "$ref": "../plugins.json" } }, diff --git a/docs/schema/plugins/info.json b/docs/schema/plugins/info.json index 320b73c57e..9d03bd4ce7 100644 --- a/docs/schema/plugins/info.json +++ b/docs/schema/plugins/info.json @@ -3,37 +3,37 @@ "title": "Built-in info plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/info/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/info/", "const": "info" }, { "type": "object", "properties": { "info": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/info/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/info/", "type": "object", "properties": { "enabled": { "title": "Enable plugin", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/info/#config.enabled", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/info/#config.enabled", "type": "boolean", "default": true }, "enabled_on_serve": { "title": "Enable plugin when previewing", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/info/#config.enabled_on_serve", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/info/#config.enabled_on_serve", "type": "boolean", "default": false }, "archive": { "title": "Enable creation of archive", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/info/#config.archive", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/info/#config.archive", "type": "boolean", "default": true }, "archive_stop_on_violation": { "title": "Stop creation of archive on violation", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/info/#config.archive_stop_on_violation", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/info/#config.archive_stop_on_violation", "type": "boolean", "default": true } diff --git a/docs/schema/plugins/meta.json b/docs/schema/plugins/meta.json index 7e8c5e7e8a..a01b00d7c9 100644 --- a/docs/schema/plugins/meta.json +++ b/docs/schema/plugins/meta.json @@ -3,25 +3,25 @@ "title": "Built-in meta plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/meta/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/meta/", "const": "meta" }, { "type": "object", "properties": { "meta": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/meta/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/meta/", "type": "object", "properties": { "enabled": { "title": "Enable plugin", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/meta/#config.enabled", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/meta/#config.enabled", "type": "boolean", "default": true }, "meta_file": { "title": "Meta file name", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/meta/#config.meta_file", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/meta/#config.meta_file", "pattern": "\\.yml$", "default": "\"**/.meta.yml\"" } diff --git a/docs/schema/plugins/offline.json b/docs/schema/plugins/offline.json index 838168d578..5487b66b6d 100644 --- a/docs/schema/plugins/offline.json +++ b/docs/schema/plugins/offline.json @@ -3,19 +3,19 @@ "title": "Built-in offline plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/offline/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/offline/", "const": "offline" }, { "type": "object", "properties": { "offline": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/offline/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/offline/", "type": "object", "properties": { "enabled": { "title": "Enable plugin", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/offline/#config.enabled", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/offline/#config.enabled", "type": "boolean", "default": true } diff --git a/docs/schema/plugins/optimize.json b/docs/schema/plugins/optimize.json index f61a73fc0d..ef9a73db57 100644 --- a/docs/schema/plugins/optimize.json +++ b/docs/schema/plugins/optimize.json @@ -3,82 +3,82 @@ "title": "Built-in optimize plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/optimize/", "const": "optimize" }, { "type": "object", "properties": { "optimize": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/optimize/", "type": "object", "properties": { "enabled": { "title": "Enable plugin", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.enabled", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/optimize/#config.enabled", "type": "boolean", "default": true }, "concurrency": { "title": "Concurrency (number of CPUs)", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.concurrency", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/optimize/#config.concurrency", "type": "number" }, "cache": { "title": "Enable caching", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.cache", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/optimize/#config.cache", "type": "boolean", "default": true }, "cache_dir": { "title": "Cache directory", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.cache_dir", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/optimize/#config.cache_dir", "type": "string", "default": ".cache/plugins/optimize" }, "optimize_png": { "title": "Optimization of PNGs", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_png", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/optimize/#config.optimize_png", "type": "boolean", "default": true }, "optimize_png_speed": { "title": "Speed/quality tradeoff [1,10]", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_png_speed", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/optimize/#config.optimize_png_speed", "type": "number", "default": 4 }, "optimize_png_strip": { "title": "Strip unnecessary metadata from PNGs", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_png_strip", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/optimize/#config.optimize_png_strip", "type": "boolean", "default": true }, "optimize_jpg": { "title": "Optimization of JPGs", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_jpg", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/optimize/#config.optimize_jpg", "type": "boolean", "default": true }, "optimize_jpg_quality": { "title": "Speed/quality tradeoff for pngquant [0,10]", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_jpg_quality", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/optimize/#config.optimize_jpg_quality", "type": "number", "default": 60 }, "optimize_jpg_progressive": { "title": "Progressive encoding (faster rendering)", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_jpg_progressive", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/optimize/#config.optimize_jpg_progressive", "type": "boolean", "default": true }, "optimize_include": { "title": "Files or folders to include", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_include", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/optimize/#config.optimize_include", "type": "array", "items": { "title": "Files or folders matching this pattern will be included", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_include", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/optimize/#config.optimize_include", "pattern": ".*" }, "uniqueItems": true, @@ -86,11 +86,11 @@ }, "optimize_exclude": { "title": "Files or folders to exclude", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_exclude", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/optimize/#config.optimize_exclude", "type": "array", "items": { "title": "Files or folders matching this pattern will be excluded", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.optimize_exclude", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/optimize/#config.optimize_exclude", "pattern": ".*" }, "uniqueItems": true, @@ -98,13 +98,13 @@ }, "print_gain": { "title": "Print optimization gain", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.print_gain", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/optimize/#config.print_gain", "type": "boolean", "default": true }, "print_gain_summary": { "title": "Print optimization gain summary", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/optimize/#config.print_gain_summary", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/optimize/#config.print_gain_summary", "type": "boolean", "default": true } diff --git a/docs/schema/plugins/privacy.json b/docs/schema/plugins/privacy.json index 1233ac5493..b771cb859d 100644 --- a/docs/schema/plugins/privacy.json +++ b/docs/schema/plugins/privacy.json @@ -3,48 +3,48 @@ "title": "Built-in privacy plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/privacy/", "const": "privacy" }, { "type": "object", "properties": { "privacy": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/privacy/", "type": "object", "properties": { "enabled": { "title": "Enable plugin", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.enabled", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/privacy/#config.enabled", "type": "boolean", "default": true }, "concurrency": { "title": "Concurrency (number of CPUs)", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.concurrency", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/privacy/#config.concurrency", "type": "number" }, "cache": { "title": "Enable caching", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.cache", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/privacy/#config.cache", "type": "boolean", "default": true }, "cache_dir": { "title": "Cache directory", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.cache_dir", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/privacy/#config.cache_dir", "type": "string", "default": ".cache/plugins/privacy" }, "log": { "title": "Enable logging", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.log", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/privacy/#config.log", "type": "boolean", "default": true }, "log_level": { "title": "Log level", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.log_level", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/privacy/#config.log_level", "enum": [ "error", "warn", @@ -55,29 +55,29 @@ }, "assets": { "title": "Process external assets", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/privacy/#config.assets", "type": "boolean", "default": true }, "assets_fetch": { "title": "Download external assets", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets_fetch", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/privacy/#config.assets_fetch", "type": "boolean", "default": true }, "assets_fetch_dir": { "title": "Download external assets to this directory", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets_fetch_dir", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/privacy/#config.assets_fetch_dir", "type": "string", "default": "assets/external" }, "assets_include": { "title": "External assets to include", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets_include", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/privacy/#config.assets_include", "type": "array", "items": { "title": "External assets matching this pattern will be downloaded", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets_include", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/privacy/#config.assets_include", "pattern": ".*" }, "uniqueItems": true, @@ -85,11 +85,11 @@ }, "assets_exclude": { "title": "External assets to exclude", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets_exclude", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/privacy/#config.assets_exclude", "type": "array", "items": { "title": "External assets matching this pattern will not be downloaded", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.assets_exclude", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/privacy/#config.assets_exclude", "pattern": ".*" }, "uniqueItems": true, @@ -97,13 +97,13 @@ }, "links": { "title": "Process external links", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.links", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/privacy/#config.links", "type": "boolean", "default": true }, "links_attr_map": { "title": "Custom attributes to add to external links", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.links_attr_map", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/privacy/#config.links_attr_map", "type": "object", "patternProperties": { "^[\\w_]+$": { @@ -113,7 +113,7 @@ }, "links_noopener": { "title": "Behavior for external links that open in new windows", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/privacy/#config.links_noopener", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/privacy/#config.links_noopener", "type": "boolean", "default": true } diff --git a/docs/schema/plugins/projects.json b/docs/schema/plugins/projects.json index 74b4be89aa..c8f6864564 100644 --- a/docs/schema/plugins/projects.json +++ b/docs/schema/plugins/projects.json @@ -3,48 +3,48 @@ "title": "Built-in projects plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/projects/", "const": "projects" }, { "type": "object", "properties": { "projects": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/projects/", "type": "object", "properties": { "enabled": { "title": "Enable plugin", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.enabled", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/projects/#config.enabled", "type": "boolean", "default": true }, "concurrency": { "title": "Concurrency (number of CPUs)", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.concurrency", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/projects/#config.concurrency", "type": "number" }, "cache": { "title": "Enable caching", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.cache", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/projects/#config.cache", "type": "boolean", "default": true }, "cache_dir": { "title": "Cache directory", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.cache_dir", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/projects/#config.cache_dir", "type": "string", "default": ".cache/plugins/projects" }, "log": { "title": "Enable logging", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.log", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/projects/#config.log", "type": "boolean", "default": true }, "log_level": { "title": "Log level", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.log_level", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/projects/#config.log_level", "enum": [ "error", "warn", @@ -55,25 +55,25 @@ }, "projects": { "title": "Enable projects", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.projects", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/projects/#config.projects", "type": "boolean", "default": true }, "projects_dir": { "title": "Projects directory", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.projects_dir", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/projects/#config.projects_dir", "type": "string", "default": "projects" }, "projects_config_files": { "title": "Projects configuration files", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.projects_config_files", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/projects/#config.projects_config_files", "type": "string", "default": "\"*/mkdocs.yml\"" }, "projects_config_transform": { "title": "Projects configuration transform", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.projects_config_transform", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/projects/#config.projects_config_transform", "type": "string", "defaultSnippets": [ { @@ -83,7 +83,7 @@ }, "hoisting": { "title": "Enable hoisting", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/projects/#config.hoisting", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/projects/#config.hoisting", "type": "boolean", "default": true } diff --git a/docs/schema/plugins/search.json b/docs/schema/plugins/search.json index dd1ad9e368..0365b1227b 100644 --- a/docs/schema/plugins/search.json +++ b/docs/schema/plugins/search.json @@ -3,14 +3,14 @@ "title": "Built-in search plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/search/", "const": "search" }, { "type": "object", "properties": { "search": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/search/", "type": "object", "properties": { "lang": { @@ -31,12 +31,12 @@ }, "separator": { "title": "Separator for indexing and query tokenization", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/#config.separator", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/search/#config.separator", "type": "string" }, "pipeline": { "title": "Text processing pipeline for indexing", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/#config.pipeline", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/search/#config.pipeline", "type": "array", "items": { "enum": [ @@ -49,12 +49,12 @@ }, "jieba_dict": { "title": "Jieba dictionary replacement", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/#config.jieba_dict", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/search/#config.jieba_dict", "type": "string" }, "jieba_dict_user": { "title": "Jieba dictionary augmentation", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/#config.jieba_dict_user", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/search/#config.jieba_dict_user", "type": "string" } }, @@ -67,7 +67,7 @@ "$defs": { "lang": { "title": "Site search language", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/search/#config.lang", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/search/#config.lang", "oneOf": [ { "title": "Site search language: Arabic", diff --git a/docs/schema/plugins/social.json b/docs/schema/plugins/social.json index a8eeae9d2e..cd54a3feb7 100644 --- a/docs/schema/plugins/social.json +++ b/docs/schema/plugins/social.json @@ -3,54 +3,54 @@ "title": "Built-in social plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/social/", "const": "social" }, { "type": "object", "properties": { "social": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/social/", "type": "object", "properties": { "enabled": { "title": "Enable plugin", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.enabled", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/social/#config.enabled", "type": "boolean", "default": true }, "concurrency": { "title": "Concurrency (number of CPUs)", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.concurrency", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/social/#config.concurrency", "type": "number" }, "cache": { "title": "Enable caching", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cache", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/social/#config.cache", "type": "boolean", "default": true }, "cache_dir": { "title": "Cache directory", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cache_dir", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/social/#config.cache_dir", "type": "string", "default": ".cache/plugins/social" }, "cards": { "title": "Social cards", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/social/#config.cards", "type": "boolean", "default": true }, "log": { "title": "Enable logging", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.log", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/social/#config.log", "type": "boolean", "default": true }, "log_level": { "title": "Log level", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.log_level", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/social/#config.log_level", "enum": [ "warn", "info", @@ -60,19 +60,19 @@ }, "cards_dir": { "title": "Social cards directory", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards_dir", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/social/#config.cards_dir", "type": "string", "default": "assets/images/social" }, "cards_layout_dir": { "title": "Social cards layout directory", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards_layout_dir", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/social/#config.cards_layout_dir", "type": "string", "default": "layouts" }, "cards_layout": { "title": "Social cards layout", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards_layout", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/social/#config.cards_layout", "default": "default", "oneOf": [ { @@ -90,16 +90,16 @@ }, "cards_layout_options": { "title": "Social cards layout options", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards_layout_options", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/social/#config.cards_layout_options", "type": "object" }, "cards_include": { "title": "Pages or folders to include", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards_include", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/social/#config.cards_include", "type": "array", "items": { "title": "Pages or folders matching this pattern will be included", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards_include", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/social/#config.cards_include", "pattern": ".*" }, "uniqueItems": true, @@ -107,11 +107,11 @@ }, "cards_exclude": { "title": "Pages or folders to exclude", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards_exclude", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/social/#config.cards_exclude", "type": "array", "items": { "title": "Pages or folders matching this pattern will be excluded", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.cards_exclude", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/social/#config.cards_exclude", "pattern": ".*" }, "uniqueItems": true, @@ -119,31 +119,31 @@ }, "debug": { "title": "Debug mode", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.debug", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/social/#config.debug", "type": "boolean", "default": true }, "debug_on_build": { "title": "Always disable debug mode on build", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.debug_on_build", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/social/#config.debug_on_build", "type": "boolean", "default": false }, "debug_grid": { "title": "Debug grid", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.debug_grid", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/social/#config.debug_grid", "type": "boolean", "default": true }, "debug_grid_step": { "title": "Debug grid step size", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.debug_grid_step", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/social/#config.debug_grid_step", "type": "number", "default": 32 }, "debug_color": { "title": "Debug color", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/social/#config.debug_color", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/social/#config.debug_color", "type": "string", "default": "yellow" } diff --git a/docs/schema/plugins/tags.json b/docs/schema/plugins/tags.json index 447afd5b43..34acefeead 100644 --- a/docs/schema/plugins/tags.json +++ b/docs/schema/plugins/tags.json @@ -3,82 +3,82 @@ "title": "Built-in tags plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/", "const": "tags" }, { "type": "object", "properties": { "tags": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/", "type": "object", "properties": { "enabled": { "title": "Enable plugin", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.enabled", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.enabled", "type": "boolean", "default": true }, "tags": { "title": "Rendering of tags", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.tags", "type": "boolean", "default": true }, "tags_file": { "title": "Markdown file to render tags index", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags_file", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.tags_file", "pattern": "\\.md$", "default": "tags.md" }, "tags_slugify": { "title": "Tags slugify function", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags_slugify", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.tags_slugify", "default": "!!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}" }, "tags_slugify_separator": { "title": "Tags slugify separator", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags_slugify_separator", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.tags_slugify_separator", "type": "string", "default": "-" }, "tags_slugify_format": { "title": "Format string for tags slugifier", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags_slugify_format", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.tags_slugify_format", "type": "string", "default": "\"tag:{slug}\"" }, "tags_hierarchy": { "title": "Rendering of tags", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.tags", "type": "boolean", "default": true }, "tags_sort_by": { "title": "Sort tags by this function", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags_sort_by", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.tags_sort_by", "default": "!!python/name:material.plugins.tags.casefold" }, "tags_sort_reverse": { "title": "Soft tags in reverse", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags_sort_reverse", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.tags_sort_reverse", "default": false }, "tags_name_property": { "title": "Tags front matter property", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags_name_property", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.tags_name_property", "type": "string", "default": "tags" }, "tags_name_variable": { "title": "Tags Jinja variable name", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags_name_variable", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.tags_name_variable", "type": "string", "default": "tags" }, "tags_allowed": { "title": "Tags allowed", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.tags_allowed", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.tags_allowed", "type": "array", "items": { "type": "string" @@ -88,44 +88,44 @@ }, "listings": { "title": "Rendering of listings", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.listings", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.listings", "type": "boolean", "default": true }, "listings_map": { "title": "Map of listing configurations", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.listings_map", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.listings_map", "type": "object", "patternProperties": { ".*": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#listing-configuration", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#listing-configuration", "type": "object", "properties": { "scope": { "title": "Scoped listing", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#listing.scope", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#listing.scope", "default": false }, "shadow": { "title": "Render shadow tags", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#listing.shadow", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#listing.shadow", "default": true }, "include": { "title": "Tag inclusion list", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#listing.include", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#listing.include", "type": "array", "uniqueItems": true }, "exclude": { "title": "Tag exclusion list", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#listing.exclude", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#listing.exclude", "type": "array", "uniqueItems": true }, "toc": { "title": "Render tags in table of contents", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#listing.toc", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#listing.toc", "default": true } } @@ -135,50 +135,50 @@ }, "listings_sort_by": { "title": "Sort listing items by this function", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.listings_sort_by", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.listings_sort_by", "default": "!!python/name:material.plugins.tags.casefold" }, "listings_sort_reverse": { "title": "Soft listing items in reverse", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.listings_sort_reverse", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.listings_sort_reverse", "default": false }, "listings_tags_sort_by": { "title": "Sort listing tags by this function", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.listings_tags_sort_by", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.listings_tags_sort_by", "default": "!!python/name:material.plugins.tags.casefold" }, "listings_tags_sort_reverse": { "title": "Soft listing tags in reverse", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.listings_tags_sort_reverse", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.listings_tags_sort_reverse", "default": false }, "listings_directive": { "title": "Listings directive", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.listings_directive", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.listings_directive", "type": "string", "default": "material/tags" }, "listings_toc": { "title": "Render tags in table of contents", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.listings_toc", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.listings_toc", "default": true }, "shadow": { "title": "Rendering shadow tags on build", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.shadow", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.shadow", "type": "boolean", "default": false }, "shadow_on_serve": { "title": "Rendering shadow tags on serve", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.shadow_on_serve", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.shadow_on_serve", "type": "boolean", "default": true }, "shadow_tags": { "title": "Shadow tags", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.shadow_tags", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.shadow_tags", "type": "array", "items": { "type": "string" @@ -188,30 +188,30 @@ }, "shadow_tags_prefix": { "title": "Shadow tags prefix", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.shadow_tags_prefix", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.shadow_tags_prefix", "type": "string", "default": "_" }, "shadow_tags_suffix": { "title": "Shadow tags suffix", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.shadow_tags_suffix", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.shadow_tags_suffix", "type": "string" }, "export": { "title": "Tags export", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.export", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.export", "type": "boolean", "default": true }, "export_file": { "title": "Tags file", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.export_file", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.export_file", "type": "boolean", "default": "tags.json" }, "export_only": { "title": "Only export tags, don't render them", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/tags/#config.export_only", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/tags/#config.export_only", "type": "boolean", "default": true } diff --git a/docs/schema/plugins/typeset.json b/docs/schema/plugins/typeset.json index 1975da5e59..c0299bb943 100644 --- a/docs/schema/plugins/typeset.json +++ b/docs/schema/plugins/typeset.json @@ -3,19 +3,19 @@ "title": "Built-in typeset plugin", "oneOf": [ { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/typeset/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/typeset/", "const": "typeset" }, { "type": "object", "properties": { "typeset": { - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/typeset/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/typeset/", "type": "object", "properties": { "enabled": { "title": "Enable plugin", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/plugins/typeset/#config.enabled", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/plugins/typeset/#config.enabled", "type": "boolean", "default": true } diff --git a/docs/schema/theme.json b/docs/schema/theme.json index 15fca4bc82..058a968cd6 100644 --- a/docs/schema/theme.json +++ b/docs/schema/theme.json @@ -1,12 +1,12 @@ { "$schema": "https://json-schema.org/draft-07/schema", "title": "Theme configuration", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/", "type": "object", "properties": { "name": { "title": "Theme name", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#name", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#name", "oneOf": [ { "const": "material" @@ -19,7 +19,7 @@ }, "custom_dir": { "title": "Directory with theme overrides", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/customization/#setup-and-theme-structure", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/customization/#setup-and-theme-structure", "type": "string", "defaultSnippets": [ { @@ -29,11 +29,11 @@ }, "static_templates": { "title": "Static templates to render", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#static_templates", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#static_templates", "type": "array", "items": { "title": "Path to HTML file", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#static_templates", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#static_templates", "pattern": "\\.html$" }, "uniqueItems": true, @@ -41,11 +41,11 @@ }, "language": { "title": "Site language", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/changing-the-language/", "oneOf": [ { "title": "Site language: Custom", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#custom-translations", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/changing-the-language/#custom-translations", "const": "custom" }, { @@ -305,7 +305,7 @@ }, "direction": { "title": "Directionality", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#directionality", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/changing-the-language/#directionality", "enum": [ "ltr", "rtl" @@ -313,7 +313,7 @@ }, "favicon": { "title": "Favicon", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#favicon", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#favicon", "pattern": "\\.(ico|png|svg|jpe?g|gif)$", "defaultSnippets": [ { @@ -323,7 +323,7 @@ }, "logo": { "title": "Logo", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#logo", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#logo", "pattern": "\\.(png|svg|jpe?g|gif|webp)$", "defaultSnippets": [ { @@ -333,7 +333,7 @@ }, "icon": { "title": "Icons", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/changing-the-logo-and-icons/", "type": "object", "properties": { "edit": { @@ -377,7 +377,7 @@ }, "admonition": { "title": "Admonition icon", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/admonitions/#admonition-icons", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/reference/admonitions/#admonition-icons", "type": "object", "properties": { "note": { @@ -471,7 +471,7 @@ }, "tag": { "title": "Tag icon", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#tag-icons-and-identifiers", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-tags/#tag-icons-and-identifiers", "type": "object", "patternProperties": { "^[\\w-]+$": { @@ -527,148 +527,148 @@ }, "features": { "title": "Feature flags", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/", "type": "array", "items": { "oneOf": [ { "title": "Mark as read", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-header/#mark-as-read", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-the-header/#mark-as-read", "const": "announce.dismiss" }, { "title": "Edit this page", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#code-actions", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/adding-a-git-repository/#code-actions", "const": "content.action.edit" }, { "title": "View source of this page", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#code-actions", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/adding-a-git-repository/#code-actions", "const": "content.action.view" }, { "title": "Code annotations", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-annotations", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/reference/code-blocks/#code-annotations", "const": "content.code.annotate" }, { "title": "Code copy button", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-copy-button", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/reference/code-blocks/#code-copy-button", "const": "content.code.copy" }, { "title": "Code selection button", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-selection-button", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/reference/code-blocks/#code-selection-button", "const": "content.code.select" }, { "title": "Footnote tooltips", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/footnotes/#footnote-tooltips", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/reference/footnotes/#footnote-tooltips", "const": "content.footnote.tooltips" }, { "title": "Linked content tabs", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#linked-content-tabs", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/reference/content-tabs/#linked-content-tabs", "const": "content.tabs.link" }, { "title": "Improved tooltips", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/reference/tooltips/#improved-tooltips", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/reference/tooltips/#improved-tooltips", "const": "content.tooltips" }, { "title": "Header hides automatically when scrolling", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-header/#automatic-hiding", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-the-header/#automatic-hiding", "const": "header.autohide" }, { "title": "Navigation expansion", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-expansion", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-expansion", "const": "navigation.expand" }, { "title": "Navigation footer", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-footer", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-footer", "const": "navigation.footer" }, { "title": "Section index pages", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#section-index-pages", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-navigation/#section-index-pages", "const": "navigation.indexes" }, { "title": "Instant loading", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#instant-loading", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-navigation/#instant-loading", "const": "navigation.instant" }, { "title": "Instant prefetching", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#instant-prefetching", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-navigation/#instant-prefetching", "const": "navigation.instant.prefetch" }, { "title": "Progress indicator", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#progress-indicator", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-navigation/#progress-indicator", "const": "navigation.instant.progress" }, { "title": "Navigation path (Breadcrumbs)", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-path", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-path", "const": "navigation.path" }, { "title": "Navigation pruning", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-pruning", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-pruning", "const": "navigation.prune" }, { "title": "Navigation sections", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-sections", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-sections", "const": "navigation.sections" }, { "title": "Navigation tabs", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-tabs", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-tabs", "const": "navigation.tabs" }, { "title": "Sticky navigation tabs", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#sticky-navigation-tabs", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-navigation/#sticky-navigation-tabs", "const": "navigation.tabs.sticky" }, { "title": "Back-to-top button", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#back-to-top-button", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-navigation/#back-to-top-button", "const": "navigation.top" }, { "title": "Anchor tracking", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#anchor-tracking", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-navigation/#anchor-tracking", "const": "navigation.tracking" }, { "title": "Search highlighting", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-highlighting", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-site-search/#search-highlighting", "const": "search.highlight" }, { "title": "Search sharing", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-sharing", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-site-search/#search-sharing", "const": "search.share" }, { "title": "Search suggestions", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-suggestions", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-site-search/#search-suggestions", "const": "search.suggest" }, { "title": "Integrated table of contents", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#anchor-following", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-navigation/#anchor-following", "const": "toc.follow" }, { "title": "Integrated table of contents", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-integration", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-integration", "const": "toc.integrate" } ] @@ -680,7 +680,7 @@ "oneOf": [ { "title": "Color palette", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/changing-the-colors/", "type": "object", "properties": { "scheme": { @@ -697,7 +697,7 @@ }, { "title": "Color palette", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/changing-the-colors/", "type": "array", "items": { "type": "object", @@ -715,7 +715,7 @@ "oneOf": [ { "title": "System preference", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#system-preference", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/changing-the-colors/#system-preference", "type": "string", "enum": [ "\"(prefers-color-scheme: light)\"", @@ -735,14 +735,14 @@ }, "toggle": { "title": "Color palette toggle", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#color-palette-toggle", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/changing-the-colors/#color-palette-toggle", "properties": { "icon": { "$ref": "#/$defs/icon" }, "name": { "title": "Color palette toggle name", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#toggle-name", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/changing-the-colors/#toggle-name", "type": "string" } }, @@ -772,7 +772,7 @@ "oneOf": [ { "title": "Google Fonts", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-fonts/", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/changing-the-fonts/", "type": "object", "properties": { "text": { @@ -786,7 +786,7 @@ }, { "title": "Disable Google Fonts", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-fonts/#autoloading", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/changing-the-fonts/#autoloading", "enum": [ false ] @@ -809,7 +809,7 @@ "$defs": { "scheme": { "title": "Color scheme", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#color-scheme", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/changing-the-colors/#color-scheme", "anyOf": [ { "enum": [ @@ -824,7 +824,7 @@ }, "primary": { "title": "Primary color", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#primary-color", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/changing-the-colors/#primary-color", "enum": [ "red", "pink", @@ -852,7 +852,7 @@ }, "accent": { "title": "Accent color", - "markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#accent-color", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs-material/setup/changing-the-colors/#accent-color", "enum": [ "red", "pink", diff --git a/docs/schema/validation.json b/docs/schema/validation.json index dd61f65a16..aed4e54770 100644 --- a/docs/schema/validation.json +++ b/docs/schema/validation.json @@ -1,7 +1,7 @@ { "$schema": "https://json-schema.org/draft-07/schema", "title": "Validation settings", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#validation", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#validation", "type": "object", "properties": { "omitted_files": { "$ref": "#/$defs/omitted_files" }, @@ -11,7 +11,7 @@ "unrecognized_links": { "$ref": "#/$defs/unrecognized_links" }, "nav": { "title": "validation of navigation", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#validation", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#validation", "properties": { "omitted_files": { "$ref": "#/$defs/omitted_files" }, "not_found": { "$ref": "#/$defs/not_found" }, @@ -21,7 +21,7 @@ }, "links": { "title": "Validation of links", - "markdownDescription": "https://www.mkdocs.org/user-guide/configuration/#validation", + "markdownDescription": "https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#validation", "properties": { "anchors": { "$ref": "#/$defs/anchors" }, "not_found": { "$ref": "#/$defs/not_found" }, diff --git a/docs/setup/adding-a-comment-system.md b/docs/setup/adding-a-comment-system.md index 3f9d4ebf11..3eff48887e 100644 --- a/docs/setup/adding-a-comment-system.md +++ b/docs/setup/adding-a-comment-system.md @@ -108,6 +108,6 @@ If you wish to enable comments for an entire folder, you can use the [Giscus GitHub App]: https://github.com/apps/giscus [theme extension]: ../customization.md#extending-the-theme - [comments]: https://github.com/squidfunk/mkdocs-material/blob/main/src/templates/partials/comments.html + [comments]: https://github.com/mkdocs-ng/mkdocs-material/blob/main/src/templates/partials/comments.html [overriding partials]: ../customization.md#overriding-partials [built-in meta plugin]: ../plugins/meta.md diff --git a/docs/setup/adding-a-git-repository.md b/docs/setup/adding-a-git-repository.md index 11ae1fad81..d9a0bbf596 100644 --- a/docs/setup/adding-a-git-repository.md +++ b/docs/setup/adding-a-git-repository.md @@ -35,7 +35,7 @@ automatically requested and rendered. sorted by update time], the [equivalent API endpoint] is used. So, make sure you also [create a release for GitLab repositories]. - [repo_url]: https://www.mkdocs.org/user-guide/configuration/#repo_url + [repo_url]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#repo_url [latest release]: https://docs.github.com/en/rest/reference/releases#get-the-latest-release [create a release]: https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release [list of tags sorted by update time]: https://docs.gitlab.com/ee/api/tags.html#list-project-repository-tags @@ -55,7 +55,7 @@ _repository name_ automatically. If you wish to customize the name, set repo_name: mkdocs-ng/mkdocs-material ``` - [repo_name]: https://www.mkdocs.org/user-guide/configuration/#repo_name + [repo_name]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#repo_name #### Repository icon @@ -155,8 +155,8 @@ theme: [GitHub]: https://github.com/ [GitLab]: https://about.gitlab.com/ [Bitbucket]: https://bitbucket.org/ - [MkDocs]: https://www.mkdocs.org - [edit_uri]: https://www.mkdocs.org/user-guide/configuration/#edit_uri + [MkDocs]: https://mkdocs-ng.github.io/mkdocs + [edit_uri]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#edit_uri ### Revisioning @@ -322,7 +322,7 @@ by Material for MkDocs, which is why they may yield unexpected results. Use them at your own risk. [git-committers]: https://github.com/ojacques/mkdocs-git-committers-plugin-2 - [environment variable]: https://www.mkdocs.org/user-guide/configuration/#environment-variables + [environment variable]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#environment-variables [rate limits]: https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting #### Document authors diff --git a/docs/setup/building-an-optimized-site.md b/docs/setup/building-an-optimized-site.md index 3b133ee7fd..fa62dfb9e2 100644 --- a/docs/setup/building-an-optimized-site.md +++ b/docs/setup/building-an-optimized-site.md @@ -81,7 +81,7 @@ extra: - [Linking of content tabs, i.e. active tab] - [Color palette][color palette] - [Scope support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.0.0 + [Scope support]: https://github.com/mkdocs-ng/mkdocs-material/releases/tag/8.0.0 [cookie consent]: ../setup/ensuring-data-privacy.md#cookie-consent [Linking of content tabs, i.e. active tab]: ../reference/content-tabs.md [color palette]: ../setup/changing-the-colors.md#color-palette diff --git a/docs/setup/building-for-offline-usage.md b/docs/setup/building-for-offline-usage.md index 9ceacf071c..d4fca1f4dd 100644 --- a/docs/setup/building-for-offline-usage.md +++ b/docs/setup/building-for-offline-usage.md @@ -5,7 +5,7 @@ you covered – with support from themes, [MkDocs] supports building offline-capable documentation. Notably, Material for MkDocs offers offline support for many of its features. - [MkDocs]: https://www.mkdocs.org + [MkDocs]: https://mkdocs-ng.github.io/mkdocs ## Configuration @@ -35,7 +35,7 @@ For a list of all settings, please consult the [plugin documentation]. download all external assets to distribute them with your documentation. [site search]: setting-up-site-search.md - [site directory]: https://www.mkdocs.org/user-guide/configuration/#site_dir + [site directory]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#site_dir [built-in privacy plugin]:../plugins/privacy.md #### Limitations diff --git a/docs/setup/changing-the-language.md b/docs/setup/changing-the-language.md index ea470810b1..06e861e4b2 100644 --- a/docs/setup/changing-the-language.md +++ b/docs/setup/changing-the-language.md @@ -85,7 +85,7 @@ The following properties are available for each alternate language: [![Language selector preview]][Language selector preview] - [site_url]: https://www.mkdocs.org/user-guide/configuration/#site_url + [site_url]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#site_url [ISO 639-1 language code]: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes [Language selector preview]: ../assets/screenshots/language-selection.png diff --git a/docs/setup/changing-the-logo-and-icons.md b/docs/setup/changing-the-logo-and-icons.md index 85800359e3..f604bee130 100644 --- a/docs/setup/changing-the-logo-and-icons.md +++ b/docs/setup/changing-the-logo-and-icons.md @@ -103,7 +103,7 @@ The following is a complete list of customizable icons used by the theme: | `previous` | Previous page in footer, hide search on mobile | | `next` | Next page in footer | - [Site icon support]: https://github.com/squidfunk/mkdocs-material/releases/tag/9.2.0 + [Site icon support]: https://github.com/mkdocs-ng/mkdocs-material/releases/tag/9.2.0 ## Customization @@ -161,6 +161,6 @@ However, note that the syntaxes are slightly different: For further notes on icon usage, please consult the [icon reference]. [extend the theme]: ../customization.md#extending-the-theme - [custom_dir]: https://www.mkdocs.org/user-guide/configuration/#custom_dir + [custom_dir]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#custom_dir [Bootstrap]: https://icons.getbootstrap.com/ [icon reference]: ../reference/icons-emojis.md#using-icons diff --git a/docs/setup/extensions/python-markdown-extensions.md b/docs/setup/extensions/python-markdown-extensions.md index 97aa0980aa..e352e0bec8 100644 --- a/docs/setup/extensions/python-markdown-extensions.md +++ b/docs/setup/extensions/python-markdown-extensions.md @@ -740,7 +740,7 @@ See reference for usage: [Tabbed]: https://facelessuser.github.io/pymdown-extensions/extensions/tabbed/ [alternate style]: https://facelessuser.github.io/pymdown-extensions/extensions/tabbed/#alternate-style [combine_header_slug style]: https://facelessuser.github.io/pymdown-extensions/extensions/tabbed/#tab-ids - [better behavior on mobile viewports]: https://x.com/squidfunk/status/1424740370596958214 + [better behavior on mobile viewports]: https://x.com/mkdocs-ng/status/1424740370596958214 [Grouping code blocks]: ../../reference/content-tabs.md#grouping-code-blocks [Grouping other content]: ../../reference/content-tabs.md#grouping-other-content [Embedded content]: ../../reference/content-tabs.md#embedded-content diff --git a/docs/setup/extensions/python-markdown.md b/docs/setup/extensions/python-markdown.md index a724e2f25d..324032203e 100644 --- a/docs/setup/extensions/python-markdown.md +++ b/docs/setup/extensions/python-markdown.md @@ -342,6 +342,6 @@ Superseded by [Highlight]. Support for CodeHilite was dropped in essential extensions like [SuperFences] and [InlineHilite]. [CodeHilite]: https://python-markdown.github.io/extensions/code_hilite/ - [CodeHilite support]: https://github.com/squidfunk/mkdocs-material/releases/tag/0.1.0 + [CodeHilite support]: https://github.com/mkdocs-ng/mkdocs-material/releases/tag/0.1.0 [Highlight]: https://facelessuser.github.io/pymdown-extensions/extensions/highlight/ [InlineHilite]: https://facelessuser.github.io/pymdown-extensions/extensions/inlinehilite/ diff --git a/docs/setup/setting-up-a-blog.md b/docs/setup/setting-up-a-blog.md index 6c6d765130..11ff03d510 100644 --- a/docs/setup/setting-up-a-blog.md +++ b/docs/setup/setting-up-a-blog.md @@ -293,14 +293,14 @@ post with one or multiple [authors]. First, create the ``` yaml authors: - squidfunk: + mkdocs-ng: name: Martin Donath description: Creator - avatar: https://github.com/squidfunk.png + avatar: https://github.com/mkdocs-ng.png ``` The [`.authors.yml`][authors_file] file associates each author with an -identifier (in this example `squidfunk`), which can then be used in posts. +identifier (in this example `mkdocs-ng`), which can then be used in posts. Different attributes can be configured. For a list of all possible attributes, please consult the [`authors_file`][authors_file] documentation. @@ -313,7 +313,7 @@ each post, as well as in post excerpts on index pages: --- date: 2024-01-31 authors: - - squidfunk + - mkdocs-ng ... --- @@ -568,7 +568,7 @@ authors, and add a `.meta.yml` file to set common properties: ``` yaml authors: - - squidfunk + - mkdocs-ng categories: - Hello - World diff --git a/docs/setup/setting-up-navigation.md b/docs/setup/setting-up-navigation.md index ff8bf559f4..8a1243391d 100644 --- a/docs/setup/setting-up-navigation.md +++ b/docs/setup/setting-up-navigation.md @@ -431,7 +431,7 @@ nav: [Section index pages enabled]: ../assets/screenshots/navigation-index-on.png [Section index pages disabled]: ../assets/screenshots/navigation-index-off.png [toc.integrate]: #navigation-integration - [index pages]: https://www.mkdocs.org/user-guide/writing-your-docs/#index-pages + [index pages]: https://mkdocs-ng.github.io/mkdocs/user-guide/writing-your-docs/#index-pages ### Table of contents diff --git a/docs/setup/setting-up-social-cards.md b/docs/setup/setting-up-social-cards.md index ac9d38c1fe..0e210c6158 100644 --- a/docs/setup/setting-up-social-cards.md +++ b/docs/setup/setting-up-social-cards.md @@ -65,7 +65,7 @@ For a list of all settings, please consult the [plugin documentation]. ``` [dependencies for image processing]: ../plugins/requirements/image-processing.md - [site_url]: https://www.mkdocs.org/user-guide/configuration/#site_url + [site_url]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#site_url ## Usage @@ -438,8 +438,8 @@ descender.[^2] This renders: ![Layer typography] - [config variable]: https://www.mkdocs.org/dev-guide/themes/#config - [page variable]: https://www.mkdocs.org/dev-guide/themes/#page + [config variable]: https://mkdocs-ng.github.io/mkdocs/dev-guide/themes/#config + [page variable]: https://mkdocs-ng.github.io/mkdocs/dev-guide/themes/#page [Layer typography]: ../assets/screenshots/social-cards-layer-typography.png #### Overflow diff --git a/docs/setup/setting-up-the-footer.md b/docs/setup/setting-up-the-footer.md index 2d45ae41d8..4b404e4e26 100644 --- a/docs/setup/setting-up-the-footer.md +++ b/docs/setup/setting-up-the-footer.md @@ -35,7 +35,7 @@ with: extra: social: - icon: fontawesome/brands/mastodon # (1)! - link: https://fosstodon.org/@squidfunk + link: https://fosstodon.org/@mkdocs-ng ``` 1. Enter a few keywords to find the perfect icon using our [icon search] and @@ -82,7 +82,7 @@ The following properties are available for each link: extra: social: - icon: fontawesome/brands/mastodon - link: https://fosstodon.org/@squidfunk + link: https://fosstodon.org/@mkdocs-ng ``` === ":octicons-mail-16: Email" @@ -104,8 +104,8 @@ The following properties are available for each link: extra: social: - icon: fontawesome/brands/mastodon - link: https://fosstodon.org/@squidfunk - name: squidfunk on Fosstodon + link: https://fosstodon.org/@mkdocs-ng + name: mkdocs-ng on Fosstodon ``` [icon search]: ../reference/icons-emojis.md#search @@ -142,7 +142,7 @@ extra: The subtle __Made with Material for MkDocs__ hint in the footer is one of the reasons why this project is so popular, as it tells the user how the site is generated, helping new users to discover this project. Before - removing please consider that you're enjoying the benefits of @squidfunk's + removing please consider that you're enjoying the benefits of @mkdocs-ng's work for free, as this project is Open Source and has a permissive license. Thousands of hours went into this project, most of them without any financial return. diff --git a/docs/tutorials/blogs/basic.md b/docs/tutorials/blogs/basic.md index 507ff75ef1..0d77c8a050 100644 --- a/docs/tutorials/blogs/basic.md +++ b/docs/tutorials/blogs/basic.md @@ -43,7 +43,7 @@ navigation structure based on content. You can see all these elements on the [Material for MkDocs blog]. -[Material for MkDocs blog]: https://squidfunk.github.io/mkdocs-material/blog/ +[Material for MkDocs blog]: https://mkdocs-ng.github.io/mkdocs-material/blog/ ## Setting up your blog @@ -295,7 +295,7 @@ subsections: - Homepage: index.md - Blog index: blog/index.md - External links: - - Material documentation: https://squidfunk.github.io/mkdocs-material + - Material documentation: https://mkdocs-ng.github.io/mkdocs-material --- ``` diff --git a/docs/tutorials/blogs/engage.md b/docs/tutorials/blogs/engage.md index 90b4248711..7e37195958 100644 --- a/docs/tutorials/blogs/engage.md +++ b/docs/tutorials/blogs/engage.md @@ -95,8 +95,8 @@ necessary links and define the icons to use. extra: social: - icon: fontawesome/brands/mastodon - name: squidfunk on Mastodon - link: https://fosstodon.org/@squidfunk + name: mkdocs-ng on Mastodon + link: https://fosstodon.org/@mkdocs-ng ``` For the `icon`, you can choose any valid path to an icon bundled with the @@ -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://squidfunk.github.io/mkdocs-material/plugins/blog/ +[blog plugin reference]: https://mkdocs-ng.github.io/mkdocs-material/plugins/blog/ [social plugin tutorial]: ../social/basic.md diff --git a/docs/tutorials/blogs/navigation.md b/docs/tutorials/blogs/navigation.md index 9d870b8832..7528e1bdfa 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://squidfunk.github.io/mkdocs-material/plugins/tags/ +[Tags plugin]: https://mkdocs-ng.github.io/mkdocs-material/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 @@ -302,10 +302,10 @@ the page header. name: Team description: Creator avatar: https://simpleicons.org/icons/materialformkdocs.svg - squidfunk: + mkdocs-ng: name: Martin Donath description: Creator - avatar: https://github.com/squidfunk.png + avatar: https://github.com/mkdocs-ng.png ``` and then add a line to the header of the first post: diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md index cebccc2f2f..e4bcadf2ec 100644 --- a/docs/tutorials/index.md +++ b/docs/tutorials/index.md @@ -25,7 +25,7 @@ available as template repositories on GitHub. improvements that we can make through simple customization then we are happy to consider those. -[provide any feedback you might have in this discussion thread]: https://github.com/squidfunk/mkdocs-material/discussions/7220 +[provide any feedback you might have in this discussion thread]: https://github.com/mkdocs-ng/mkdocs-material/discussions/7220 ## Blogs * [Basics](blogs/basic.md) (20 min)
diff --git a/docs/tutorials/social/basic.md b/docs/tutorials/social/basic.md index 3b416b929c..40a709abea 100644 --- a/docs/tutorials/social/basic.md +++ b/docs/tutorials/social/basic.md @@ -10,7 +10,7 @@ Before you start, there are just a couple of [dependencies to install]. These are libraries for image processing that the plugin needs to produce the social cards, as well as their Python bindings. -[dependencies to install]: https://squidfunk.github.io/mkdocs-material/plugins/requirements/image-processing/ +[dependencies to install]: https://mkdocs-ng.github.io/mkdocs-material/plugins/requirements/image-processing/ With those prerequisites met, it is simply a matter of activating the plugin, which will: diff --git a/docs/upgrade.md b/docs/upgrade.md index 99c918a820..c55d69a41b 100644 --- a/docs/upgrade.md +++ b/docs/upgrade.md @@ -92,11 +92,11 @@ changes into your templates. A good starting point is to [inspect the diff]. - [`content.html`][content.html] - [`header.html`][header.html] - [inspect the diff]: https://github.com/squidfunk/mkdocs-material/pull/4628/files#diff-3ca112736b9164701b599f34780107abf14bb79fe110c478cac410be90899828 + [inspect the diff]: https://github.com/mkdocs-ng/mkdocs-material/pull/4628/files#diff-3ca112736b9164701b599f34780107abf14bb79fe110c478cac410be90899828 [MkDocs 1.4.1]: https://github.com/mkdocs/mkdocs/releases/tag/1.4.1 - [in config.plugins]: https://github.com/squidfunk/mkdocs-material/search?q=%22in+config.plugins%22 - [content.html]: https://github.com/squidfunk/mkdocs-material/blob/main/src/templates/partials/content.html - [header.html]: https://github.com/squidfunk/mkdocs-material/blob/main/src/templates/partials/header.html + [in config.plugins]: https://github.com/mkdocs-ng/mkdocs-material/search?q=%22in+config.plugins%22 + [content.html]: https://github.com/mkdocs-ng/mkdocs-material/blob/main/src/templates/partials/content.html + [header.html]: https://github.com/mkdocs-ng/mkdocs-material/blob/main/src/templates/partials/header.html ## Upgrading from 7.x to 8.x @@ -146,7 +146,7 @@ viewports]: ``` [Tabbed]: setup/extensions/python-markdown-extensions.md#tabbed - [better behavior on mobile viewports]: https://x.com/squidfunk/status/1424740370596958214 + [better behavior on mobile viewports]: https://x.com/mkdocs-ng/status/1424740370596958214 #### `pymdownx.superfences` @@ -203,7 +203,7 @@ The following lines must be changed: - auto ``` - [deprecated in MkDocs 1.2.0]: https://www.mkdocs.org/about/release-notes/#backward-incompatible-changes-in-12 + [deprecated in MkDocs 1.2.0]: https://mkdocs-ng.github.io/mkdocs/about/release-notes/#backward-incompatible-changes-in-12 ### Changes to `*.html` files { data-search-exclude } @@ -460,7 +460,7 @@ matches the new structure: + {% endif %} + {% if not config.extra.generator == false %} + Made with - + + + + Material for MkDocs + + {% endif %} @@ -482,7 +482,7 @@ matches the new structure: - {% endif %} - {% if not config.extra.generator == false %} - Made with - - + - - Material for MkDocs - - {% endif %} @@ -1230,7 +1230,7 @@ in order to match the new way of specifying which icon to be used: extra: social: - icon: fontawesome/brands/github-alt - link: https://github.com/squidfunk + link: https://github.com/mkdocs-ng ``` === "4.x" @@ -1239,7 +1239,7 @@ in order to match the new way of specifying which icon to be used: extra: social: - type: github - link: https://github.com/squidfunk + link: https://github.com/mkdocs-ng ``` ### Changes to `*.html` files { data-search-exclude } diff --git a/includes/mkdocs.md b/includes/mkdocs.md index 67f7491c06..db2574a00d 100644 --- a/includes/mkdocs.md +++ b/includes/mkdocs.md @@ -1,13 +1,13 @@ - [mkdocs]: https://www.mkdocs.org - [mkdocs.dotfiles]: https://www.mkdocs.org/dev-guide/themes/#dot-files - [mkdocs.metadata]: https://www.mkdocs.org/user-guide/writing-your-docs/#yaml-style-meta-data - [mkdocs.env]: https://www.mkdocs.org/user-guide/configuration/#environment-variables - [mkdocs.docs_dir]: https://www.mkdocs.org/user-guide/configuration/#docs_dir - [mkdocs.extra_templates]: https://www.mkdocs.org/user-guide/configuration/#extra_templates - [mkdocs.site_dir]: https://www.mkdocs.org/user-guide/configuration/#site_dir - [mkdocs.site_url]: https://www.mkdocs.org/user-guide/configuration/#site_url - [mkdocs.site_description]: https://www.mkdocs.org/user-guide/configuration/#site_description - [mkdocs.nav]: https://www.mkdocs.org/user-guide/configuration/#nav - [mkdocs.plugins]: https://www.mkdocs.org/user-guide/configuration/#plugins - [mkdocs.strict]: https://www.mkdocs.org/user-guide/configuration/#strict - [mkdocs.use_directory_urls]: https://www.mkdocs.org/user-guide/configuration/#use_directory_urls + [mkdocs]: https://mkdocs-ng.github.io/mkdocs/ + [mkdocs.dotfiles]: https://mkdocs-ng.github.io/mkdocs/dev-guide/themes/#dot-files + [mkdocs.metadata]: https://mkdocs-ng.github.io/mkdocs/user-guide/writing-your-docs/#yaml-style-meta-data + [mkdocs.env]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#environment-variables + [mkdocs.docs_dir]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#docs_dir + [mkdocs.extra_templates]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#extra_templates + [mkdocs.site_dir]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#site_dir + [mkdocs.site_url]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#site_url + [mkdocs.site_description]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#site_description + [mkdocs.nav]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#nav + [mkdocs.plugins]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#plugins + [mkdocs.strict]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#strict + [mkdocs.use_directory_urls]: https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#use_directory_urls diff --git a/material/overrides/assets/javascripts/custom.f46acd93.min.js b/material/overrides/assets/javascripts/custom.f46acd93.min.js index 88da14d1a4..3428d07c1d 100644 --- a/material/overrides/assets/javascripts/custom.f46acd93.min.js +++ b/material/overrides/assets/javascripts/custom.f46acd93.min.js @@ -1,5 +1,5 @@ "use strict";(()=>{var go=Object.create;var Ar=Object.defineProperty;var wo=Object.getOwnPropertyDescriptor;var So=Object.getOwnPropertyNames,et=Object.getOwnPropertySymbols,Eo=Object.getPrototypeOf,tt=Object.prototype.hasOwnProperty,Oo=Object.prototype.propertyIsEnumerable;var rt=(e,r,t)=>r in e?Ar(e,r,{enumerable:!0,configurable:!0,writable:!0,value:t}):e[r]=t,Je=(e,r)=>{for(var t in r||(r={}))tt.call(r,t)&&rt(e,t,r[t]);if(et)for(var t of et(r))Oo.call(r,t)&&rt(e,t,r[t]);return e};var Me=(e,r)=>()=>(r||e((r={exports:{}}).exports,r),r.exports);var To=(e,r,t,o)=>{if(r&&typeof r=="object"||typeof r=="function")for(let n of So(r))!tt.call(e,n)&&n!==t&&Ar(e,n,{get:()=>r[n],enumerable:!(o=wo(r,n))||o.enumerable});return e};var ot=(e,r,t)=>(t=e!=null?go(Eo(e)):{},To(r||!e||!e.__esModule?Ar(t,"default",{value:e,enumerable:!0}):t,e));var De=Me(Z=>{(function(){var e,r,t,o,n,i,f,u,c,a,s,p,d,l,m,h,b,w,E,k;k=150,a=20,E=150,c=.75,Z.score=function(v,x,S){var T,y,g,_;return y=S.preparedQuery,T=S.allowErrors,T||n(v,y.core_lw,y.core_up)?(_=v.toLowerCase(),g=r(v,_,y),Math.ceil(g)):0},Z.isMatch=n=function(v,x,S){var T,y,g,_,W,U,L;if(g=v.length,_=x.length,!g||_>g)return!1;for(T=-1,y=-1;++y<_;){for(W=x.charCodeAt(y),U=S.charCodeAt(y);++T-1)return m(v,x,de,te,fe,Q,N);for(Ae=new Array(Q),W=new Array(Q),_r=w(Q,N),V=Math.ceil(c*Q)+5,re=V,L=!0,M=-1;++Mce&&(ce=Ke),U=0,te[M]===Or)if(Tr=u(j,v,x),U=_>0?_:d(v,x,de,te,j,M,Tr),g=Er+p(j,M,Tr,y,U),g>ce)ce=g,re=V;else{if(ye&&--re<=0)return Math.max(ce,Ae[Q-1])*_r;ye=!1}Er=Ke,_=W[M],W[M]=U,Ae[M]=ce}}return ce=Ae[Q-1],ce*_r},Z.isWordStart=u=function(v,x,S){var T,y;return v===0?!0:(T=x[v],y=x[v-1],i(y)||T!==S[v]&&y===S[v-1])},Z.isWordEnd=f=function(v,x,S,T){var y,g;return v===T-1?!0:(y=x[v],g=x[v+1],i(g)||y===S[v]&&g!==S[v+1])},i=function(v){return v===" "||v==="."||v==="-"||v==="_"||v==="/"||v==="\\"},b=function(v){var x;return vy?T:y)+10):g+k*y},Z.scoreConsecutives=d=function(v,x,S,T,y,g,_){var W,U,L,j,M,N,V;for(U=v.length,j=S.length,L=U-y,M=j-g,W=L-1&&(M=u(L,v,x),M&&(y=L))),U=-1,j=0;++U1&&L>1))return t;for(y=0,V=0,re=0,M=0,_=-1,W=-1;++W-1){V++;continue}else break;for(;++_12*W)return!1;for(g=-1;++g<_;)if(u(g,v,x)&&++y>T)return!1;return!0}}).call(Z)});var wr=Me(Qe=>{(function(){var e,r,t,o,n,i,f,u,c,a;a=De(),i=a.isMatch,e=a.computeScore,u=a.scoreSize,c=20,t=2.5,Qe.score=function(s,p,d){var l,m,h,b;return m=d.preparedQuery,l=d.allowErrors,l||i(s,m.core_lw,m.core_up)?(b=s.toLowerCase(),h=e(s,b,m),h=f(s,b,h,d),Math.ceil(h)):0},f=function(s,p,d,l){var m,h,b,w,E,k,v,x,S,T;if(d===0)return 0;for(S=l.preparedQuery,T=l.useExtensionBonus,x=l.pathSeparator,E=s.length-1;s[E]===x;)E--;if(b=s.lastIndexOf(x,E),v=E-b,k=1,T&&(k+=n(p,S.ext,b,E,2),d*=k),b===-1)return d;for(w=S.depth;b>-1&&w-- >0;)b=s.lastIndexOf(x,b-1);return h=b===-1?d:k*e(s.slice(b+1,E+1),p.slice(b+1,E+1),S),m=.5*c/(c+r(s,E+1,x)),m*h+(1-m)*d*u(0,t*v)},Qe.countDir=r=function(s,p,d){var l,m;if(p<1)return 0;for(l=0,m=-1;++md)))return 0;for(w=p.length,h=l-E,h0?.9*n(s,p,d,E-2,m-1):b/h}}).call(Qe)});var Gr=Me((to,oo)=>{(function(){var e,r,t,o,n,i,f,u;u=wr(),t=u.countDir,n=u.getExtension,oo.exports=e=(function(){function c(a,s){var p,d,l;if(l=s!=null?s:{},p=l.optCharRegEx,d=l.pathSeparator,!(a&&a.length))return null;this.query=a,this.query_lw=a.toLowerCase(),this.core=r(a,p),this.core_lw=this.core.toLowerCase(),this.core_up=f(this.core),this.depth=t(a,a.length,d),this.ext=n(this.query_lw),this.charCodes=o(this.query_lw)}return c})(),i=/[ _\-:\/\\]/g,r=function(c,a){return a==null&&(a=i),c.replace(a,"")},f=function(c){var a,s,p,d;for(s="",p=0,d=c.length;p{(function(){var e,r,t,o,n;o=De(),r=wr(),e=Gr(),t=function(i){return i.candidate},n=function(i,f){return f.score-i.score},io.exports=function(i,f,u){var c,a,s,p,d,l,m,h,b,w,E,k,v;for(h=[],s=u.key,d=u.maxResults,p=u.maxInners,E=u.usePathScoring,b=p!=null&&p>0?p:i.length+1,c=s!=null,m=E?r:o,k=0,v=i.length;k0&&(h.push({candidate:a,score:l}),!--b))));k++);return h.sort(n),i=h.map(t),d!=null&&(i=i.slice(0,d)),i}}).call(no)});var fo=Me(Sr=>{(function(){var e,r,t,o,n,i,f,u,c,a;a=De(),t=a.isMatch,o=a.isWordStart,c=a.scoreConsecutives,u=a.scoreCharacter,f=a.scoreAcronyms,Sr.match=n=function(s,p,d){var l,m,h,b,w,E;return l=d.allowErrors,w=d.preparedQuery,b=d.pathSeparator,l||t(s,w.core_lw,w.core_up)?(E=s.toLowerCase(),h=r(s,E,w),h.length===0||s.indexOf(b)>-1&&(m=e(s,E,w,b),h=i(h,m)),h):[]},Sr.wrap=function(s,p,d){var l,m,h,b,w,E,k,v,x;if(d.wrap!=null&&(x=d.wrap,E=x.tagClass,v=x.tagOpen,k=x.tagClose),E==null&&(E="highlight"),v==null&&(v=''),k==null&&(k=""),s===p)return v+s+k;if(h=n(s,p,d),h.length===0)return s;for(b="",l=-1,w=0;++lw&&(b+=s.substring(w,m),w=m);++lw&&(b+=v,b+=s.substring(w,m),b+=k,w=m)}return w<=s.length-1&&(b+=s.substring(w)),b},e=function(s,p,d,l){var m,h,b;for(b=s.length-1;s[b]===l;)b--;if(m=s.lastIndexOf(l,b),m===-1)return[];for(h=d.depth;h-- >0;)if(m=s.lastIndexOf(l,m-1),m===-1)return[];return m++,b++,r(s.slice(m,b),p.slice(m,b),d,m)},i=function(s,p){var d,l,m,h,b,w,E;if(b=s.length,w=p.length,w===0)return s.slice();if(b===0)return p.slice();for(m=-1,h=0,l=p[h],E=[];++m0?x:c(s,p,M,N,y,g,te),k=re+u(y,g,te,E,T)),fe=Q[g],x=S[g],V>fe?U=h:(V=fe,U=w),k>V?(V=k,U=m):T=0,Q[g]=V,S[g]=T,ye[++j]=V>0?U:b;for(y=_-1,g=L-1,j=y*L+g,v=!0,W=[];v&&y>=0&&g>=0;)switch(ye[j]){case w:y--,j-=L;break;case h:g--,j--;break;case m:W.push(y+l),g--,y--,j-=L+1;break;default:v=!1}return W.reverse(),W}}).call(Sr)});var Br=Me((co,so)=>{(function(){var e,r,t,o,n,i,f,u;t=ao(),o=fo(),u=De(),i=wr(),e=Gr(),f=null,r=(typeof process!="undefined"&&process!==null?process.platform:void 0)==="win32"?"\\":"/",so.exports={filter:function(c,a,s){return s==null&&(s={}),a!=null&&a.length&&(c!=null&&c.length)?(s=n(s,a),t(c,a,s)):[]},score:function(c,a,s){return s==null&&(s={}),c!=null&&c.length&&(a!=null&&a.length)?(s=n(s,a),s.usePathScoring?i.score(c,a,s):u.score(c,a,s)):0},match:function(c,a,s){var p,d,l;return s==null&&(s={}),c?a?c===a?(function(){l=[];for(var m=0,h=c.length;0<=h?mh;0<=h?m++:m--)l.push(m);return l}).apply(this):(s=n(s,a),o.match(c,a,s)):[]:[]},wrap:function(c,a,s){return s==null&&(s={}),c?a?(s=n(s,a),o.wrap(c,a,s)):[]:[]},prepareQuery:function(c,a){return a==null&&(a={}),a=n(a,c),a.preparedQuery}},n=function(c,a){return c.allowErrors==null&&(c.allowErrors=!1),c.usePathScoring==null&&(c.usePathScoring=!0),c.useExtensionBonus==null&&(c.useExtensionBonus=!1),c.pathSeparator==null&&(c.pathSeparator=r),c.optCharRegEx==null&&(c.optCharRegEx=null),c.wrap==null&&(c.wrap=null),c.preparedQuery==null&&(c.preparedQuery=f&&f.query===a?f:f=new e(a,c)),c}}).call(co)});var Mr=function(e,r){return Mr=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(t,o){t.__proto__=o}||function(t,o){for(var n in o)Object.prototype.hasOwnProperty.call(o,n)&&(t[n]=o[n])},Mr(e,r)};function z(e,r){if(typeof r!="function"&&r!==null)throw new TypeError("Class extends value "+String(r)+" is not a constructor or null");Mr(e,r);function t(){this.constructor=e}e.prototype=r===null?Object.create(r):(t.prototype=r.prototype,new t)}function nt(e,r,t,o){function n(i){return i instanceof t?i:new t(function(f){f(i)})}return new(t||(t=Promise))(function(i,f){function u(s){try{a(o.next(s))}catch(p){f(p)}}function c(s){try{a(o.throw(s))}catch(p){f(p)}}function a(s){s.done?i(s.value):n(s.value).then(u,c)}a((o=o.apply(e,r||[])).next())})}function Ye(e,r){var t={label:0,sent:function(){if(i[0]&1)throw i[1];return i[1]},trys:[],ops:[]},o,n,i,f=Object.create((typeof Iterator=="function"?Iterator:Object).prototype);return f.next=u(0),f.throw=u(1),f.return=u(2),typeof Symbol=="function"&&(f[Symbol.iterator]=function(){return this}),f;function u(a){return function(s){return c([a,s])}}function c(a){if(o)throw new TypeError("Generator is already executing.");for(;f&&(f=0,a[0]&&(t=0)),t;)try{if(o=1,n&&(i=a[0]&2?n.return:a[0]?n.throw||((i=n.return)&&i.call(n),0):n.next)&&!(i=i.call(n,a[1])).done)return i;switch(n=0,i&&(a=[a[0]&2,i.value]),a[0]){case 0:case 1:i=a;break;case 4:return t.label++,{value:a[1],done:!1};case 5:t.label++,n=a[1],a=[0];continue;case 7:a=t.ops.pop(),t.trys.pop();continue;default:if(i=t.trys,!(i=i.length>0&&i[i.length-1])&&(a[0]===6||a[0]===2)){t=0;continue}if(a[0]===3&&(!i||a[1]>i[0]&&a[1]=e.length&&(e=void 0),{value:e&&e[o++],done:!e}}};throw new TypeError(r?"Object is not iterable.":"Symbol.iterator is not defined.")}function R(e,r){var t=typeof Symbol=="function"&&e[Symbol.iterator];if(!t)return e;var o=t.call(e),n,i=[],f;try{for(;(r===void 0||r-- >0)&&!(n=o.next()).done;)i.push(n.value)}catch(u){f={error:u}}finally{try{n&&!n.done&&(t=o.return)&&t.call(o)}finally{if(f)throw f.error}}return i}function H(e,r,t){if(t||arguments.length===2)for(var o=0,n=r.length,i;o1||c(l,h)})},m&&(n[l]=m(n[l])))}function c(l,m){try{a(o[l](m))}catch(h){d(i[0][3],h)}}function a(l){l.value instanceof ge?Promise.resolve(l.value.v).then(s,p):d(i[0][2],l)}function s(l){c("next",l)}function p(l){c("throw",l)}function d(l,m){l(m),i.shift(),i.length&&c(i[0][0],i[0][1])}}function at(e){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var r=e[Symbol.asyncIterator],t;return r?r.call(e):(e=typeof X=="function"?X(e):e[Symbol.iterator](),t={},o("next"),o("throw"),o("return"),t[Symbol.asyncIterator]=function(){return this},t);function o(i){t[i]=e[i]&&function(f){return new Promise(function(u,c){f=e[i](f),n(u,c,f.done,f.value)})}}function n(i,f,u,c){Promise.resolve(c).then(function(a){i({value:a,done:u})},f)}}function O(e){return typeof e=="function"}function Xe(e){var r=function(o){Error.call(o),o.stack=new Error().stack},t=e(r);return t.prototype=Object.create(Error.prototype),t.prototype.constructor=t,t}var Ge=Xe(function(e){return function(t){e(this),this.message=t?t.length+` errors occurred during unsubscription: `+t.map(function(o,n){return n+1+") "+o.toString()}).join(` - `):"",this.name="UnsubscriptionError",this.errors=t}});function se(e,r){if(e){var t=e.indexOf(r);0<=t&&e.splice(t,1)}}var oe=(function(){function e(r){this.initialTeardown=r,this.closed=!1,this._parentage=null,this._finalizers=null}return e.prototype.unsubscribe=function(){var r,t,o,n,i;if(!this.closed){this.closed=!0;var f=this._parentage;if(f)if(this._parentage=null,Array.isArray(f))try{for(var u=X(f),c=u.next();!c.done;c=u.next()){var a=c.value;a.remove(this)}}catch(h){r={error:h}}finally{try{c&&!c.done&&(t=u.return)&&t.call(u)}finally{if(r)throw r.error}}else f.remove(this);var s=this.initialTeardown;if(O(s))try{s()}catch(h){i=h instanceof Ge?h.errors:[h]}var p=this._finalizers;if(p){this._finalizers=null;try{for(var d=X(p),l=d.next();!l.done;l=d.next()){var m=l.value;try{ft(m)}catch(h){i=i!=null?i:[],h instanceof Ge?i=H(H([],R(i)),R(h.errors)):i.push(h)}}}catch(h){o={error:h}}finally{try{l&&!l.done&&(n=d.return)&&n.call(d)}finally{if(o)throw o.error}}}if(i)throw new Ge(i)}},e.prototype.add=function(r){var t;if(r&&r!==this)if(this.closed)ft(r);else{if(r instanceof e){if(r.closed||r._hasParent(this))return;r._addParent(this)}(this._finalizers=(t=this._finalizers)!==null&&t!==void 0?t:[]).push(r)}},e.prototype._hasParent=function(r){var t=this._parentage;return t===r||Array.isArray(t)&&t.includes(r)},e.prototype._addParent=function(r){var t=this._parentage;this._parentage=Array.isArray(t)?(t.push(r),t):t?[t,r]:r},e.prototype._removeParent=function(r){var t=this._parentage;t===r?this._parentage=null:Array.isArray(t)&&se(t,r)},e.prototype.remove=function(r){var t=this._finalizers;t&&se(t,r),r instanceof e&&r._removeParent(this)},e.EMPTY=(function(){var r=new e;return r.closed=!0,r})(),e})();var Ir=oe.EMPTY;function Be(e){return e instanceof oe||e&&"closed"in e&&O(e.remove)&&O(e.add)&&O(e.unsubscribe)}function ft(e){O(e)?e():e.unsubscribe()}var ee={onUnhandledError:null,onStoppedNotification:null,Promise:void 0,useDeprecatedSynchronousErrorHandling:!1,useDeprecatedNextContext:!1};var Ie={setTimeout:function(e,r){for(var t=[],o=2;o0},enumerable:!1,configurable:!0}),r.prototype._trySubscribe=function(t){return this._throwIfClosed(),e.prototype._trySubscribe.call(this,t)},r.prototype._subscribe=function(t){return this._throwIfClosed(),this._checkFinalizedStatuses(t),this._innerSubscribe(t)},r.prototype._innerSubscribe=function(t){var o=this,n=this,i=n.hasError,f=n.isStopped,u=n.observers;return i||f?Ir:(this.currentObservers=null,u.push(t),new oe(function(){o.currentObservers=null,se(u,t)}))},r.prototype._checkFinalizedStatuses=function(t){var o=this,n=o.hasError,i=o.thrownError,f=o.isStopped;n?t.error(i):f&&t.complete()},r.prototype.asObservable=function(){var t=new I;return t.source=this,t},r.create=function(t,o){return new dt(t,o)},r})(I);var dt=(function(e){z(r,e);function r(t,o){var n=e.call(this)||this;return n.destination=t,n.source=o,n}return r.prototype.next=function(t){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.next)===null||n===void 0||n.call(o,t)},r.prototype.error=function(t){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.error)===null||n===void 0||n.call(o,t)},r.prototype.complete=function(){var t,o;(o=(t=this.destination)===null||t===void 0?void 0:t.complete)===null||o===void 0||o.call(t)},r.prototype._subscribe=function(t){var o,n;return(n=(o=this.source)===null||o===void 0?void 0:o.subscribe(t))!==null&&n!==void 0?n:Ir},r})(K);var kr=(function(e){z(r,e);function r(t){var o=e.call(this)||this;return o._value=t,o}return Object.defineProperty(r.prototype,"value",{get:function(){return this.getValue()},enumerable:!1,configurable:!0}),r.prototype._subscribe=function(t){var o=e.prototype._subscribe.call(this,t);return!o.closed&&t.next(this._value),o},r.prototype.getValue=function(){var t=this,o=t.hasError,n=t.thrownError,i=t._value;if(o)throw n;return this._throwIfClosed(),i},r.prototype.next=function(t){e.prototype.next.call(this,this._value=t)},r})(K);var ze={now:function(){return(ze.delegate||Date).now()},delegate:void 0};var vt=(function(e){z(r,e);function r(t,o,n){t===void 0&&(t=1/0),o===void 0&&(o=1/0),n===void 0&&(n=ze);var i=e.call(this)||this;return i._bufferSize=t,i._windowTime=o,i._timestampProvider=n,i._buffer=[],i._infiniteTimeWindow=!0,i._infiniteTimeWindow=o===1/0,i._bufferSize=Math.max(1,t),i._windowTime=Math.max(1,o),i}return r.prototype.next=function(t){var o=this,n=o.isStopped,i=o._buffer,f=o._infiniteTimeWindow,u=o._timestampProvider,c=o._windowTime;n||(i.push(t),!f&&i.push(u.now()+c)),this._trimBuffer(),e.prototype.next.call(this,t)},r.prototype._subscribe=function(t){this._throwIfClosed(),this._trimBuffer();for(var o=this._innerSubscribe(t),n=this,i=n._infiniteTimeWindow,f=n._buffer,u=f.slice(),c=0;c0?e.prototype.requestAsyncId.call(this,t,o,n):(t.actions.push(this),t._scheduled||(t._scheduled=Pe.requestAnimationFrame(function(){return t.flush(void 0)})))},r.prototype.recycleAsyncId=function(t,o,n){var i;if(n===void 0&&(n=0),n!=null?n>0:this.delay>0)return e.prototype.recycleAsyncId.call(this,t,o,n);var f=t.actions;o!=null&&o===t._scheduled&&((i=f[f.length-1])===null||i===void 0?void 0:i.id)!==o&&(Pe.cancelAnimationFrame(o),t._scheduled=void 0)},r})(rr);var gt=(function(e){z(r,e);function r(){return e!==null&&e.apply(this,arguments)||this}return r.prototype.flush=function(t){this._active=!0;var o;t?o=t.id:(o=this._scheduled,this._scheduled=void 0);var n=this.actions,i;t=t||n.shift();do if(i=t.execute(t.state,t.delay))break;while((t=n[0])&&t.id===o&&n.shift());if(this._active=!1,i){for(;(t=n[0])&&t.id===o&&n.shift();)t.unsubscribe();throw i}},r})(tr);var Fr=new gt(yt);var Re=new I(function(e){return e.complete()});function or(e){return e&&O(e.schedule)}function Wr(e){return e[e.length-1]}function ve(e){return O(Wr(e))?e.pop():void 0}function ne(e){return or(Wr(e))?e.pop():void 0}function wt(e,r){return typeof Wr(e)=="number"?e.pop():r}var ke=(function(e){return e&&typeof e.length=="number"&&typeof e!="function"});function nr(e){return O(e==null?void 0:e.then)}function ir(e){return O(e[Le])}function ar(e){return Symbol.asyncIterator&&O(e==null?void 0:e[Symbol.asyncIterator])}function fr(e){return new TypeError("You provided "+(e!==null&&typeof e=="object"?"an invalid object":"'"+e+"'")+" where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.")}function ko(){return typeof Symbol!="function"||!Symbol.iterator?"@@iterator":Symbol.iterator}var cr=ko();function sr(e){return O(e==null?void 0:e[cr])}function ur(e){return it(this,arguments,function(){var t,o,n,i;return Ye(this,function(f){switch(f.label){case 0:t=e.getReader(),f.label=1;case 1:f.trys.push([1,,9,10]),f.label=2;case 2:return[4,ge(t.read())];case 3:return o=f.sent(),n=o.value,i=o.done,i?[4,ge(void 0)]:[3,5];case 4:return[2,f.sent()];case 5:return[4,ge(n)];case 6:return[4,f.sent()];case 7:return f.sent(),[3,2];case 8:return[3,10];case 9:return t.releaseLock(),[7];case 10:return[2]}})})}function pr(e){return O(e==null?void 0:e.getReader)}function F(e){if(e instanceof I)return e;if(e!=null){if(ir(e))return Ho(e);if(ke(e))return Fo(e);if(nr(e))return Wo(e);if(ar(e))return St(e);if(sr(e))return jo(e);if(pr(e))return Uo(e)}throw fr(e)}function Ho(e){return new I(function(r){var t=e[Le]();if(O(t.subscribe))return t.subscribe(r);throw new TypeError("Provided object does not correctly implement Symbol.observable")})}function Fo(e){return new I(function(r){for(var t=0;t0&&(s=new Se({next:function(S){return x.next(S)},error:function(S){h=!0,b(),p=Kr(w,n,S),x.error(S)},complete:function(){m=!0,b(),p=Kr(w,f),x.complete()}}),F(k).subscribe(s))})(a)}}function Kr(e,r){for(var t=[],o=2;oYr()||document.body),me(1));function Nt(e){return tn.pipe(C(r=>e.contains(r)),pe())}function qt(e,r){if(typeof r=="string"||typeof r=="number")e.innerHTML+=r.toString();else if(r instanceof Node)e.appendChild(r);else if(Array.isArray(r))for(let t of r)qt(e,t)}function Y(e,r,...t){let o=document.createElement(e);if(r)for(let n of Object.keys(r))typeof r[n]!="undefined"&&(typeof r[n]!="boolean"?o.setAttribute(n,r[n]):o.setAttribute(n,""));for(let n of t)qt(o,n);return o}function Dt(e){if(e>999){let r=+((e-950)%1e3>99);return`${((e+1e-6)/1e3).toFixed(r)}k`}else return e.toString()}function Qt(e){let r=Y("script",{src:e});return Te(()=>(document.head.appendChild(r),q($(r,"load"),$(r,"error").pipe(D(()=>jr(()=>new ReferenceError(`Invalid script: ${e}`))))).pipe(C(()=>{}),le(()=>document.head.removeChild(r)),We(1))))}var on=new K,jp=Te(()=>typeof ResizeObserver=="undefined"?Qt("https://unpkg.com/resize-observer-polyfill"):ie(void 0)).pipe(C(()=>new ResizeObserver(e=>e.forEach(r=>on.next(r)))),D(e=>q(Ne,ie(e)).pipe(le(()=>e.disconnect()))),me(1));function Kt(e){return{width:e.offsetWidth,height:e.offsetHeight}}function Jt(e){return{width:e.scrollWidth,height:e.scrollHeight}}function Yt(e){return{x:e.scrollLeft,y:e.scrollTop}}function Xt(e){return q($(e,"scroll"),$(window,"scroll"),$(window,"resize")).pipe(zr(0,Fr),C(()=>Yt(e)),be(Yt(e)))}var nn=new K,tl=Te(()=>ie(new IntersectionObserver(e=>{for(let r of e)nn.next(r)},{threshold:0}))).pipe(D(e=>q(Ne,ie(e)).pipe(le(()=>e.disconnect()))),me(1));function Gt(e,r=16){return Xt(e).pipe(C(({y:t})=>{let o=Kt(e),n=Jt(e);return t>=n.height-o.height-r}),pe())}var ll={drawer:ae("[data-md-toggle=drawer]"),search:ae("[data-md-toggle=search]")};var an=ae("#__config"),qe=JSON.parse(an.textContent);qe.base=`${new URL(qe.base,eo())}`;function Bt(){return qe}function Zt(e,r){return typeof r!="undefined"?qe.translations[e].replace("#",r.toString()):qe.translations[e]}function eo(){return new URL(location.href)}function fn(e,r){return new I(t=>{let o=new XMLHttpRequest;return o.open("GET",`${e}`),o.responseType="blob",o.addEventListener("load",()=>{o.status>=200&&o.status<300?(t.next(o.response),t.complete()):t.error(new Error(o.statusText))}),o.addEventListener("error",()=>{t.error(new Error("Network error"))}),o.addEventListener("abort",()=>{t.complete()}),typeof(r==null?void 0:r.progress$)!="undefined"&&(o.addEventListener("progress",n=>{var i;if(n.lengthComputable)r.progress$.next(n.loaded/n.total*100);else{let f=(i=o.getResponseHeader("Content-Length"))!=null?i:0;r.progress$.next(n.loaded/+f*100)}}),r.progress$.next(5)),o.send(),()=>o.abort()})}function gr(e,r){return fn(e,r).pipe(D(t=>t.text()),C(t=>JSON.parse(t)),me(1))}function Xr(e,r=document){return ae(`[data-mdx-component=${e}]`,r)}function xe(e,r=document){return $t(`[data-mdx-component=${e}]`,r)}function ro(e){let r=Nt(e),t=q($(e,"keyup"),$(e,"focus").pipe(Qr(1))).pipe(C(()=>e.value),be(e.value),pe());return r.pipe(_e(o=>!o),je(t)).subscribe(([,o])=>{let n=document.location.pathname;typeof ga=="function"&&o.length&&ga("send","pageview",`${n}?q=[icon]+${o}`)}),Fe([t,r]).pipe(C(([o,n])=>({ref:e,value:o,focus:n})))}var Zr=ot(Br());var po=ot(Br());function uo(e,r){return(0,po.wrap)(e.shortcode,r,{wrap:{tagOpen:"",tagClose:""}})}function lo(e,r,t){return Y("li",{class:"mdx-iconsearch-result__item"},Y("span",{class:"twemoji"},Y("img",{src:e.url})),Y("button",{class:"md-clipboard--inline",title:Zt("clipboard.copy"),"data-clipboard-text":t?e.shortcode:`:${e.shortcode}:`},Y("code",null,t?uo(e,r):`:${uo(e,r)}:`)))}function mo(e){let r=`@${e.name}`;return Y("a",{href:e.url,title:r,class:"mdx-sponsorship__item"},Y("img",{src:e.image}))}function ho(e){return Y("a",{href:"https://github.com/sponsors/squidfunk?metadata_origin=docs",class:"mdx-sponsorship__item mdx-sponsorship__item--private"},"+",e)}function cn(e,{index$:r,query$:t,mode$:o}){return e.getAttribute("data-mdx-mode")==="file"?Fe([t.pipe(xr("value")),r.pipe(C(({icons:n})=>Object.values(n.data).map(i=>i.replace(/\.svg$/,""))))]).pipe(C(([{value:n},i])=>(0,Zr.filter)(i,n)),D(n=>r.pipe(C(({icons:i})=>({data:n.map(f=>({shortcode:f,url:[i.base,f,".svg"].join("")}))}))))):Fe([t.pipe(xr("value")),r.pipe(Nr(o),C(([{icons:n,emojis:i},f])=>[...["all","icons"].includes(f)?Object.keys(n.data):[],...["all","emojis"].includes(f)?Object.keys(i.data):[]]))]).pipe(C(([{value:n},i])=>(0,Zr.filter)(i,n)),D(n=>r.pipe(C(({icons:i,emojis:f})=>({data:n.map(u=>{let c=u in i.data?i:f;return{shortcode:u,url:[c.base,c.data[u]].join("")}})})))))}function vo(e,{index$:r,query$:t,mode$:o}){let n=new K,i=Gt(e).pipe(_e(Boolean)),f=ae(".mdx-iconsearch-result__meta",e);n.pipe(je(t)).subscribe(([{data:a},{value:s}])=>{if(s)switch(a.length){case 0:f.textContent="No matches";break;case 1:f.textContent="1 match";break;default:f.textContent=`${Dt(a.length)} matches`}else f.textContent="Type to start searching"});let u=e.getAttribute("data-mdx-mode")==="file",c=ae(":scope > :last-child",e);return n.pipe(he(()=>c.innerHTML=""),D(({data:a})=>q(ie(...a.slice(0,10)),ie(...a.slice(10)).pipe(Vr(10),Jr(i),D(([s])=>s)))),je(t)).subscribe(([a,{value:s}])=>c.appendChild(lo(a,s,u))),cn(e,{query$:t,index$:r,mode$:o}).pipe(he(a=>n.next(a)),le(()=>n.complete()),C(a=>Je({ref:e},a)))}function bo(e){let r=Bt(),t=gr(new URL("assets/javascripts/iconsearch_index.json",r.base)),o=Xr("iconsearch-query",e),n=Xr("iconsearch-result",e),i=new kr("all"),f=xe("iconsearch-select",e);for(let a of f)$(a,"change").pipe(C(s=>s.target.value)).subscribe(i);let u=ro(o),c=vo(n,{index$:t,query$:u,mode$:i});return q(u,c)}function xo(e){let r=gr("https://3if8u9o552.execute-api.us-east-1.amazonaws.com/_/"),t=xe("sponsorship-count"),o=xe("sponsorship-total");r.pipe(D(i=>B(t).pipe(he(f=>f.innerText=`${i.sponsors.length}`)))).subscribe(()=>e.removeAttribute("hidden")),r.pipe(D(i=>B(o).pipe(he(f=>f.innerText=`$ ${i.total.toString().replace(/\B(?=(\d{3})+(?!\d))/g,",")} a month`)))).subscribe();let n=yr(":scope > .mdx-sponsorship__list",e);return n&&t.length&&r.subscribe(i=>{for(let f of i.sponsors)f.type==="public"&&n.appendChild(mo(f.user));n.appendChild(ho(i.sponsors.filter(({type:f})=>f==="private").length))}),r.pipe(C(i=>Je({ref:e},i)))}function yo(){let{origin:e}=new URL(location.href);$(document.body,"click").subscribe(r=>{if(r.target instanceof HTMLElement){let t=r.target.closest("a");t&&t.origin!==e&&ga("send","event","outbound","click",t.href)}})}yo();var sn=document$.pipe(D(()=>q(...xe("iconsearch").map(e=>bo(e)),...xe("sponsorship").map(e=>xo(e)))));sn.subscribe();})(); + `):"",this.name="UnsubscriptionError",this.errors=t}});function se(e,r){if(e){var t=e.indexOf(r);0<=t&&e.splice(t,1)}}var oe=(function(){function e(r){this.initialTeardown=r,this.closed=!1,this._parentage=null,this._finalizers=null}return e.prototype.unsubscribe=function(){var r,t,o,n,i;if(!this.closed){this.closed=!0;var f=this._parentage;if(f)if(this._parentage=null,Array.isArray(f))try{for(var u=X(f),c=u.next();!c.done;c=u.next()){var a=c.value;a.remove(this)}}catch(h){r={error:h}}finally{try{c&&!c.done&&(t=u.return)&&t.call(u)}finally{if(r)throw r.error}}else f.remove(this);var s=this.initialTeardown;if(O(s))try{s()}catch(h){i=h instanceof Ge?h.errors:[h]}var p=this._finalizers;if(p){this._finalizers=null;try{for(var d=X(p),l=d.next();!l.done;l=d.next()){var m=l.value;try{ft(m)}catch(h){i=i!=null?i:[],h instanceof Ge?i=H(H([],R(i)),R(h.errors)):i.push(h)}}}catch(h){o={error:h}}finally{try{l&&!l.done&&(n=d.return)&&n.call(d)}finally{if(o)throw o.error}}}if(i)throw new Ge(i)}},e.prototype.add=function(r){var t;if(r&&r!==this)if(this.closed)ft(r);else{if(r instanceof e){if(r.closed||r._hasParent(this))return;r._addParent(this)}(this._finalizers=(t=this._finalizers)!==null&&t!==void 0?t:[]).push(r)}},e.prototype._hasParent=function(r){var t=this._parentage;return t===r||Array.isArray(t)&&t.includes(r)},e.prototype._addParent=function(r){var t=this._parentage;this._parentage=Array.isArray(t)?(t.push(r),t):t?[t,r]:r},e.prototype._removeParent=function(r){var t=this._parentage;t===r?this._parentage=null:Array.isArray(t)&&se(t,r)},e.prototype.remove=function(r){var t=this._finalizers;t&&se(t,r),r instanceof e&&r._removeParent(this)},e.EMPTY=(function(){var r=new e;return r.closed=!0,r})(),e})();var Ir=oe.EMPTY;function Be(e){return e instanceof oe||e&&"closed"in e&&O(e.remove)&&O(e.add)&&O(e.unsubscribe)}function ft(e){O(e)?e():e.unsubscribe()}var ee={onUnhandledError:null,onStoppedNotification:null,Promise:void 0,useDeprecatedSynchronousErrorHandling:!1,useDeprecatedNextContext:!1};var Ie={setTimeout:function(e,r){for(var t=[],o=2;o0},enumerable:!1,configurable:!0}),r.prototype._trySubscribe=function(t){return this._throwIfClosed(),e.prototype._trySubscribe.call(this,t)},r.prototype._subscribe=function(t){return this._throwIfClosed(),this._checkFinalizedStatuses(t),this._innerSubscribe(t)},r.prototype._innerSubscribe=function(t){var o=this,n=this,i=n.hasError,f=n.isStopped,u=n.observers;return i||f?Ir:(this.currentObservers=null,u.push(t),new oe(function(){o.currentObservers=null,se(u,t)}))},r.prototype._checkFinalizedStatuses=function(t){var o=this,n=o.hasError,i=o.thrownError,f=o.isStopped;n?t.error(i):f&&t.complete()},r.prototype.asObservable=function(){var t=new I;return t.source=this,t},r.create=function(t,o){return new dt(t,o)},r})(I);var dt=(function(e){z(r,e);function r(t,o){var n=e.call(this)||this;return n.destination=t,n.source=o,n}return r.prototype.next=function(t){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.next)===null||n===void 0||n.call(o,t)},r.prototype.error=function(t){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.error)===null||n===void 0||n.call(o,t)},r.prototype.complete=function(){var t,o;(o=(t=this.destination)===null||t===void 0?void 0:t.complete)===null||o===void 0||o.call(t)},r.prototype._subscribe=function(t){var o,n;return(n=(o=this.source)===null||o===void 0?void 0:o.subscribe(t))!==null&&n!==void 0?n:Ir},r})(K);var kr=(function(e){z(r,e);function r(t){var o=e.call(this)||this;return o._value=t,o}return Object.defineProperty(r.prototype,"value",{get:function(){return this.getValue()},enumerable:!1,configurable:!0}),r.prototype._subscribe=function(t){var o=e.prototype._subscribe.call(this,t);return!o.closed&&t.next(this._value),o},r.prototype.getValue=function(){var t=this,o=t.hasError,n=t.thrownError,i=t._value;if(o)throw n;return this._throwIfClosed(),i},r.prototype.next=function(t){e.prototype.next.call(this,this._value=t)},r})(K);var ze={now:function(){return(ze.delegate||Date).now()},delegate:void 0};var vt=(function(e){z(r,e);function r(t,o,n){t===void 0&&(t=1/0),o===void 0&&(o=1/0),n===void 0&&(n=ze);var i=e.call(this)||this;return i._bufferSize=t,i._windowTime=o,i._timestampProvider=n,i._buffer=[],i._infiniteTimeWindow=!0,i._infiniteTimeWindow=o===1/0,i._bufferSize=Math.max(1,t),i._windowTime=Math.max(1,o),i}return r.prototype.next=function(t){var o=this,n=o.isStopped,i=o._buffer,f=o._infiniteTimeWindow,u=o._timestampProvider,c=o._windowTime;n||(i.push(t),!f&&i.push(u.now()+c)),this._trimBuffer(),e.prototype.next.call(this,t)},r.prototype._subscribe=function(t){this._throwIfClosed(),this._trimBuffer();for(var o=this._innerSubscribe(t),n=this,i=n._infiniteTimeWindow,f=n._buffer,u=f.slice(),c=0;c0?e.prototype.requestAsyncId.call(this,t,o,n):(t.actions.push(this),t._scheduled||(t._scheduled=Pe.requestAnimationFrame(function(){return t.flush(void 0)})))},r.prototype.recycleAsyncId=function(t,o,n){var i;if(n===void 0&&(n=0),n!=null?n>0:this.delay>0)return e.prototype.recycleAsyncId.call(this,t,o,n);var f=t.actions;o!=null&&o===t._scheduled&&((i=f[f.length-1])===null||i===void 0?void 0:i.id)!==o&&(Pe.cancelAnimationFrame(o),t._scheduled=void 0)},r})(rr);var gt=(function(e){z(r,e);function r(){return e!==null&&e.apply(this,arguments)||this}return r.prototype.flush=function(t){this._active=!0;var o;t?o=t.id:(o=this._scheduled,this._scheduled=void 0);var n=this.actions,i;t=t||n.shift();do if(i=t.execute(t.state,t.delay))break;while((t=n[0])&&t.id===o&&n.shift());if(this._active=!1,i){for(;(t=n[0])&&t.id===o&&n.shift();)t.unsubscribe();throw i}},r})(tr);var Fr=new gt(yt);var Re=new I(function(e){return e.complete()});function or(e){return e&&O(e.schedule)}function Wr(e){return e[e.length-1]}function ve(e){return O(Wr(e))?e.pop():void 0}function ne(e){return or(Wr(e))?e.pop():void 0}function wt(e,r){return typeof Wr(e)=="number"?e.pop():r}var ke=(function(e){return e&&typeof e.length=="number"&&typeof e!="function"});function nr(e){return O(e==null?void 0:e.then)}function ir(e){return O(e[Le])}function ar(e){return Symbol.asyncIterator&&O(e==null?void 0:e[Symbol.asyncIterator])}function fr(e){return new TypeError("You provided "+(e!==null&&typeof e=="object"?"an invalid object":"'"+e+"'")+" where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.")}function ko(){return typeof Symbol!="function"||!Symbol.iterator?"@@iterator":Symbol.iterator}var cr=ko();function sr(e){return O(e==null?void 0:e[cr])}function ur(e){return it(this,arguments,function(){var t,o,n,i;return Ye(this,function(f){switch(f.label){case 0:t=e.getReader(),f.label=1;case 1:f.trys.push([1,,9,10]),f.label=2;case 2:return[4,ge(t.read())];case 3:return o=f.sent(),n=o.value,i=o.done,i?[4,ge(void 0)]:[3,5];case 4:return[2,f.sent()];case 5:return[4,ge(n)];case 6:return[4,f.sent()];case 7:return f.sent(),[3,2];case 8:return[3,10];case 9:return t.releaseLock(),[7];case 10:return[2]}})})}function pr(e){return O(e==null?void 0:e.getReader)}function F(e){if(e instanceof I)return e;if(e!=null){if(ir(e))return Ho(e);if(ke(e))return Fo(e);if(nr(e))return Wo(e);if(ar(e))return St(e);if(sr(e))return jo(e);if(pr(e))return Uo(e)}throw fr(e)}function Ho(e){return new I(function(r){var t=e[Le]();if(O(t.subscribe))return t.subscribe(r);throw new TypeError("Provided object does not correctly implement Symbol.observable")})}function Fo(e){return new I(function(r){for(var t=0;t0&&(s=new Se({next:function(S){return x.next(S)},error:function(S){h=!0,b(),p=Kr(w,n,S),x.error(S)},complete:function(){m=!0,b(),p=Kr(w,f),x.complete()}}),F(k).subscribe(s))})(a)}}function Kr(e,r){for(var t=[],o=2;oYr()||document.body),me(1));function Nt(e){return tn.pipe(C(r=>e.contains(r)),pe())}function qt(e,r){if(typeof r=="string"||typeof r=="number")e.innerHTML+=r.toString();else if(r instanceof Node)e.appendChild(r);else if(Array.isArray(r))for(let t of r)qt(e,t)}function Y(e,r,...t){let o=document.createElement(e);if(r)for(let n of Object.keys(r))typeof r[n]!="undefined"&&(typeof r[n]!="boolean"?o.setAttribute(n,r[n]):o.setAttribute(n,""));for(let n of t)qt(o,n);return o}function Dt(e){if(e>999){let r=+((e-950)%1e3>99);return`${((e+1e-6)/1e3).toFixed(r)}k`}else return e.toString()}function Qt(e){let r=Y("script",{src:e});return Te(()=>(document.head.appendChild(r),q($(r,"load"),$(r,"error").pipe(D(()=>jr(()=>new ReferenceError(`Invalid script: ${e}`))))).pipe(C(()=>{}),le(()=>document.head.removeChild(r)),We(1))))}var on=new K,jp=Te(()=>typeof ResizeObserver=="undefined"?Qt("https://unpkg.com/resize-observer-polyfill"):ie(void 0)).pipe(C(()=>new ResizeObserver(e=>e.forEach(r=>on.next(r)))),D(e=>q(Ne,ie(e)).pipe(le(()=>e.disconnect()))),me(1));function Kt(e){return{width:e.offsetWidth,height:e.offsetHeight}}function Jt(e){return{width:e.scrollWidth,height:e.scrollHeight}}function Yt(e){return{x:e.scrollLeft,y:e.scrollTop}}function Xt(e){return q($(e,"scroll"),$(window,"scroll"),$(window,"resize")).pipe(zr(0,Fr),C(()=>Yt(e)),be(Yt(e)))}var nn=new K,tl=Te(()=>ie(new IntersectionObserver(e=>{for(let r of e)nn.next(r)},{threshold:0}))).pipe(D(e=>q(Ne,ie(e)).pipe(le(()=>e.disconnect()))),me(1));function Gt(e,r=16){return Xt(e).pipe(C(({y:t})=>{let o=Kt(e),n=Jt(e);return t>=n.height-o.height-r}),pe())}var ll={drawer:ae("[data-md-toggle=drawer]"),search:ae("[data-md-toggle=search]")};var an=ae("#__config"),qe=JSON.parse(an.textContent);qe.base=`${new URL(qe.base,eo())}`;function Bt(){return qe}function Zt(e,r){return typeof r!="undefined"?qe.translations[e].replace("#",r.toString()):qe.translations[e]}function eo(){return new URL(location.href)}function fn(e,r){return new I(t=>{let o=new XMLHttpRequest;return o.open("GET",`${e}`),o.responseType="blob",o.addEventListener("load",()=>{o.status>=200&&o.status<300?(t.next(o.response),t.complete()):t.error(new Error(o.statusText))}),o.addEventListener("error",()=>{t.error(new Error("Network error"))}),o.addEventListener("abort",()=>{t.complete()}),typeof(r==null?void 0:r.progress$)!="undefined"&&(o.addEventListener("progress",n=>{var i;if(n.lengthComputable)r.progress$.next(n.loaded/n.total*100);else{let f=(i=o.getResponseHeader("Content-Length"))!=null?i:0;r.progress$.next(n.loaded/+f*100)}}),r.progress$.next(5)),o.send(),()=>o.abort()})}function gr(e,r){return fn(e,r).pipe(D(t=>t.text()),C(t=>JSON.parse(t)),me(1))}function Xr(e,r=document){return ae(`[data-mdx-component=${e}]`,r)}function xe(e,r=document){return $t(`[data-mdx-component=${e}]`,r)}function ro(e){let r=Nt(e),t=q($(e,"keyup"),$(e,"focus").pipe(Qr(1))).pipe(C(()=>e.value),be(e.value),pe());return r.pipe(_e(o=>!o),je(t)).subscribe(([,o])=>{let n=document.location.pathname;typeof ga=="function"&&o.length&&ga("send","pageview",`${n}?q=[icon]+${o}`)}),Fe([t,r]).pipe(C(([o,n])=>({ref:e,value:o,focus:n})))}var Zr=ot(Br());var po=ot(Br());function uo(e,r){return(0,po.wrap)(e.shortcode,r,{wrap:{tagOpen:"",tagClose:""}})}function lo(e,r,t){return Y("li",{class:"mdx-iconsearch-result__item"},Y("span",{class:"twemoji"},Y("img",{src:e.url})),Y("button",{class:"md-clipboard--inline",title:Zt("clipboard.copy"),"data-clipboard-text":t?e.shortcode:`:${e.shortcode}:`},Y("code",null,t?uo(e,r):`:${uo(e,r)}:`)))}function mo(e){let r=`@${e.name}`;return Y("a",{href:e.url,title:r,class:"mdx-sponsorship__item"},Y("img",{src:e.image}))}function ho(e){return Y("a",{href:"https://github.com/sponsors/mkdocs-ng?metadata_origin=docs",class:"mdx-sponsorship__item mdx-sponsorship__item--private"},"+",e)}function cn(e,{index$:r,query$:t,mode$:o}){return e.getAttribute("data-mdx-mode")==="file"?Fe([t.pipe(xr("value")),r.pipe(C(({icons:n})=>Object.values(n.data).map(i=>i.replace(/\.svg$/,""))))]).pipe(C(([{value:n},i])=>(0,Zr.filter)(i,n)),D(n=>r.pipe(C(({icons:i})=>({data:n.map(f=>({shortcode:f,url:[i.base,f,".svg"].join("")}))}))))):Fe([t.pipe(xr("value")),r.pipe(Nr(o),C(([{icons:n,emojis:i},f])=>[...["all","icons"].includes(f)?Object.keys(n.data):[],...["all","emojis"].includes(f)?Object.keys(i.data):[]]))]).pipe(C(([{value:n},i])=>(0,Zr.filter)(i,n)),D(n=>r.pipe(C(({icons:i,emojis:f})=>({data:n.map(u=>{let c=u in i.data?i:f;return{shortcode:u,url:[c.base,c.data[u]].join("")}})})))))}function vo(e,{index$:r,query$:t,mode$:o}){let n=new K,i=Gt(e).pipe(_e(Boolean)),f=ae(".mdx-iconsearch-result__meta",e);n.pipe(je(t)).subscribe(([{data:a},{value:s}])=>{if(s)switch(a.length){case 0:f.textContent="No matches";break;case 1:f.textContent="1 match";break;default:f.textContent=`${Dt(a.length)} matches`}else f.textContent="Type to start searching"});let u=e.getAttribute("data-mdx-mode")==="file",c=ae(":scope > :last-child",e);return n.pipe(he(()=>c.innerHTML=""),D(({data:a})=>q(ie(...a.slice(0,10)),ie(...a.slice(10)).pipe(Vr(10),Jr(i),D(([s])=>s)))),je(t)).subscribe(([a,{value:s}])=>c.appendChild(lo(a,s,u))),cn(e,{query$:t,index$:r,mode$:o}).pipe(he(a=>n.next(a)),le(()=>n.complete()),C(a=>Je({ref:e},a)))}function bo(e){let r=Bt(),t=gr(new URL("assets/javascripts/iconsearch_index.json",r.base)),o=Xr("iconsearch-query",e),n=Xr("iconsearch-result",e),i=new kr("all"),f=xe("iconsearch-select",e);for(let a of f)$(a,"change").pipe(C(s=>s.target.value)).subscribe(i);let u=ro(o),c=vo(n,{index$:t,query$:u,mode$:i});return q(u,c)}function xo(e){let r=gr("https://3if8u9o552.execute-api.us-east-1.amazonaws.com/_/"),t=xe("sponsorship-count"),o=xe("sponsorship-total");r.pipe(D(i=>B(t).pipe(he(f=>f.innerText=`${i.sponsors.length}`)))).subscribe(()=>e.removeAttribute("hidden")),r.pipe(D(i=>B(o).pipe(he(f=>f.innerText=`$ ${i.total.toString().replace(/\B(?=(\d{3})+(?!\d))/g,",")} a month`)))).subscribe();let n=yr(":scope > .mdx-sponsorship__list",e);return n&&t.length&&r.subscribe(i=>{for(let f of i.sponsors)f.type==="public"&&n.appendChild(mo(f.user));n.appendChild(ho(i.sponsors.filter(({type:f})=>f==="private").length))}),r.pipe(C(i=>Je({ref:e},i)))}function yo(){let{origin:e}=new URL(location.href);$(document.body,"click").subscribe(r=>{if(r.target instanceof HTMLElement){let t=r.target.closest("a");t&&t.origin!==e&&ga("send","event","outbound","click",t.href)}})}yo();var sn=document$.pipe(D(()=>q(...xe("iconsearch").map(e=>bo(e)),...xe("sponsorship").map(e=>xo(e)))));sn.subscribe();})(); //# sourceMappingURL=custom.f46acd93.min.js.map diff --git a/material/overrides/hooks/translations.py b/material/overrides/hooks/translations.py index eae2803e12..3014f709ce 100644 --- a/material/overrides/hooks/translations.py +++ b/material/overrides/hooks/translations.py @@ -33,7 +33,7 @@ # Determine missing translations and render language overview in the setup # guide, including links to provide missing translations. def on_page_markdown(markdown: str, *, page: Page, config: MkDocsConfig, files): - issue_url = "https://github.com/squidfunk/mkdocs-material/issues/new" + issue_url = "https://github.com/mkdocs-ng/mkdocs-material/issues/new" if page.file.src_uri != "setup/changing-the-language.md": return diff --git a/material/overrides/main.html b/material/overrides/main.html index 317c739180..afa8444e82 100644 --- a/material/overrides/main.html +++ b/material/overrides/main.html @@ -6,20 +6,12 @@ {% endblock %} {% block announce %} - For updates follow @squidfunk on - - - {% include ".icons/fontawesome/brands/mastodon.svg" %} - - Fosstodon - - and - - - Twitter + This project is now maintained as part of the + + mkdocs-ng + ecosystem. Install: + pip install mkdocs-ng-material {% endblock %} {% block scripts %} {{ super() }} diff --git a/material/plugins/info/plugin.py b/material/plugins/info/plugin.py index 9de7af6cd4..3f6f1df2de 100644 --- a/material/plugins/info/plugin.py +++ b/material/plugins/info/plugin.py @@ -80,12 +80,12 @@ def on_config(self, config): return # Resolve latest version - url = "https://github.com/squidfunk/mkdocs-material/releases/latest" + url = "https://github.com/mkdocs-ng/mkdocs-material/releases/latest" res = requests.get(url, allow_redirects = False) # Check if we're running the latest version _, current = res.headers.get("location").rsplit("/", 1) - present = version("mkdocs-material") + present = version("mkdocs-ng-material") if not present.startswith(current): log.error("Please upgrade to the latest version.") self._help_on_versions_and_exit(present, current) @@ -375,7 +375,7 @@ def _help_on_versions_and_exit(self, have, need): print(Style.NORMAL) print(f" Please update from {have} to {need}.") print(Style.RESET_ALL) - print(f" pip install --upgrade --force-reinstall mkdocs-material") + print(f" pip install --upgrade --force-reinstall mkdocs-ng-material") print(Style.NORMAL) # Exit, unless explicitly told not to diff --git a/material/templates/__init__.py b/material/templates/__init__.py index b6b5017bdc..2d38aa9e82 100644 --- a/material/templates/__init__.py +++ b/material/templates/__init__.py @@ -25,35 +25,27 @@ from pathlib import Path from sys import stderr -# Check if we're running MkDocs. Disable the warning automatically for other -# contexts, e.g., to allow for forks of MkDocs to adjust behavior to fit +# Check if we're running MkDocs (or mkdocs-ng). This theme is now maintained +# as part of the mkdocs-ng ecosystem. The CLI command remains `mkdocs`. def is_mkdocs(): path = Path(sys.argv[0]) return path.name in ("mkdocs", "mkdocs.exe") or ( path.name == "__main__.py" and path.parent.name == "mkdocs" ) -# Check if we're running MkDocs and the warning hasn't been disabled -if is_mkdocs() and not os.getenv("NO_MKDOCS_2_WARNING"): +# Print a notice about mkdocs-ng maintainership (once per session) +if is_mkdocs() and not os.getenv("NO_MKDOCS_NG_NOTICE"): print( "\n" - f"{Fore.RED} │ ⚠ Warning from the Material for MkDocs team{Style.RESET_ALL}\n" - f"{Fore.RED} │{Style.RESET_ALL}\n" - f"{Fore.RED} │{Style.RESET_ALL} MkDocs 2.0, the underlying framework of Material for MkDocs,\n" - f"{Fore.RED} │{Style.RESET_ALL} will introduce backward-incompatible changes, including:\n" - f"{Fore.RED} │{Style.RESET_ALL}\n" - f"{Fore.RED} │ × {Style.RESET_ALL}All plugins will stop working – the plugin system has been removed\n" - f"{Fore.RED} │ × {Style.RESET_ALL}All theme overrides will break – the theming system has been rewritten\n" - f"{Fore.RED} │ × {Style.RESET_ALL}No migration path exists – existing projects cannot be upgraded\n" - f"{Fore.RED} │ × {Style.RESET_ALL}Closed contribution model – community members can't report bugs\n" - f"{Fore.RED} │ × {Style.RESET_ALL}Currently unlicensed – unsuitable for production use\n" - f"{Fore.RED} │{Style.RESET_ALL}\n" - f"{Fore.RED} │{Style.RESET_ALL} Our full analysis:\n" - f"{Fore.RED} │{Style.RESET_ALL}\n" - f"{Fore.RED} │{Style.RESET_ALL} \033[4mhttps://squidfunk.github.io/mkdocs-material/blog/2026/02/18/mkdocs-2.0/{Style.RESET_ALL}\n" + f"{Fore.GREEN} │ ℹ Notice from the mkdocs-ng Material team{Style.RESET_ALL}\n" + f"{Fore.GREEN} │{Style.RESET_ALL}\n" + f"{Fore.GREEN} │{Style.RESET_ALL} This theme is now maintained as part of the mkdocs-ng ecosystem.\n" + f"{Fore.GREEN} │{Style.RESET_ALL} Install: pip install mkdocs-ng-material\n" + f"{Fore.GREEN} │{Style.RESET_ALL} Docs: https://mkdocs-ng.github.io/mkdocs-material/\n" + f"{Fore.GREEN} │{Style.RESET_ALL} GitHub: https://github.com/mkdocs-ng/mkdocs-material\n" f"{Style.RESET_ALL}", file=stderr ) # Disable for subsequent imports -os.environ["NO_MKDOCS_2_WARNING"] = "true" +os.environ["NO_MKDOCS_NG_NOTICE"] = "true" diff --git a/material/templates/partials/copyright.html b/material/templates/partials/copyright.html index 5da0dc4ba3..83d75bbd6b 100644 --- a/material/templates/partials/copyright.html +++ b/material/templates/partials/copyright.html @@ -9,7 +9,7 @@ {% endif %} {% if not config.extra.generator == false %} Made with - + Material for MkDocs {% endif %} diff --git a/src/overrides/hooks/translations.py b/src/overrides/hooks/translations.py index eae2803e12..3014f709ce 100644 --- a/src/overrides/hooks/translations.py +++ b/src/overrides/hooks/translations.py @@ -33,7 +33,7 @@ # Determine missing translations and render language overview in the setup # guide, including links to provide missing translations. def on_page_markdown(markdown: str, *, page: Page, config: MkDocsConfig, files): - issue_url = "https://github.com/squidfunk/mkdocs-material/issues/new" + issue_url = "https://github.com/mkdocs-ng/mkdocs-material/issues/new" if page.file.src_uri != "setup/changing-the-language.md": return diff --git a/src/overrides/main.html b/src/overrides/main.html index c324c6eb9a..16beec3574 100644 --- a/src/overrides/main.html +++ b/src/overrides/main.html @@ -34,20 +34,12 @@ {% block announce %} - For updates follow @squidfunk on - - - {% include ".icons/fontawesome/brands/mastodon.svg" %} - - Fosstodon - - and - - - Twitter + This project is now maintained as part of the + + mkdocs-ng + ecosystem. Install: + pip install mkdocs-ng-material {% endblock %} diff --git a/src/plugins/info/plugin.py b/src/plugins/info/plugin.py index 9de7af6cd4..3f6f1df2de 100644 --- a/src/plugins/info/plugin.py +++ b/src/plugins/info/plugin.py @@ -80,12 +80,12 @@ def on_config(self, config): return # Resolve latest version - url = "https://github.com/squidfunk/mkdocs-material/releases/latest" + url = "https://github.com/mkdocs-ng/mkdocs-material/releases/latest" res = requests.get(url, allow_redirects = False) # Check if we're running the latest version _, current = res.headers.get("location").rsplit("/", 1) - present = version("mkdocs-material") + present = version("mkdocs-ng-material") if not present.startswith(current): log.error("Please upgrade to the latest version.") self._help_on_versions_and_exit(present, current) @@ -375,7 +375,7 @@ def _help_on_versions_and_exit(self, have, need): print(Style.NORMAL) print(f" Please update from {have} to {need}.") print(Style.RESET_ALL) - print(f" pip install --upgrade --force-reinstall mkdocs-material") + print(f" pip install --upgrade --force-reinstall mkdocs-ng-material") print(Style.NORMAL) # Exit, unless explicitly told not to diff --git a/src/templates/__init__.py b/src/templates/__init__.py index b6b5017bdc..2d38aa9e82 100644 --- a/src/templates/__init__.py +++ b/src/templates/__init__.py @@ -25,35 +25,27 @@ from pathlib import Path from sys import stderr -# Check if we're running MkDocs. Disable the warning automatically for other -# contexts, e.g., to allow for forks of MkDocs to adjust behavior to fit +# Check if we're running MkDocs (or mkdocs-ng). This theme is now maintained +# as part of the mkdocs-ng ecosystem. The CLI command remains `mkdocs`. def is_mkdocs(): path = Path(sys.argv[0]) return path.name in ("mkdocs", "mkdocs.exe") or ( path.name == "__main__.py" and path.parent.name == "mkdocs" ) -# Check if we're running MkDocs and the warning hasn't been disabled -if is_mkdocs() and not os.getenv("NO_MKDOCS_2_WARNING"): +# Print a notice about mkdocs-ng maintainership (once per session) +if is_mkdocs() and not os.getenv("NO_MKDOCS_NG_NOTICE"): print( "\n" - f"{Fore.RED} │ ⚠ Warning from the Material for MkDocs team{Style.RESET_ALL}\n" - f"{Fore.RED} │{Style.RESET_ALL}\n" - f"{Fore.RED} │{Style.RESET_ALL} MkDocs 2.0, the underlying framework of Material for MkDocs,\n" - f"{Fore.RED} │{Style.RESET_ALL} will introduce backward-incompatible changes, including:\n" - f"{Fore.RED} │{Style.RESET_ALL}\n" - f"{Fore.RED} │ × {Style.RESET_ALL}All plugins will stop working – the plugin system has been removed\n" - f"{Fore.RED} │ × {Style.RESET_ALL}All theme overrides will break – the theming system has been rewritten\n" - f"{Fore.RED} │ × {Style.RESET_ALL}No migration path exists – existing projects cannot be upgraded\n" - f"{Fore.RED} │ × {Style.RESET_ALL}Closed contribution model – community members can't report bugs\n" - f"{Fore.RED} │ × {Style.RESET_ALL}Currently unlicensed – unsuitable for production use\n" - f"{Fore.RED} │{Style.RESET_ALL}\n" - f"{Fore.RED} │{Style.RESET_ALL} Our full analysis:\n" - f"{Fore.RED} │{Style.RESET_ALL}\n" - f"{Fore.RED} │{Style.RESET_ALL} \033[4mhttps://squidfunk.github.io/mkdocs-material/blog/2026/02/18/mkdocs-2.0/{Style.RESET_ALL}\n" + f"{Fore.GREEN} │ ℹ Notice from the mkdocs-ng Material team{Style.RESET_ALL}\n" + f"{Fore.GREEN} │{Style.RESET_ALL}\n" + f"{Fore.GREEN} │{Style.RESET_ALL} This theme is now maintained as part of the mkdocs-ng ecosystem.\n" + f"{Fore.GREEN} │{Style.RESET_ALL} Install: pip install mkdocs-ng-material\n" + f"{Fore.GREEN} │{Style.RESET_ALL} Docs: https://mkdocs-ng.github.io/mkdocs-material/\n" + f"{Fore.GREEN} │{Style.RESET_ALL} GitHub: https://github.com/mkdocs-ng/mkdocs-material\n" f"{Style.RESET_ALL}", file=stderr ) # Disable for subsequent imports -os.environ["NO_MKDOCS_2_WARNING"] = "true" +os.environ["NO_MKDOCS_NG_NOTICE"] = "true" diff --git a/src/templates/assets/javascripts/integrations/version/findurl/index.ts b/src/templates/assets/javascripts/integrations/version/findurl/index.ts index 717ed1ec48..119eadea10 100644 --- a/src/templates/assets/javascripts/integrations/version/findurl/index.ts +++ b/src/templates/assets/javascripts/integrations/version/findurl/index.ts @@ -45,7 +45,7 @@ export function selectedVersionCorrespondingURL( const sitemapCommonPrefix = shortestCommonPrefix(selectedVersionSitemap.keys()) if (!selectedVersionSitemap.has(sitemapCommonPrefix)) { // We could also check that `commonSitemapPrefix` ends in the canonical version, - // similarly to https://github.com/squidfunk/mkdocs-material/pull/7227. However, + // similarly to https://github.com/mkdocs-ng/mkdocs-material/pull/7227. However, // I don't believe that Mike/MkDocs ever generate sitemaps where it would matter return } diff --git a/src/templates/assets/javascripts/integrations/version/index.ts b/src/templates/assets/javascripts/integrations/version/index.ts index 29920a894c..5edad5b166 100644 --- a/src/templates/assets/javascripts/integrations/version/index.ts +++ b/src/templates/assets/javascripts/integrations/version/index.ts @@ -117,7 +117,7 @@ export function setupVersionSelector( // interfere with instant navigation. We need to refactor this // at some point together with instant navigation. // - // See https://github.com/squidfunk/mkdocs-material/issues/4012 + // See https://github.com/mkdocs-ng/mkdocs-material/issues/4012 if (!ev.target.closest(".md-version")) { const version = urls.get(url)! if (version === current) diff --git a/src/templates/partials/copyright.html b/src/templates/partials/copyright.html index 56f4a0b8ce..a60dca20c7 100644 --- a/src/templates/partials/copyright.html +++ b/src/templates/partials/copyright.html @@ -30,7 +30,7 @@ {% if not config.extra.generator == false %} Made with Material for MkDocs diff --git a/tools/build/index.ts b/tools/build/index.ts index cab2b83db8..33285c60bb 100644 --- a/tools/build/index.ts +++ b/tools/build/index.ts @@ -395,7 +395,7 @@ const index$ = zip(icons$, emojis$) const cdn = "https://raw.githubusercontent.com" return { icons: { - base: `${cdn}/squidfunk/mkdocs-material/master/material/templates/.icons/`, + base: `${cdn}/mkdocs-ng/mkdocs-material/main/material/templates/.icons/`, data: Object.fromEntries(icons) }, emojis: { @@ -446,7 +446,7 @@ const schema$ = merge( "$schema": "https://json-schema.org/draft-07/schema", "title": "Icon", "markdownDescription": [ - "https://squidfunk.github.io/mkdocs-material", + "https://mkdocs-ng.github.io/mkdocs-material", "reference/icons-emojis/#search" ].join("/"), "type": "string", From b494bd95483e58542b7aa546f11fb06543b94710 Mon Sep 17 00:00:00 2001 From: Xianpeng Shen Date: Mon, 27 Apr 2026 19:02:55 +0300 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Xianpeng Shen --- docs/blog/.authors.yml | 2 +- docs/insiders/getting-started.md | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/blog/.authors.yml b/docs/blog/.authors.yml index 239cc107d4..f151f7cd2c 100644 --- a/docs/blog/.authors.yml +++ b/docs/blog/.authors.yml @@ -1,6 +1,6 @@ authors: mkdocs-ng: - name: mkdocs-ng Team + name: MkDocs NG Team description: Maintainer avatar: https://avatars.githubusercontent.com/u/932156 url: https://github.com/mkdocs-ng diff --git a/docs/insiders/getting-started.md b/docs/insiders/getting-started.md index 003c84b61b..f0de1e139d 100644 --- a/docs/insiders/getting-started.md +++ b/docs/insiders/getting-started.md @@ -50,7 +50,6 @@ Make sure you have the `GH_TOKEN` variable set as instructed above. end of the URL with the one you want. ``` sh - pip install git+https://${GH_TOKEN}@github.com/mkdocs-ng/mkdocs-material-insiders.git@9.4.2-insiders-4.42.0 ``` === "Latest"