Skip to content

Fix code block with PowerShell crashing published pages in Safari #3483

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

Closed
wants to merge 2 commits into from
Closed

Fix code block with PowerShell crashing published pages in Safari #3483

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6a3e1cf
Fix code block crashing published page in Safari
clairechabas Jul 18, 2025
ad4f27c
add changeset
clairechabas Jul 18, 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
5 changes: 5 additions & 0 deletions .changeset/wet-wolves-provide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"gitbook": patch
---

Fix code block with PowerShell crashing page in Safari
11 changes: 9 additions & 2 deletions packages/gitbook/src/components/DocumentView/CodeBlock/highlight.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ export type RenderedInline = {
body: React.ReactNode;
};

const isSafari =
typeof navigator !== 'undefined' && /^((?!chrome|android).)*safari/i.test(navigator.userAgent);

const theme = createCssVariablesTheme();

const { getSingletonHighlighter } = createSingletonShorthands(
Expand Down Expand Up @@ -65,8 +68,12 @@ export async function highlight(
inlines: RenderedInline[]
): Promise<HighlightLine[]> {
const langName = getBlockLang(block);
if (!langName) {
// Language not found, fallback to plain highlighting
if (!langName || (isSafari && langName === 'powershell')) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If powershell doesn't work, it's a bug in shiki. I saw our shiki is a few versions behind, did you try updating it and seeing if it's been fixed?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of hard-coding such condition; should we be more safe and wrap the whole thing in a try...catch and fallback to plainHighlight if it fails?

This looks like too much hard-coded to me and if it fails for this, it could fail for others.

// Fallback to plain highlighting if
// - language is not found
// - language is `powershell` and browser is Safari:
// PowerShell commands can trigger complex regex that Safari
// JS engine doesn't support, causing the highlighter to crash.
return plainHighlight(block, inlines);
}

Expand Down