Skip to content

Fix documentation broken link anchors #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shenxianpeng merged 2 commits into from
May 11, 2026
Merged

Fix documentation broken link anchors #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3bdefe5
Fix documentation broken link anchors
shenxianpeng May 11, 2026
021fbc0
Update release notes for version 1.7.4 to fix broken link anchors
shenxianpeng May 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions docs/about/release-notes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ $ mkdocs --version
mkdocs, version 1.7.0 from /path/to/mkdocs (Python 3.12)
```

## Version 1.7.4 (2026-05-xx)

### Fixed

Update documentation to fix broken link anchors. #62

## Version 1.7.3 (2026-05-09)

### Fixed
Expand Down Expand Up @@ -704,7 +710,7 @@ See [commit log](https://github.com/mkdocs-ng/mkdocs/compare/1.4.1...1.4.2).

* Plugin-related config options have more reliable validation and error reporting (#2997)

* Translation sub-commands of `setup.py` were completely dropped. See documentation [[1]](../about/contributing.md#submitting-changes-to-the-builtin-themes) [[2]](../dev-guide/translations.md#updating-the-translation-catalogs) for their new replacements (#2990)
* Translation sub-commands of `setup.py` were completely dropped. See documentation [[1]](../about/contributing.md#development-setup) [[2]](../dev-guide/translations.md#updating-the-translation-catalogs) for their new replacements (#2990)

* The ['mkdocs' package](https://pypi.org/project/mkdocs/#files) (wheel and source) is now produced by Hatch build system and pyproject.toml instead of setup.py (#2988)

Expand Down Expand Up @@ -1074,7 +1080,7 @@ Guide](../dev-guide/themes.md#supporting-theme-localizationtranslation).

Contributors who are updating the templates to the built-in themes should
review the [Contributing
Guide](contributing.md#submitting-changes-to-the-builtin-themes).
Guide](contributing.md#development-setup).

The `lang` setting of the `search` plugin now defaults to the language
specified in `theme.locale`.
Expand Down
2 changes: 1 addition & 1 deletion docs/dev-guide/themes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1047,7 +1047,7 @@ themes, see the appropriate [section] of the Contributing Guide and the
[Translation Guide].

[pybabel]: https://babel.pocoo.org/en/latest/setup.html
[section]: ../about/contributing.md#submitting-changes-to-the-builtin-themes
[section]: ../about/contributing.md#development-setup
[Translation Guide]: translations.md

### Example custom theme Localization/Translation workflow
Expand Down
12 changes: 6 additions & 6 deletions docs/dev-guide/translations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ combine theme localization with a third-party
internationalization/localization plugin.

[built-in themes]: ../user-guide/choosing-your-theme.md
[update themes]: ../about/contributing.md#submitting-changes-to-the-builtin-themes
[update themes]: ../about/contributing.md#development-setup
[configured]: themes.md#supporting-theme-localizationtranslation

## Localization tooling prerequisites
Expand All @@ -43,8 +43,8 @@ pip install 'mkdocs[i18n]'

[babel]: https://babel.pocoo.org/en/latest/cmdline.html
[Contributing Guide]: ../about/contributing.md
[Install for Development]: ../about/contributing.md#installing-for-development
[Submit a Pull Request]: ../about/contributing.md#submitting-pull-requests
[Install for Development]: ../about/contributing.md#development-setup
[Submit a Pull Request]: ../about/contributing.md#pull-requests

## Adding language translations to themes

Expand All @@ -54,7 +54,7 @@ translation by following the steps below.

Here is a quick summary of what you'll need to do:

1. [Fork and clone the MkDocs repository](#fork-and-clone-the-mkdocs-repository) and then [install MkDocs for development](../about/contributing.md#installing-for-development) for adding and testing translations.
1. [Fork and clone the MkDocs repository](#fork-and-clone-the-mkdocs-repository) and then [install MkDocs for development](../about/contributing.md#development-setup) for adding and testing translations.
2. [Initialize new localization catalogs](#initializing-the-localization-catalogs) for your language (if a translation for your locale already exists, follow the instructions for [updating theme localization files](#updating-the-translation-catalogs) instead).
3. [Add a translation](#translating-the-mkdocs-themes) for every text placeholder in the localized catalogs.
4. [Locally serve and test](#testing-theme-translations) the translated themes for your language.
Expand All @@ -74,10 +74,10 @@ use of a term which differs from the general language translation.

In the following steps you'll work with a fork of the MkDocs repository. Follow
the instructions for [forking and cloning the MkDocs
repository](../about/contributing.md#installing-for-development).
repository](../about/contributing.md#development-setup).

To test the translations you also need to [install MkDocs for
development](../about/contributing.md#installing-for-development) from your fork.
development](../about/contributing.md#development-setup) from your fork.

### Initializing the localization catalogs

Expand Down
Loading