Docusaurus reports false positive anchor link errors for Plugins page
MikeMcC399 opened this issue · comments
Mike McCready commented
Subject
Description
- Following on from the resolved issue #5630, all broken anchor errors reported by Docusaurus
npm run build
have been fixed, with the exception of false positives related to bookmarks on the Plugins page https://docs.cypress.io/plugins.
For example
- Broken anchor on source page path = /api/cypress-api/custom-commands:
-> linking to /plugins#custom-commands
This is however a false positive, as the link https://docs.cypress.io/plugins#custom-commands brings up the correct page and the correct section. The target HTML is valid:
<h2 id="custom-commands">Custom Commands</h2>
Logs
[INFO] Docusaurus found broken anchors!
Please check the pages of your site in the list below, and make sure you don't reference any anchor that does not exist.
Note: it's possible to ignore broken anchors with the 'onBrokenAnchors' Docusaurus configuration, and let the build pass.
Exhaustive list of all broken anchors found:
- Broken anchor on source page path = /api/cypress-api/custom-commands:
-> linking to /plugins#custom-commands
- Broken anchor on source page path = /api/cypress-api/custom-queries:
-> linking to /plugins#custom-commands
- Broken anchor on source page path = /api/table-of-contents:
-> linking to /plugins#custom-commands
- Broken anchor on source page path = /examples/recipes:
-> linking to /plugins#authentication
- Broken anchor on source page path = /faq/questions/using-cypress-faq:
-> linking to /plugins#email
-> linking to /plugins#preprocessors
- Broken anchor on source page path = /guides/core-concepts/writing-and-organizing-tests:
-> linking to /plugins#preprocessors
- Broken anchor on source page path = /guides/overview/why-cypress:
-> linking to /plugins#visual-testing
- Broken anchor on source page path = /guides/references/best-practices:
-> linking to /plugins#email
- Broken anchor on source page path = /guides/tooling/visual-testing:
-> linking to /plugins#visual-testing
Mike McCready commented
- Thanks to @jaffrepaul for fixing this issue in PR #5796 💪🏻 !