Admonitions in partials outside the docs directory are rendered as plain text

[leograba]

🐛 Bug Report

Prerequisites

• [x ] I'm using the latest version of Docusaurus. I'm using the canary release 0.0.0-3914 because it support adding partials from outside the docs plugin directory.

Description

When including a partial from a file outside the doc plugin directory, if the partial contains admonitions then the admonitions are rendered as plain text.

Have you read the Contributing Guidelines on issues?

Yes.

Steps to reproduce

1. Create a new project from the template with npx @docusaurus/init@latest init my-website classic
   1. Update Docusaurus version to a canary release that supports including partials from outside the docs plugin directory, currently 2.0.0-beta.4 does not support it. I've used 0.0.0-3914.
2. Create a new file /docs/test-doc.mdx and a directory and partial file /_shared/test-partial.mdx:
   1. /docs/test-doc.mdx

      ---
      id: test-doc
      ---
      import TabItem from '@theme/TabItem';
      import Tabs from '@theme/Tabs'
      import Partial from '@site/_shared/test-partial.mdx';
      
      # Test Doc #
      
      Some paragraph.
      
      :::info
      
      This is an info panel outside a partial.
      
      :::
      
      <Partial />
      

   2. /_shared/test-partial.mdx

      import Tabs from '@theme/Tabs';
      import TabItem from '@theme/TabItem';
      
      :::info
      
      This is an info panel inside a partial.
      
      :::
      
      <Tabs
      defaultValue="apple"
      values={[
          {label: 'Apple', value: 'apple'},
          {label: 'Orange', value: 'orange'},
          {label: 'Banana', value: 'banana'},
      ]}>
      <TabItem value="apple">This is an apple 🍎</TabItem>
      <TabItem value="orange">This is an orange 🍊</TabItem>
      <TabItem value="banana">This is a banana 🍌</TabItem>
      </Tabs>
      
      ```bash title="source.sh"
      # Source is ok
      $ ls -l .
      \```
      

3. Run npx docusaurus start and navigate to http://localhost:3000/docs/test-doc.

Expected behavior

The admonition from the partial file /_shared/test-partial.mdx (This is an info panel inside a partial.) should be rendered with admonition style instead of plain text.

Actual behavior

There are no errors on npx docusaurus start.

Your environment

• Public source code: https://codesandbox.io/s/youthful-architecture-w2xcy?file=/docs/test-doc.mdx
• Public site URL: https://w2xcy.sse.codesandbox.io/docs/test-doc
• Docusaurus version used: 0.0.0-3914
• Environment name and version: Chrome 92.0.4515.131, Node.js 16.4.0
• Operating system and version: Ubuntu 20.04.2 LTS

Reproducible demo

https://codesandbox.io/s/youthful-architecture-w2xcy?file=/docs/test-doc.mdx

Visit the page https://w2xcy.sse.codesandbox.io/docs/test-doc to see the issue live.

[pranabdas]

@leograba I see you have space between ::: and info in /docs/_test-partial.mdx. I guess it should not be there.

[slorber]

agree, the issue is the extra space

[leograba]

Sorry, indeed I made a syntax issue mistake while creating the initial sandbox environment.

Nevertheless, after fixing the syntax issue and creating a proper setup where the partial is a file outside /docs, I could reproduce the potential bug.

[slorber]

Right, can reproduce the issue 👍 will get this fixed

[slorber]

fixed in #5339