Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(mdx-loader): allow spaces before mdx-code-block info string #9776

Merged
merged 2 commits into from
Jan 24, 2024

Conversation

eitsupi
Copy link
Contributor

@eitsupi eitsupi commented Jan 22, 2024

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

I have a website using Quarto and Docusaurus, and after updating Docusaurus from v2 to v3, I noticed that mdx-code-block was broken.
The issue is here: quarto-dev/quarto-cli#8333

Pandoc (used internally by Quarto CLI) adds spaces between backticks and info strings when outputting Markdown files.
e.g.

```foo
bar
```

to

``` foo
bar
```

The current Docusaurus does not allow this space, which would prevent it from rendering as intended.

In v2, spaces were allowed. This difference doesn't seem to be what was intended, so I opened this PR thinking I might be able to fix it here.

This is just a simple regular expression modification.

Test Plan

Test links

Related issues/PRs

@eitsupi eitsupi requested a review from slorber as a code owner January 22, 2024 04:35
@facebook-github-bot
Copy link
Contributor

Hi @eitsupi!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

Copy link

netlify bot commented Jan 22, 2024

[V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit 697afd0
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/65adf0a6d06f290008c274b3
😎 Deploy Preview https://deploy-preview-9776--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🔴 42 🟢 98 🟢 100 🟢 100 🟠 89 Report
/docs/installation 🟠 86 🟢 98 🟢 100 🟢 100 🟠 89 Report
/docs/category/getting-started 🟠 76 🟢 100 🟢 100 🟢 90 🟠 89 Report
/blog 🟠 64 🟢 100 🟢 100 🟢 90 🟠 89 Report
/blog/preparing-your-site-for-docusaurus-v3 🟠 62 🟢 97 🟢 100 🟢 100 🟠 89 Report
/blog/tags/release 🟠 70 🟢 100 🟢 100 🟠 80 🟠 89 Report
/blog/tags 🟠 76 🟢 100 🟢 100 🟢 90 🟠 89 Report

@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Jan 22, 2024
@slorber slorber added pr: bug fix This PR fixes a bug in a past release. to backport This PR is planned to be backported to a stable version of Docusaurus labels Jan 24, 2024
@slorber
Copy link
Collaborator

slorber commented Jan 24, 2024

Thanks

Yes that seems to be a reasonable thing to support considering Markdown/MDX usually allow passing code block languages with spaces.

This regression only appeared because the way we have to handle mdx-code-block items in Docusaurus/MDX v3 is significantly different from before, and not super clean unfortunately. We did our best to keep this feature working but it doesn't play super well with MDX v3.

@slorber slorber changed the title fix: allow spaces before mdx-code-block info string fix(mdx-loader): allow spaces before mdx-code-block info string Jan 24, 2024
@slorber slorber merged commit 0266549 into facebook:main Jan 24, 2024
31 checks passed
@eitsupi eitsupi deleted the allow-spaces branch January 24, 2024 13:27
@eitsupi
Copy link
Contributor Author

eitsupi commented Jan 24, 2024

Thanks for merging!

slorber added a commit that referenced this pull request Jan 26, 2024
Co-authored-by: Joshua Chen <[email protected]>
Co-authored-by: Joey Clover <[email protected]>
Co-authored-by: reece-white <[email protected]>
Co-authored-by: Shreesh Nautiyal <[email protected]>
Co-authored-by: Nick Gerleman <[email protected]>
Co-authored-by: Chongyi Zheng <[email protected]>
Co-authored-by: MCR Studio <[email protected]>
Co-authored-by: sebastienlorber <[email protected]>
Co-authored-by: Sébastien Lorber <[email protected]>
Co-authored-by: Ivan Mar (sOkam!) <[email protected]>
Co-authored-by: c0h1b4 <[email protected]>
Co-authored-by: Janessa Garrow <[email protected]>
Co-authored-by: ozaki <[email protected]>
Co-authored-by: axmmisaka <[email protected]>
Co-authored-by: Tatsunori Uchino <[email protected]>
Co-authored-by: Simen Bekkhus <[email protected]>
Co-authored-by: Sanjaiyan Parthipan <[email protected]>
Co-authored-by: Jack Robson <[email protected]>
Co-authored-by: dawei-wang <[email protected]>
Co-authored-by: eitsupi <[email protected]>
fix(create-docusaurus): fix readme docusaurus 2 ref (#9487)
fix(theme): fix firefox CSS :has() support bug (#9530)
fix(theme): docs html sidebar items should always be visible (#9531)
fix: v3 admonitions should support v2 title syntax for nested admonitions (#9535)
fix(theme-classic): fixed wrong cursor on dropdown menu in navbar, when window is small (#9398)
fix(theme): upgrade prism-react-renderer, fix html script and style tag highlighting (#9567)
fix: add v2 retrocompatible support for quoted admonitions (#9570)
fix(i18n): complete translations for theme-common.json Brazilian Portuguese (pt-BR) (#9477)
fix(content-blog): add baseUrl for author.image_url (#9581)
fix(type-aliases): add `title` prop for imported inline SVG React components (#9612)
fix(utils): Markdown link replacement with <> but no spaces (#9617)
fix(live-codeblock): stabilize react-live transformCode callback, fix editor/preview desync (#9631)
fix(cli): output help when no conventional config + no subcommand (#9648)
fix CI job (#9604)
fix Lint Autofix workflow (#9632)
fix(pwa-plugin): upgrade workbox (#9668)
fix(create-docusaurus): fix init template code blocks, and little improvements (#9696)
fix(theme): allow empty code blocks and live playgrounds (#9704)
fix(core): various broken anchor link fixes (#9732)
fix: remove old useless mdx typedefs (#9733)
fix(theme-common): fix missing code block MagicComments style in Visual Basic (.NET) 16 (#9727)
fix(core): conditionally include `hostname` parameter when using… (#9407)
fix(create-docusaurus): fix typo in init template sample docs (#9783)
fix(mdx-loader): allow spaces before `mdx-code-block` info string (#9776)
fix(core): links with target "_blank" should no be checked by the broken link checker (#9788)
fix(core): broken links optimization behaves differently than non-optimized logic (#9791)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: bug fix This PR fixes a bug in a past release. to backport This PR is planned to be backported to a stable version of Docusaurus
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants