Skip to content

fix: Fix escaping of examples in JSDoc #1332

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix: Fix escaping of examples in JSDoc #1332

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e876132
Fix escaping of examples in JSDoc
DominikRusso May 10, 2025
33ac00e
Merge branch 'main' into issue-1283
eltigerchino Jul 31, 2025
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
8 changes: 8 additions & 0 deletions packages/site-kit/src/lib/markdown/renderer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -785,6 +785,14 @@ async function syntax_highlight({

html = html.replace(/ {27,}/g, () => redactions.shift()!);

/**
* @shikijs/twoslash (as of v3.2.1) returns `<` in code blocks
* inside of type tooltip-popups as `&#x3C;`.
*
* See {@link https://github.com/sveltejs/svelte.dev/issues/1283}.
*/
html = html.replaceAll('&#x3C;', '<');

if (check) {
// munge the twoslash output so that it renders sensibly. the order of operations
// here is important — we need to work backwards, to avoid corrupting the offsets
Expand Down