diff options
| author |  Remco Haszing <remcohaszing@gmail.com>
| 2023-10-24 18:04:59 +0200 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2023-10-24 11:04:59 -0500 |
| commit | 5a3d46da1e80f62a29eaf464eeb87c626cc5593f (patch) | |
| tree | 24f86742ed6b9ab97714d407a1e42ba022e58338 | |
| parent | 48bf7c3de6f5805e07ca8fa3076d01090593dcf1 (diff) | |
| download | astro-5a3d46da1e80f62a29eaf464eeb87c626cc5593f.tar.gz astro-5a3d46da1e80f62a29eaf464eeb87c626cc5593f.tar.zst astro-5a3d46da1e80f62a29eaf464eeb87c626cc5593f.zip | |
Recommend the VS Code MDX extension (#8897)
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
| -rw-r--r-- | .changeset/slow-cheetahs-marry.md | 5 | ||||
| -rw-r--r-- | packages/integrations/mdx/README.md | 12 |
2 files changed, 8 insertions, 9 deletions
diff --git a/.changeset/slow-cheetahs-marry.md b/.changeset/slow-cheetahs-marry.md new file mode 100644 index 000000000..547543eae --- /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 355c02242..df0458ce9 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. - -```json title=".vscode/settings.json" -{ - "files.associations": { - "*.mdx": "markdown" - } -} -``` +For editor support in [VS Code](https://code.visualstudio.com/), install the [official MDX extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx). + +For other editors, use the [MDX language server](https://github.com/mdx-js/mdx-analyzer/tree/main/packages/language-server). ## Usage |