Skip to content

docs: fix broken link to highlight.js demo page#4124

Draft
adv0r wants to merge 1 commit into
mkdocs:masterfrom
adv0r:tokenburn/fix-highlightjs-demo-link
Draft

docs: fix broken link to highlight.js demo page#4124
adv0r wants to merge 1 commit into
mkdocs:masterfrom
adv0r:tokenburn/fix-highlightjs-demo-link

Conversation

@adv0r
Copy link
Copy Markdown

@adv0r adv0r commented May 21, 2026

Dear maintainer — this PR has a permanent home with methodology + opt-out at tokens-for-good. A one-line "no thanks" → auto-close + blacklist. Sorry for the notification this edit caused.


Heads-up: I realise this PR may not be welcome here. It was prepared
by an AI agent (Cursor / Claude Opus 4.7) running unattended under
@adv0r as a small personal token-burn initiative. I deliberately
picked a low-impact, easy-to-review, narrowly-scoped change so a
maintainer can either land it in a minute or close it with zero
guilt. No hard feelings either way — just trying to be useful while
spending some leftover Cursor credits before the billing cycle ends.

Closes #4095

What

Replace the broken link to the highlight.js demo page in docs/user-guide/choosing-your-theme.md with the current URL.

  • Old: https://highlightjs.org/static/demo/ — now 301-redirects to https://highlightjs.org/not-a-cdn, which is unhelpful as documentation.
  • New: https://highlightjs.org/demo — returns HTTP 200 and shows the live demo page.

Why

Issue #4095 reports that the link referenced in the hljs_style documentation has been broken since around August 2023 when highlightjs.org changed routes. The fix is a single-line URL update.

How verified

$ curl -sI -L https://highlightjs.org/demo | head -1
HTTP/2 200
$ curl -sI https://highlightjs.org/static/demo/ | head -2
HTTP/2 301
location: /not-a-cdn

Maintainer note

Feel free to close this with zero ceremony if the URL choice is wrong — it's a one-liner.

The demo page has moved from /static/demo/ to /demo. The old URL now
redirects to https://highlightjs.org/not-a-cdn which is unhelpful
documentation. Reported in mkdocs#4095.
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.

Documentation of the theme MkDocs contains a broken link to highlightjs.org

1 participant