diff options
| author |  Lloyd Atkinson <lloydjatkinson@users.noreply.github.com>
| 2022-09-09 18:13:09 +0100 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2022-09-09 13:13:09 -0400 |
| commit | eb4f6faee6d432f06aca86b4e54fd4a7379004bf (patch) | |
| tree | beb6ae653384ecd7e2fe2ecc7347e95a0499e8fc | |
| parent | 64f11c4ceee3eb38add28a1973886356ff6c8e0b (diff) | |
| download | astro-eb4f6faee6d432f06aca86b4e54fd4a7379004bf.tar.gz astro-eb4f6faee6d432f06aca86b4e54fd4a7379004bf.tar.zst astro-eb4f6faee6d432f06aca86b4e54fd4a7379004bf.zip | |
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 <matthew@matthewphillips.info>
Co-authored-by: Erika <3019731+Princesseuh@users.noreply.github.com>
Co-authored-by: Matthew Phillips <matthew@skypack.dev>
Diffstat (limited to '')
| -rw-r--r-- | packages/integrations/mdx/README.md | 12 |
1 files changed, 12 insertions, 0 deletions
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. |