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

Recommend the VS Code MDX extension #8897

Merged
merged 5 commits into from
Oct 24, 2023

Conversation

remcohaszing
Copy link
Contributor

Changes

This replaces the the old recommendation to mark MDX files as markdown with the recommendation to use the official MDX extension. MDX supports various constructs that markdown doesn’t, so that leads to bad syntax highlighting.

Testing

This is a documentation-only change.

Docs

This is a documentation-only change.

The old recommendation was to mark MDX files as markdown. MDX supports
various constructs that markdown doesn’t, so that leads to bad syntax
highlighting.
@changeset-bot
Copy link

changeset-bot bot commented Oct 23, 2023

🦋 Changeset detected

Latest commit: 24a60ea

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions github-actions bot added the pkg: integration Related to any renderer integration (scope) label Oct 23, 2023
@natemoo-re natemoo-re added the pr: docs A PR that includes documentation for review label Oct 23, 2023
Copy link
Member

@natemoo-re natemoo-re left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for submitting a PR! Agree that this extension should be the recommendation—it's been a huge quality of life upgrade!

@github-actions github-actions bot removed the pr: docs A PR that includes documentation for review label Oct 23, 2023
Copy link
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @remcohaszing for the update!

If you’re interested in a follow-up, I guess we could also include unifiedjs.vscode-mdx in the recommended extensions in our blog starter project, which uses MDX:

"recommendations": ["astro-build.astro-vscode"],

@github-actions github-actions bot added the pr: docs A PR that includes documentation for review label Oct 24, 2023
@natemoo-re
Copy link
Member

I'm going to merge this since we're about to do a release, but yeah I like @delucis' suggestion as well! If you'd like to open a PR with that change, please do!

@natemoo-re natemoo-re merged commit 5a3d46d into withastro:main Oct 24, 2023
2 checks passed
@astrobot-houston astrobot-houston mentioned this pull request Oct 24, 2023
@remcohaszing remcohaszing deleted the mdx-vscode-extension branch October 24, 2023 18:59
natemoo-re added a commit that referenced this pull request Nov 22, 2023
Co-authored-by: Chris Swithinbank <[email protected]>
Co-authored-by: Nate Moore <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: integration Related to any renderer integration (scope) pr: docs A PR that includes documentation for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants