Skip to content

docs: fix stale API anchors in the v11 upgrade guide - #4563

Open
guitarmanchan911-byte wants to merge 1 commit into
highlightjs:mainfrom
guitarmanchan911-byte:docs/fix-v11-api-anchors
Open

guitarmanchan911-byte wants to merge 1 commit into
highlightjs:mainfrom
guitarmanchan911-byte:docs/fix-v11-api-anchors

Conversation

@guitarmanchan911-byte

Copy link
Copy Markdown

Changes

The v11 upgrade guide links to two anchors on the API documentation page that no longer exist, so both links land at the top of the page instead of at the function docs:

  • api.html#highlight-all -> #highlightall
  • api.html#highlight-element -> #highlightelement

Verified against the rendered page (https://highlightjs.readthedocs.io/en/latest/api.html): it contains id="highlightall" and id="highlightelement", and no occurrence of highlight-all or highlight-element. The sidebar on that page uses the same two anchors, so this just matches the docs as they are today.

docs/upgrade-11.md is a symlink to VERSION_11_UPGRADE.md, so the docs site picks the change up from the one file.

Scope note: while checking this I found one more stale link of the same kind — CHANGES.md points at highlightjs.readthedocs.org/.../style-guide.html, which 404s (that page is now language-contribution.html). I left it out since CHANGES.md is a historical changelog; say the word if you would prefer it in this PR or in a separate one.

Checklist

  • Added markup tests, or they do not apply here because this is a documentation-only link fix: no parser, grammar or theme behaviour is touched.
  • I have read and followed our AI-assisted contributions policy (human review, no slop)

Assisted-by: Codex (GPT-5)

The upgrade guide points at two anchors on the API docs page that no longer exist, so the links land at the top of the page instead of the function docs:

- api.html#highlight-all -> #highlightall

- api.html#highlight-element -> #highlightelement

Both old anchors are absent from the rendered page (https://highlightjs.readthedocs.io/en/latest/api.html), while the two replacements are present and match the documented function names.

docs/upgrade-11.md is a symlink to this file, so the docs site picks the change up automatically.

Assisted-by: Codex (GPT-5)

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant