From a76a70041a710b81046379a773cee96f5d5a614e Mon Sep 17 00:00:00 2001 From: Oleh Prypin Date: Fri, 20 Mar 2026 20:29:49 +0100 Subject: [PATCH] Fix links to GitHub issues that actually refer to the mkdocs repository --- docs/about/release-notes.md | 386 +++++++++--------- .../properdocs_theme_mkdocs/css/base.css | 2 +- properdocs/tests/structure/page_tests.py | 6 +- 3 files changed, 197 insertions(+), 197 deletions(-) diff --git a/docs/about/release-notes.md b/docs/about/release-notes.md index bcdd90aa..adc4f152 100644 --- a/docs/about/release-notes.md +++ b/docs/about/release-notes.md @@ -69,29 +69,29 @@ The versions below are versions of MkDocs, just for reference. ### Fixed -* Fix build error when environment variable `SOURCE_DATE_EPOCH=0` is set. #3795 -* Fix build error when `mkdocs_theme.yml` config is empty. #3700 -* Support `python -W` and `PYTHONWARNINGS` instead of overriding the configuration. #3809 -* Support running with Docker under strict mode, by removing `0.0.0.0` dev server warning. #3784 -* Drop unnecessary `changefreq` from `sitemap.xml`. #3629 -* Fix JavaScript console error when closing menu dropdown. #3774 -* Fix JavaScript console error that occur on repeated clicks. #3730 -* Fix JavaScript console error that can occur on dropdown selections. #3694 +* Fix build error when environment variable `SOURCE_DATE_EPOCH=0` is set. mkdocs/mkdocs#3795 +* Fix build error when `mkdocs_theme.yml` config is empty. mkdocs/mkdocs#3700 +* Support `python -W` and `PYTHONWARNINGS` instead of overriding the configuration. mkdocs/mkdocs#3809 +* Support running with Docker under strict mode, by removing `0.0.0.0` dev server warning. mkdocs/mkdocs#3784 +* Drop unnecessary `changefreq` from `sitemap.xml`. mkdocs/mkdocs#3629 +* Fix JavaScript console error when closing menu dropdown. mkdocs/mkdocs#3774 +* Fix JavaScript console error that occur on repeated clicks. mkdocs/mkdocs#3730 +* Fix JavaScript console error that can occur on dropdown selections. mkdocs/mkdocs#3694 ### Added -* Added translations for Dutch. #3804 -* Added and updated translations for Chinese (Simplified). #3684 +* Added translations for Dutch. mkdocs/mkdocs#3804 +* Added and updated translations for Chinese (Simplified). mkdocs/mkdocs#3684 ## Version 1.6.0 (2024-04-20) ### Local preview -* `mkdocs serve` no longer locks up the browser when more than 5 tabs are open. This is achieved by closing the polling connection whenever a tab becomes inactive. Background tabs will no longer auto-reload either - that will instead happen as soon the tab is opened again. Context: #3391 +* `mkdocs serve` no longer locks up the browser when more than 5 tabs are open. This is achieved by closing the polling connection whenever a tab becomes inactive. Background tabs will no longer auto-reload either - that will instead happen as soon the tab is opened again. Context: mkdocs/mkdocs#3391 * New flag `serve --open` to open the site in a browser. After the first build is finished, this flag will cause the default OS Web browser to be opened at the home page of the local site. - Context: #3500 + Context: mkdocs/mkdocs#3500 #### Drafts @@ -107,7 +107,7 @@ See [documentation](../user-guide/configuration.md#exclude_docs). Other changes: -* Reduce warning levels when a "draft" page has a link to a non-existent file. Context: #3449 +* Reduce warning levels when a "draft" page has a link to a non-existent file. Context: mkdocs/mkdocs#3449 ### Update to deduction of page titles @@ -117,19 +117,19 @@ Now tags are always fully sanitized from the title. Though it still remains the Images (notably, emojis in some extensions) get preserved in the title only through their `alt` attribute's value. -Context: #3564, #3578 +Context: mkdocs/mkdocs#3564, mkdocs/mkdocs#3578 ### Themes -* Built-in themes now also support Polish language (#3613) +* Built-in themes now also support Polish language (mkdocs/mkdocs#3613) #### "readthedocs" theme -* Fix: "readthedocs" theme can now correctly handle deeply nested nav configurations (over 2 levels deep), without confusedly expanding all sections and jumping around vertically. (#3464) +* Fix: "readthedocs" theme can now correctly handle deeply nested nav configurations (over 2 levels deep), without confusedly expanding all sections and jumping around vertically. (mkdocs/mkdocs#3464) -* Fix: "readthedocs" theme now shows a link to the repository (with a generic logo) even when isn't one of the 3 known hosters. (#3435) +* Fix: "readthedocs" theme now shows a link to the repository (with a generic logo) even when isn't one of the 3 known hosters. (mkdocs/mkdocs#3435) -* "readthedocs" theme now also has translation for the word "theme" in the footer that mistakenly always remained in English. (#3613, #3625) +* "readthedocs" theme now also has translation for the word "theme" in the footer that mistakenly always remained in English. (mkdocs/mkdocs#3613, mkdocs/mkdocs#3625) #### "mkdocs" theme @@ -149,7 +149,7 @@ See `color_mode`, `user_color_mode_toggle` in [**documentation**](../user-guide/ > > Or even better if the script file is copied and included from your docs dir. -Context: #3493, #3649 +Context: mkdocs/mkdocs#3493, mkdocs/mkdocs#3649 ### Configuration @@ -159,7 +159,7 @@ You may have seen some plugins take up the convention of having a setting `enabl Now *every* plugin has this setting. Plugins can still *choose* to implement this config themselves and decide how it behaves (and unless they drop older versions of MkDocs, they still should for now), but now there's always a fallback for every plugin. -See [**documentation**](../user-guide/configuration.md/#enabled-option). Context: #3395 +See [**documentation**](../user-guide/configuration.md/#enabled-option). Context: mkdocs/mkdocs#3395 ### Validation @@ -177,7 +177,7 @@ So, now any document (e.g. "dir1/foo.md") can link to the document "dir2/bar.md" You have to enable the setting, though. The default is still to just skip any processing of such links. -See [**documentation**](../user-guide/configuration.md#validation-of-absolute-links). Context: #3485 +See [**documentation**](../user-guide/configuration.md#validation-of-absolute-links). Context: mkdocs/mkdocs#3485 ###### Absolute links within nav @@ -214,25 +214,25 @@ Plugins and extensions that insert anchors, in order to be compatible with this, If you as a user are dealing with falsely reported missing anchors and there's no way to resolve this, you can choose to disable these messages by setting this option to `ignore` (and they are at INFO level by default anyway). -See [**documentation**](../user-guide/configuration.md#validation). Context: #3463 +See [**documentation**](../user-guide/configuration.md#validation). Context: mkdocs/mkdocs#3463 Other changes: -* When the `nav` config is not specified at all, the `not_in_nav` setting (originally added in 1.5.0) gains an additional behavior: documents covered by `not_in_nav` will not be part of the automatically deduced navigation. Context: #3443 +* When the `nav` config is not specified at all, the `not_in_nav` setting (originally added in 1.5.0) gains an additional behavior: documents covered by `not_in_nav` will not be part of the automatically deduced navigation. Context: mkdocs/mkdocs#3443 * Fix: the `!relative` YAML tag for `markdown_extensions` (originally added in 1.5.0) - it was broken in many typical use cases. - See [**documentation**](../user-guide/configuration.md#paths-relative-to-the-current-file-or-site). Context: #3466 + See [**documentation**](../user-guide/configuration.md#paths-relative-to-the-current-file-or-site). Context: mkdocs/mkdocs#3466 -* Config validation now exits on first error, to avoid showing bizarre secondary errors. Context: #3437 +* Config validation now exits on first error, to avoid showing bizarre secondary errors. Context: mkdocs/mkdocs#3437 -* MkDocs used to shorten error messages for unexpected errors such as "file not found", but that is no longer the case, the full error message and stack trace will be possible to see (unless the error has a proper handler, of course). Context: #3445 +* MkDocs used to shorten error messages for unexpected errors such as "file not found", but that is no longer the case, the full error message and stack trace will be possible to see (unless the error has a proper handler, of course). Context: mkdocs/mkdocs#3445 ### Upgrades for plugin developers #### Plugins can add multiple handlers for the same event type, at multiple priorities -See [`properdocs.plugins.CombinedEvent`][] in [**documentation**](../dev-guide/plugins.md#event-priorities). Context: #3448 +See [`properdocs.plugins.CombinedEvent`][] in [**documentation**](../dev-guide/plugins.md#event-priorities). Context: mkdocs/mkdocs#3448 #### Enabling true generated files and expanding the [`File`][properdocs.structure.files.File] API @@ -280,29 +280,29 @@ Other changes: * The order of `File` objects inside a `Files` collection is no longer significant when automatically inferring the `nav`. They get forcibly sorted according to the default alphabetic order. -Context: #3451, #3463 +Context: mkdocs/mkdocs#3451, mkdocs/mkdocs#3463 ### Hooks and debugging -* Hook files can now import adjacent *.py files using the `import` statement. Previously this was possible to achieve only through a `sys.path` workaround. See the new mention in [documentation](../user-guide/configuration.md#hooks). Context: #3568 +* Hook files can now import adjacent *.py files using the `import` statement. Previously this was possible to achieve only through a `sys.path` workaround. See the new mention in [documentation](../user-guide/configuration.md#hooks). Context: mkdocs/mkdocs#3568 -* Verbose `-v` log shows the sequence of plugin events in more detail - shows each invoked plugin one by one, not only the event type. Context: #3444 +* Verbose `-v` log shows the sequence of plugin events in more detail - shows each invoked plugin one by one, not only the event type. Context: mkdocs/mkdocs#3444 ### Deprecations -* Python 3.7 is no longer supported, Python 3.12 is officially supported. Context: #3429 +* Python 3.7 is no longer supported, Python 3.12 is officially supported. Context: mkdocs/mkdocs#3429 -* The theme config file `mkdocs_theme.yml` no longer executes YAML tags. Context: #3465 +* The theme config file `mkdocs_theme.yml` no longer executes YAML tags. Context: mkdocs/mkdocs#3465 * The plugin event `on_page_read_source` is soft-deprecated because there is always a better alternative to it (see the new `File` API or just `on_page_markdown`, depending on the desired interaction). When multiple plugins/hooks apply this event handler, they trample over each other, so now there is a warning in that case. - See [**documentation**](../dev-guide/plugins.md#on_page_read_source). Context: #3503 + See [**documentation**](../dev-guide/plugins.md#on_page_read_source). Context: mkdocs/mkdocs#3503 #### API deprecations -* It is no longer allowed to set `File.page` to a type other than `Page` or a subclass thereof. Context: #3443 - following the deprecation in version 1.5.3 and #3381. +* It is no longer allowed to set `File.page` to a type other than `Page` or a subclass thereof. Context: mkdocs/mkdocs#3443 - following the deprecation in version 1.5.3 and mkdocs/mkdocs#3381. * `Theme._vars` is deprecated - use `theme['foo']` instead of `theme._vars['foo']` @@ -310,49 +310,49 @@ Context: #3451, #3463 * `LiveReloadServer.watch()` no longer accepts a custom callback. -Context: #3429 +Context: mkdocs/mkdocs#3429 ### Misc -* The `sitemap.xml.gz` file is slightly more reproducible and no longer changes on every build, but instead only once per day (upon a date change). Context: #3460 +* The `sitemap.xml.gz` file is slightly more reproducible and no longer changes on every build, but instead only once per day (upon a date change). Context: mkdocs/mkdocs#3460 -Other small improvements; see [commit log](https://github.com/properdocs/properdocs/compare/1.5.3...1.6.0). +Other small improvements; see [commit log](https://github.com/mkdocs/mkdocs/compare/1.5.3...1.6.0). ## Version 1.5.3 (2023-09-18) -* Fix `mkdocs serve` sometimes locking up all browser tabs when navigating quickly (#3390) +* Fix `mkdocs serve` sometimes locking up all browser tabs when navigating quickly (mkdocs/mkdocs#3390) -* Add many new supported languages for "search" plugin - update lunr-languages to 1.12.0 (#3334) +* Add many new supported languages for "search" plugin - update lunr-languages to 1.12.0 (mkdocs/mkdocs#3334) -* Bugfix (regression in 1.5.0): In "readthedocs" theme the styling of "breadcrumb navigation" was broken for nested pages (#3383) +* Bugfix (regression in 1.5.0): In "readthedocs" theme the styling of "breadcrumb navigation" was broken for nested pages (mkdocs/mkdocs#3383) -* Built-in themes now also support Chinese (Traditional, Taiwan) language (#3154) +* Built-in themes now also support Chinese (Traditional, Taiwan) language (mkdocs/mkdocs#3154) -* Plugins can now set `File.page` to their own subclass of `Page`. There is also now a warning if `File.page` is set to anything other than a strict subclass of `Page`. (#3367, #3381) +* Plugins can now set `File.page` to their own subclass of `Page`. There is also now a warning if `File.page` is set to anything other than a strict subclass of `Page`. (mkdocs/mkdocs#3367, mkdocs/mkdocs#3381) Note that just instantiating a `Page` [sets the file automatically](https://github.com/properdocs/properdocs/blob/f94ab3f62d0416d484d81a0c695c8ca86ab3b975/mkdocs/structure/pages.py#L34), so care needs to be taken not to create an unneeded `Page`. -Other small improvements; see [commit log](https://github.com/properdocs/properdocs/compare/1.5.2...1.5.3). +Other small improvements; see [commit log](https://github.com/mkdocs/mkdocs/compare/1.5.2...1.5.3). ## Version 1.5.2 (2023-08-02) -* Bugfix (regression in 1.5.0): Restore functionality of `--no-livereload`. (#3320) +* Bugfix (regression in 1.5.0): Restore functionality of `--no-livereload`. (mkdocs/mkdocs#3320) -* Bugfix (regression in 1.5.0): The new page title detection would sometimes be unable to drop anchorlinks - fix that. (#3325) +* Bugfix (regression in 1.5.0): The new page title detection would sometimes be unable to drop anchorlinks - fix that. (mkdocs/mkdocs#3325) * Partly bring back pre-1.5 API: `extra_javascript` items will once again be mostly strings, and only sometimes `ExtraScriptValue` (when the extra `script` functionality is used). - Plugins should be free to append strings to `config.extra_javascript`, but when reading the values, they must still make sure to read it as `str(value)` in case it is an `ExtraScriptValue` item. For querying the attributes such as `.type` you need to check `isinstance` first. Static type checking will guide you in that. (#3324) + Plugins should be free to append strings to `config.extra_javascript`, but when reading the values, they must still make sure to read it as `str(value)` in case it is an `ExtraScriptValue` item. For querying the attributes such as `.type` you need to check `isinstance` first. Static type checking will guide you in that. (mkdocs/mkdocs#3324) -See [commit log](https://github.com/properdocs/properdocs/compare/1.5.1...1.5.2). +See [commit log](https://github.com/mkdocs/mkdocs/compare/1.5.1...1.5.2). ## Version 1.5.1 (2023-07-28) * Bugfix (regression in 1.5.0): Make it possible to treat `ExtraScriptValue` as a path. This lets some plugins still work despite the breaking change. -* Bugfix (regression in 1.5.0): Prevent errors for special setups that have 3 conflicting files, such as `index.html`, `index.md` *and* `README.md` (#3314) +* Bugfix (regression in 1.5.0): Prevent errors for special setups that have 3 conflicting files, such as `index.html`, `index.md` *and* `README.md` (mkdocs/mkdocs#3314) -See [commit log](https://github.com/properdocs/properdocs/compare/1.5.0...1.5.1). +See [commit log](https://github.com/mkdocs/mkdocs/compare/1.5.0...1.5.1). ## Version 1.5.0 (2023-07-26) @@ -372,7 +372,7 @@ Of course, you're welcome to use a "virtualenv" with such a command. Also note t The command allows overriding which config file is used (instead of `properdocs.yml` in the current directory) as well as which catalog of projects is used (instead of downloading it from the default location). See [`mkdocs get-deps --help`](../user-guide/cli.md#properdocs-get-deps). -Context: #3205 +Context: mkdocs/mkdocs#3205 ### MkDocs has an official catalog of plugins @@ -404,7 +404,7 @@ validation: If, on the opposite end, you want these to print `WARNING` messages and cause `mkdocs build --strict` to fail, you are recommended to configure these to `warn` instead. -See [**documentation**](../user-guide/configuration.md#validation) for actual recommended settings and more details. Context: #3283 +See [**documentation**](../user-guide/configuration.md#validation) for actual recommended settings and more details. Context: mkdocs/mkdocs#3283 #### Validated links in the nav @@ -425,7 +425,7 @@ This can make the following message appear with the `WARNING` level (as opposed INFO - The following pages exist in the docs directory, but are not included in the "nav" configuration: ... ``` -See [**documentation**](../user-guide/configuration.md#validation). Context: #3283, #1755 +See [**documentation**](../user-guide/configuration.md#validation). Context: mkdocs/mkdocs#3283, mkdocs/mkdocs#1755 #### Mark docs as intentionally "not in nav" @@ -435,7 +435,7 @@ This is useful if you generally like these warnings about files that were forgot The `not_in_nav` config is a set of gitignore-like patterns. See the next section for an explanation of another such config. -See [**documentation**](../user-guide/configuration.md#not_in_nav). Context: #3224, #1888 +See [**documentation**](../user-guide/configuration.md#not_in_nav). Context: mkdocs/mkdocs#3224, mkdocs/mkdocs#1888 ### Excluded doc files @@ -455,7 +455,7 @@ Validation of links (described above) is also affected by `exclude_docs`. During As an additional related change, if you have a need to have both `README.md` and `index.md` files in a directory but publish only one of them, you can now use this feature to explicitly ignore one of them and avoid warnings. -See [**documentation**](../user-guide/configuration.md#exclude_docs). Context: #3224 +See [**documentation**](../user-guide/configuration.md#exclude_docs). Context: mkdocs/mkdocs#3224 #### Drafts @@ -467,7 +467,7 @@ The `exclude_docs` config has another behavior: all excluded Markdown pages will If you don't want `mkdocs serve` to have any special behaviors and instead want it to perform completely normal builds, use the new flag `mkdocs serve --clean`. -See [**documentation**](../user-guide/configuration.md#exclude_docs). Context: #3224 +See [**documentation**](../user-guide/configuration.md#exclude_docs). Context: mkdocs/mkdocs#3224 ### `mkdocs serve` no longer exits after build errors @@ -475,11 +475,11 @@ If there was an error (from the config or a plugin) during a site re-build, `mkd But errors on the *first* build still cause `mkdocs serve` to exit, as before. -Context: #3255 +Context: mkdocs/mkdocs#3255 ### Page titles will be deduced from any style of heading -MkDocs always had the ability to infer the title of a page (if it's not specified in the `nav`) based on the first line of the document, if it had a `

` heading that had to written starting with the exact character `#`. Now any style of Markdown heading is understood (#1886). Due to the previous simplistic parsing, it was also impossible to use `attr_list` attributes in that first heading (#3136). Now that is also fixed. +MkDocs always had the ability to infer the title of a page (if it's not specified in the `nav`) based on the first line of the document, if it had a `

` heading that had to written starting with the exact character `#`. Now any style of Markdown heading is understood (mkdocs/mkdocs#1886). Due to the previous simplistic parsing, it was also impossible to use `attr_list` attributes in that first heading (mkdocs/mkdocs#3136). Now that is also fixed. ### Markdown extensions can use paths relative to the current document @@ -491,7 +491,7 @@ markdown_extensions: base_path: !relative ``` -See [**documentation**](../user-guide/configuration.md#paths-relative-to-the-current-file-or-site). Context: #2154, #3258 +See [**documentation**](../user-guide/configuration.md#paths-relative-to-the-current-file-or-site). Context: mkdocs/mkdocs#2154, mkdocs/mkdocs#3258 ### `