fix: add v2 retrocompatible support for quoted admonitions (#9570)

facebook · Nov 21, 2023 · 7c32fc3 · 7c32fc3
1 parent 2c0bf8a
commit 7c32fc3
Show file tree

Hide file tree

Showing 3 changed files with 69 additions and 2 deletions.
diff --git a/packages/docusaurus-utils/src/__tests__/markdownUtils.test.ts b/packages/docusaurus-utils/src/__tests__/markdownUtils.test.ts
@@ -1366,6 +1366,57 @@ before
 
 \t\t:::
 
+after
+    `);
+  });
+
+  it('transforms directives in quotes', () => {
+    expect(
+      admonitionTitleToDirectiveLabel(
+        `
+before
+
+> :::caution There be dragons
+>
+> This is the admonition content
+>
+> :::
+>
+>> :::caution There be dragons
+>>
+>> This is the admonition content
+>>
+>> :::
+> > :::caution There be dragons
+> >
+> > This is the admonition content
+> >
+> > :::
+
+after
+    `,
+        directives,
+      ),
+    ).toBe(`
+before
+
+> :::caution[There be dragons]
+>
+> This is the admonition content
+>
+> :::
+>
+>> :::caution[There be dragons]
+>>
+>> This is the admonition content
+>>
+>> :::
+> > :::caution[There be dragons]
+> >
+> > This is the admonition content
+> >
+> > :::
+
 after
     `);
   });

diff --git a/packages/docusaurus-utils/src/markdownUtils.ts b/packages/docusaurus-utils/src/markdownUtils.ts
@@ -97,14 +97,16 @@ export function admonitionTitleToDirectiveLabel(
 
   const directiveNameGroup = `(${admonitionContainerDirectives.join('|')})`;
   const regexp = new RegExp(
-    `^(?<indentation>( +|\t+))?(?<directive>:{3,}${directiveNameGroup}) +(?<title>.*)$`,
+    `^(?<quote>(> ?)*)(?<indentation>( +|\t+))?(?<directive>:{3,}${directiveNameGroup}) +(?<title>.*)$`,
     'gm',
   );
 
   return content.replaceAll(regexp, (substring, ...args: any[]) => {
     const groups = args.at(-1);
 
-    return `${groups.indentation ?? ''}${groups.directive}[${groups.title}]`;
+    return `${groups.quote ?? ''}${groups.indentation ?? ''}${
+      groups.directive
+    }[${groups.title}]`;
   });
 }
 

diff --git a/website/_dogfooding/_docs tests/tests/admonitions.mdx b/website/_dogfooding/_docs tests/tests/admonitions.mdx
@@ -74,6 +74,20 @@ See admonition title v2 compat syntax bug: https://github.com/facebook/docusauru
 
   :::
 
+## Quoted admonitions
+
+> :::caution There be dragons
+>
+> This is the admonition content
+>
+> :::
+>
+> > :::caution There be dragons
+> >
+> > This is the admonition content
+> >
+> > :::
+
 ## Official admonitions
 
 Admonitions that are [officially documented](/docs/markdown-features/admonitions)