From d02d1e923aacdb1e8061a3f76af30e8a13518277 Mon Sep 17 00:00:00 2001
From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
Date: Thu, 18 Apr 2024 21:56:28 +0530
Subject: [PATCH] fix(build/regression): markdown backslash escapes not working

closes #3808
---
 src/node/markdown/markdown.ts                | 11 ++++-------
 src/node/markdown/plugins/restoreEntities.ts | 19 +++++++++++++++++++
 2 files changed, 23 insertions(+), 7 deletions(-)
 create mode 100644 src/node/markdown/plugins/restoreEntities.ts

diff --git a/src/node/markdown/markdown.ts b/src/node/markdown/markdown.ts
index 199980ba..c225d2b5 100644
--- a/src/node/markdown/markdown.ts
+++ b/src/node/markdown/markdown.ts
@@ -14,8 +14,8 @@ import { sfcPlugin, type SfcPluginOptions } from '@mdit-vue/plugin-sfc'
 import { titlePlugin } from '@mdit-vue/plugin-title'
 import { tocPlugin, type TocPluginOptions } from '@mdit-vue/plugin-toc'
 import { slugify } from '@mdit-vue/shared'
-import MarkdownIt from 'markdown-it'
 import type { Options } from 'markdown-it'
+import MarkdownIt from 'markdown-it'
 import anchorPlugin from 'markdown-it-anchor'
 import attrsPlugin from 'markdown-it-attrs'
 // @ts-expect-error: types of markdown-it-emoji are not up-to-date
@@ -29,14 +29,15 @@ import type {
 } from 'shiki'
 import type { Logger } from 'vite'
 import { containerPlugin, type ContainerOptions } from './plugins/containers'
+import { gitHubAlertsPlugin } from './plugins/githubAlerts'
 import { highlight } from './plugins/highlight'
 import { highlightLinePlugin } from './plugins/highlightLines'
 import { imagePlugin, type Options as ImageOptions } from './plugins/image'
 import { lineNumberPlugin } from './plugins/lineNumbers'
 import { linkPlugin } from './plugins/link'
 import { preWrapperPlugin } from './plugins/preWrapper'
+import { restoreEntities } from './plugins/restoreEntities'
 import { snippetPlugin } from './plugins/snippet'
-import { gitHubAlertsPlugin } from './plugins/githubAlerts'
 
 export type { Header } from '../shared'
 
@@ -205,11 +206,7 @@ export const createMarkdownRenderer = async (
   })
 
   md.linkify.set({ fuzzyLink: false })
-
-  // disable entity decode/escape from markdown-it, as the Vue compiler already
-  // decodes them.
-  md.disable('entity')
-  md.renderer.rules.text = (tokens, idx) => tokens[idx].content
+  md.use(restoreEntities)
 
   if (options.preConfig) {
     options.preConfig(md)
diff --git a/src/node/markdown/plugins/restoreEntities.ts b/src/node/markdown/plugins/restoreEntities.ts
new file mode 100644
index 00000000..d15bc522
--- /dev/null
+++ b/src/node/markdown/plugins/restoreEntities.ts
@@ -0,0 +1,19 @@
+import type MarkdownIt from 'markdown-it'
+
+export function restoreEntities(md: MarkdownIt): void {
+  md.core.ruler.before('text_join', 'entity', (state) => {
+    for (const token of state.tokens) {
+      if (token.type !== 'inline' || !token.children) continue
+
+      for (const child of token.children) {
+        if (child.type === 'text_special' && child.info === 'entity') {
+          child.type = 'entity'
+        }
+      }
+    }
+  })
+
+  md.renderer.rules.entity = (tokens, idx) => {
+    return tokens[idx].markup // leave as is so Vue can handle it
+  }
+}