3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-03 20:27:20 +02:00
Code Issues Projects Releases Packages Wiki Activity

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

Browse source
This commit is contained in:
Sébastien Lorber 2023-11-21 20:49:34 +01:00 • committed by GitHub
parent 2c0bf8a3d8
commit 7c32fc341f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 69 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
packages/docusaurus-utils/src/__tests__/markdownUtils.test.ts
View file

@ -1366,6 +1366,57 @@ before
\t\t::: \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 after
`); `);
}); });

6
packages/docusaurus-utils/src/markdownUtils.ts
View file

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

14
website/_dogfooding/_docs tests/tests/admonitions.mdx
View file

@ -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 ## Official admonitions
Admonitions that are [officially documented](/docs/markdown-features/admonitions) Admonitions that are [officially documented](/docs/markdown-features/admonitions)