From 44b4c73a545b5bb22f9192af7e2f1cd85950b41a Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 22 Apr 2026 06:02:19 +0000 Subject: [PATCH] Replace www.mkdocs.org links with mkdocs-ng.github.io/mkdocs Agent-Logs-Url: https://github.com/mkdocs-ng/mkdocs/sessions/8ce69d56-e7a2-40cb-b364-493f87351e4c Co-authored-by: shenxianpeng <3353385+shenxianpeng@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- docs/about/release-notes.md | 4 ++-- docs/dev-guide/themes.md | 2 +- mkdocs/themes/mkdocs/base.html | 2 +- mkdocs/themes/readthedocs/footer.html | 2 +- pyproject.toml | 4 ++-- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6e6143c9..7c0a19ad 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -184,7 +184,7 @@ rooms, and mailing lists is expected to follow the [PyPA Code of Conduct]. [installing `pipx`]: https://pypa.github.io/pipx/installation/ [GitHub Actions]: https://docs.github.com/actions [PyPA Code of Conduct]: https://www.pypa.io/en/latest/code-of-conduct/ -[Translating Themes]: https://www.mkdocs.org/dev-guide/translations/ +[Translating Themes]: https://mkdocs-ng.github.io/mkdocs/dev-guide/translations/ [Jinja's i18n extension]: https://jinja.palletsprojects.com/en/latest/extensions/#i18n-extension [Ruff]: https://docs.astral.sh/ruff/ [Black]: https://black.readthedocs.io/ diff --git a/docs/about/release-notes.md b/docs/about/release-notes.md index 7f6e03b0..1336ca57 100644 --- a/docs/about/release-notes.md +++ b/docs/about/release-notes.md @@ -891,7 +891,7 @@ Other small improvements; see [commit log](https://github.com/mkdocs-ng/mkdocs/c * New option `anonymize_ip` for Google Analytics. * Dependencies were upgraded: jQuery upgraded to 3.6.0, Modernizr.js dropped, and others. - See [documentation of config options for the theme](https://www.mkdocs.org/user-guide/choosing-your-theme/#readthedocs) + See [documentation of config options for the theme](https://mkdocs-ng.github.io/mkdocs/user-guide/choosing-your-theme/#readthedocs) * Built-in themes now also support these languages: * German (#2633) @@ -903,7 +903,7 @@ Other small improvements; see [commit log](https://github.com/mkdocs-ng/mkdocs/c Normally MkDocs never reaches into any other directories (so this feature shouldn't be necessary), but some plugins and extensions may do so. - See [documentation](https://www.mkdocs.org/user-guide/configuration/#watch). + See [documentation](https://mkdocs-ng.github.io/mkdocs/user-guide/configuration/#watch). * New `--no-history` option for `gh_deploy` (#2594) diff --git a/docs/dev-guide/themes.md b/docs/dev-guide/themes.md index e9aaae5b..07e9c47b 100644 --- a/docs/dev-guide/themes.md +++ b/docs/dev-guide/themes.md @@ -637,7 +637,7 @@ extra: links: - https://github.com/mkdocs-ng - https://docs.readthedocs.org/en/latest/builds.html#mkdocs - - https://www.mkdocs.org/ + - https://mkdocs-ng.github.io/mkdocs/ ``` And then displayed with this HTML in the custom theme. diff --git a/mkdocs/themes/mkdocs/base.html b/mkdocs/themes/mkdocs/base.html index e8c8c450..9f1fdeaa 100644 --- a/mkdocs/themes/mkdocs/base.html +++ b/mkdocs/themes/mkdocs/base.html @@ -222,7 +222,7 @@ {%- if config.copyright %}

{{ config.copyright }}

{%- endif %} -

{% trans mkdocs_link='MkDocs' %}Documentation built with {{ mkdocs_link }}.{% endtrans %}

+

{% trans mkdocs_link='MkDocs' %}Documentation built with {{ mkdocs_link }}.{% endtrans %}

{%- endblock %} diff --git a/mkdocs/themes/readthedocs/footer.html b/mkdocs/themes/readthedocs/footer.html index 3feadb75..7be3e8f0 100644 --- a/mkdocs/themes/readthedocs/footer.html +++ b/mkdocs/themes/readthedocs/footer.html @@ -22,5 +22,5 @@ {%- endif %} - {% trans mkdocs_link='MkDocs', sphinx_link='{}'.format(gettext('theme')), rtd_link='Read the Docs' %}Built with %(mkdocs_link)s using a %(sphinx_link)s provided by %(rtd_link)s.{% endtrans %} + {% trans mkdocs_link='MkDocs', sphinx_link='{}'.format(gettext('theme')), rtd_link='Read the Docs' %}Built with %(mkdocs_link)s using a %(sphinx_link)s provided by %(rtd_link)s.{% endtrans %} diff --git a/pyproject.toml b/pyproject.toml index e66a355b..7f34831b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -74,10 +74,10 @@ min-versions = [ ] [project.urls] -Documentation = "https://www.mkdocs.org/" +Documentation = "https://mkdocs-ng.github.io/mkdocs/" Source = "https://github.com/mkdocs-ng/mkdocs" Issues = "https://github.com/mkdocs-ng/mkdocs/issues" -History = "https://www.mkdocs.org/about/release-notes/" +History = "https://mkdocs-ng.github.io/mkdocs/about/release-notes/" [project.scripts] mkdocs = "mkdocs.__main__:cli"