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

Enable processing md files as commonmark #734

Merged
merged 3 commits into from
Aug 26, 2024
Merged

Enable processing md files as commonmark #734

merged 3 commits into from
Aug 26, 2024

Conversation

sserrata
Copy link
Member

Description

Docusaurus option that allows docs with .md extension to be processed using commonmark, as opposed to MDX.

Motivation and Context

Currently, upgrading to Docusaurus v3 is blocked by MDX parsing/syntax errors that exist in .md files, including {, <<<, indented code blocks and other cases. The hope is that this change will address the majority or all of the MDX parsing issues encountered when testing upgrading to v3.

See #667 for more background.

How Has This Been Tested?

Will test using the deploy preview

@sserrata sserrata added DO NOT MERGE chore Routine maintenance labels Aug 23, 2024
@sserrata sserrata self-assigned this Aug 23, 2024
Copy link

github-actions bot commented Aug 23, 2024

Visit the preview URL for this PR (updated for commit 08ebffd):

https://pan-dev-f1b58--pr734-fsl9zo9u.web.app

(expires Sun, 22 Sep 2024 20:42:03 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 9359a9fa100d5fdb082f75280473a90b1f96eb51

@sserrata sserrata removed the chore Routine maintenance label Aug 23, 2024
@sserrata sserrata added chore Routine maintenance and removed DO NOT MERGE labels Aug 26, 2024
@sserrata
Copy link
Member Author

Verified that docs with .md extension still render as expected. Will update the contributing docs to explain when .mdx should be chosen over .md and the difference in features supported between the two.

@sserrata sserrata merged commit fb10514 into master Aug 26, 2024
6 checks passed
@sserrata sserrata deleted the markdown-format branch August 26, 2024 14:43
sserrata added a commit that referenced this pull request Sep 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Routine maintenance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant