fix: do not escape GitHub alerts in readmes (#1512)

Workaround for syntax-tree/mdast-util-to-markdown#61
ipfs · May 1, 2024 · 3b58126 · 3b58126
1 parent bfa7622
commit 3b58126
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/src/docs/readme-updater-plugin.js b/src/docs/readme-updater-plugin.js
@@ -237,7 +237,15 @@ function updateReadme (aboutMd, manifestPath, readmePath, app) {
     parsedReadme.children.push(child)
   })
 
-  const updatedReadmeContents = writeMarkdown(parsedReadme)
+  let updatedReadmeContents = writeMarkdown(parsedReadme)
+
+  // workaround for https://github.com/syntax-tree/mdast-util-to-markdown/issues/61
+  updatedReadmeContents = updatedReadmeContents
+    .replaceAll('\\[!NOTE]', '[!NOTE]')
+    .replaceAll('\\[!TIP]', '[!TIP]')
+    .replaceAll('\\[!IMPORTANT]', '[!IMPORTANT]')
+    .replaceAll('\\[!WARNING]', '[!WARNING]')
+    .replaceAll('\\[!CAUTION]', '[!CAUTION]')
 
   fs.writeFileSync(readmePath, updatedReadmeContents, {
     encoding: 'utf-8'