From 5a3d46da1e80f62a29eaf464eeb87c626cc5593f Mon Sep 17 00:00:00 2001 From: Remco Haszing Date: Tue, 24 Oct 2023 18:04:59 +0200 Subject: [PATCH] Recommend the VS Code MDX extension (#8897) Co-authored-by: Chris Swithinbank Co-authored-by: Nate Moore --- .changeset/slow-cheetahs-marry.md | 5 +++++ packages/integrations/mdx/README.md | 10 ++-------- 2 files changed, 7 insertions(+), 8 deletions(-) create mode 100644 .changeset/slow-cheetahs-marry.md diff --git a/.changeset/slow-cheetahs-marry.md b/.changeset/slow-cheetahs-marry.md new file mode 100644 index 0000000000..547543eae0 --- /dev/null +++ b/.changeset/slow-cheetahs-marry.md @@ -0,0 +1,5 @@ +--- +"@astrojs/mdx": patch +--- + +Update the README to suggest that users install the [official MDX extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) for [VS Code](https://code.visualstudio.com/). diff --git a/packages/integrations/mdx/README.md b/packages/integrations/mdx/README.md index 355c02242e..df0458ce9e 100644 --- a/packages/integrations/mdx/README.md +++ b/packages/integrations/mdx/README.md @@ -56,15 +56,9 @@ Then, apply this integration to your `astro.config.*` file using the `integratio ### Editor Integration -[VS Code](https://code.visualstudio.com/) supports Markdown by default. However, for MDX editor support, you may wish to add the following setting in your VSCode config. This ensures authoring MDX files provides a Markdown-like editor experience. +For editor support in [VS Code](https://code.visualstudio.com/), install the [official MDX extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx). -```json title=".vscode/settings.json" -{ - "files.associations": { - "*.mdx": "markdown" - } -} -``` +For other editors, use the [MDX language server](https://github.com/mdx-js/mdx-analyzer/tree/main/packages/language-server). ## Usage