Use nbsp hack to keep former admonition title doc retrocompatible

facebook · Apr 21, 2023 · a8754c5 · a8754c5
1 parent a983945
commit a8754c5
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 17 deletions.
diff --git a/packages/docusaurus-utils/src/markdownUtils.ts b/packages/docusaurus-utils/src/markdownUtils.ts
@@ -92,8 +92,8 @@ export function admonitionTitleToDirectiveLabel(
   content: string,
   admonitionContainerDirectives: string[],
 ): string {
-  // TODO this will also process ":::note Title" inside docs code blocks
-  // Probably not very important and we should now use directive labels?
+  // this will also process ":::note Title" inside docs code blocks
+  // good enough: we fixed older versions docs to not be affected
 
   const directiveNameGroup = `(${admonitionContainerDirectives.join('|')})`;
   const regexp = new RegExp(

diff --git a/...d_docs/version-2.0.1/guides/markdown-features/markdown-features-admonitions.mdx b/...d_docs/version-2.0.1/guides/markdown-features/markdown-features-admonitions.mdx
@@ -110,7 +110,7 @@ Hello world
 You may also specify an optional title.
 
 ```md
-:::note Your Title
+:::note Your Title
 
 Some **content** with _Markdown_ `syntax`.
 
@@ -138,7 +138,9 @@ import Tabs from '@theme/Tabs';
 
 import TabItem from '@theme/TabItem';
 
-:::tip Use tabs in admonitions
+:::tip
+
+Use tabs in admonitions
 
 <Tabs>
   <TabItem value="apple" label="Apple">This is an apple 🍎</TabItem>
@@ -152,7 +154,9 @@ import TabItem from '@theme/TabItem';
 ```mdx-code-block
 <BrowserWindow>
 
-:::tip Use tabs in admonitions
+:::tip
+
+Use tabs in admonitions
 
 <Tabs>
   <TabItem value="apple" label="Apple">This is an apple 🍎</TabItem>

diff --git a/...d_docs/version-2.1.0/guides/markdown-features/markdown-features-admonitions.mdx b/...d_docs/version-2.1.0/guides/markdown-features/markdown-features-admonitions.mdx
@@ -110,7 +110,7 @@ Hello world
 You may also specify an optional title.
 
 ```md
-:::note Your Title
+:::note Your Title
 
 Some **content** with _Markdown_ `syntax`.
 
@@ -138,7 +138,9 @@ import Tabs from '@theme/Tabs';
 
 import TabItem from '@theme/TabItem';
 
-:::tip Use tabs in admonitions
+:::tip
+
+Use tabs in admonitions
 
 <Tabs>
   <TabItem value="apple" label="Apple">This is an apple 🍎</TabItem>
@@ -152,7 +154,9 @@ import TabItem from '@theme/TabItem';
 ```mdx-code-block
 <BrowserWindow>
 
-:::tip Use tabs in admonitions
+:::tip
+
+Use tabs in admonitions
 
 <Tabs>
   <TabItem value="apple" label="Apple">This is an apple 🍎</TabItem>

diff --git a/...d_docs/version-2.2.0/guides/markdown-features/markdown-features-admonitions.mdx b/...d_docs/version-2.2.0/guides/markdown-features/markdown-features-admonitions.mdx
@@ -110,7 +110,7 @@ Hello world
 You may also specify an optional title.
 
 ```md
-:::note Your Title
+:::note Your Title
 
 Some **content** with _Markdown_ `syntax`.
 
@@ -138,7 +138,9 @@ import Tabs from '@theme/Tabs';
 
 import TabItem from '@theme/TabItem';
 
-:::tip Use tabs in admonitions
+:::tip
+
+Use tabs in admonitions
 
 <Tabs>
   <TabItem value="apple" label="Apple">This is an apple 🍎</TabItem>
@@ -152,7 +154,9 @@ import TabItem from '@theme/TabItem';
 ```mdx-code-block
 <BrowserWindow>
 
-:::tip Use tabs in admonitions
+:::tip
+
+Use tabs in admonitions
 
 <Tabs>
   <TabItem value="apple" label="Apple">This is an apple 🍎</TabItem>

diff --git a/...d_docs/version-2.3.1/guides/markdown-features/markdown-features-admonitions.mdx b/...d_docs/version-2.3.1/guides/markdown-features/markdown-features-admonitions.mdx
@@ -110,7 +110,7 @@ Hello world
 You may also specify an optional title.
 
 ```md
-:::note Your Title
+:::note Your Title
 
 Some **content** with _Markdown_ `syntax`.
 
@@ -138,7 +138,9 @@ import Tabs from '@theme/Tabs';
 
 import TabItem from '@theme/TabItem';
 
-:::tip Use tabs in admonitions
+:::tip
+
+Use tabs in admonitions
 
 <Tabs>
   <TabItem value="apple" label="Apple">This is an apple 🍎</TabItem>
@@ -152,7 +154,9 @@ import TabItem from '@theme/TabItem';
 ```mdx-code-block
 <BrowserWindow>
 
-:::tip Use tabs in admonitions
+:::tip
+
+Use tabs in admonitions
 
 <Tabs>
   <TabItem value="apple" label="Apple">This is an apple 🍎</TabItem>

diff --git a/...d_docs/version-2.4.0/guides/markdown-features/markdown-features-admonitions.mdx b/...d_docs/version-2.4.0/guides/markdown-features/markdown-features-admonitions.mdx
@@ -110,7 +110,7 @@ Hello world
 You may also specify an optional title.
 
 ```md
-:::note Your Title
+:::note Your Title
 
 Some **content** with _Markdown_ `syntax`.
 
@@ -138,7 +138,9 @@ import Tabs from '@theme/Tabs';
 
 import TabItem from '@theme/TabItem';
 
-:::tip Use tabs in admonitions
+:::tip
+
+Use tabs in admonitions
 
 <Tabs>
   <TabItem value="apple" label="Apple">This is an apple 🍎</TabItem>
@@ -152,7 +154,9 @@ import TabItem from '@theme/TabItem';
 ```mdx-code-block
 <BrowserWindow>
 
-:::tip Use tabs in admonitions
+:::tip
+
+Use tabs in admonitions
 
 <Tabs>
   <TabItem value="apple" label="Apple">This is an apple 🍎</TabItem>