Skip to content

Commit

Permalink
Recommend the VS Code MDX extension (#8897)
Browse files Browse the repository at this point in the history
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
  • Loading branch information
3 people committed Oct 24, 2023
1 parent 48bf7c3 commit 5a3d46d
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
5 changes: 5 additions & 0 deletions .changeset/slow-cheetahs-marry.md
Original file line number Diff line number Diff line change
@@ -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/).
12 changes: 3 additions & 9 deletions packages/integrations/mdx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 5a3d46d

Please sign in to comment.