From eb4f6faee6d432f06aca86b4e54fd4a7379004bf Mon Sep 17 00:00:00 2001 From: Lloyd Atkinson Date: Fri, 9 Sep 2022 18:13:09 +0100 Subject: [PATCH] docs: add section on .mdx file support in VS Code (#4694) * docs: add section on .mdx file support in VS Code * Update packages/integrations/mdx/README.md Co-authored-by: Erika <3019731+Princesseuh@users.noreply.github.com> Co-authored-by: Matthew Phillips Co-authored-by: Erika <3019731+Princesseuh@users.noreply.github.com> Co-authored-by: Matthew Phillips --- packages/integrations/mdx/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/packages/integrations/mdx/README.md b/packages/integrations/mdx/README.md index 52568ea04..181e55faa 100644 --- a/packages/integrations/mdx/README.md +++ b/packages/integrations/mdx/README.md @@ -57,6 +57,18 @@ export default defineConfig({ }); ``` +Finally, restart the dev server. + +### 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" +} +``` + ## Usage You can [add MDX pages to your project](https://docs.astro.build/en/guides/markdown-content/#markdown-and-mdx-pages) by adding `.mdx` files within your `src/pages/` directory.