Visual Studio Code extension for MDX

Adds language support for MDX.

Installation

You can install this extension from the Marketplace.

Settings

This extension provides the following settings:

mdx.experimentalLanguageServer: Enable experimental IntelliSense support for MDX files. (boolean, default: false)

Plugins

This extension supports remark syntax plugins. Plugins can be defined in an array of strings or string / options tuples. These plugins can be defined in tsconfig.json and will be resolved relative to that file.

For example, to support frontmatter with YAML and TOML and GFM:

{
  "compilerOptions": {
    // …
  },
  "mdx": {
    "plugins": [
      [
        "remark-frontmatter",
        ["toml", "yaml"]
      ],
      "remark-gfm"
    ]
  }
}

For a more complete list, see remark plugins.

Integration With VS Code ESLint

First of all, you need to enable eslint-plugin-mdx which makes it possible to lint .mdx or .md files with ESLint.

And then you will need to enable ESLint validation for .mdx and .md files like following:

// .vscode/settings.json
{
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  },
  "eslint.options": {
    "extensions": [".js", ".jsx", ".md", ".mdx", ".ts", ".tsx"]
  },
  "eslint.validate": [
    "markdown",
    "mdx",
    "javascript",
    "javascriptreact",
    "typescript",
    "typescriptreact"
  ]
}

Markdown Syntax

Markdown Syntax could also be linted via eslint-plugin-mdx and remark-lint plugins.

it will read remark’s configuration automatically via cosmiconfig. But .remarkignore will not be respected, you should use .eslintignore instead.

More usage detail please refer to eslint-plugin-mdx’s documentation.

Auto-close tags

If you want VS Code to automatically close tags while you type, you can install Auto Close Tag and configure it to also include the language mdx:

"auto-close-tag.activationOnLanguage": [
  "xml",
  "php",
  "...",
  "mdx"
]

Known `vscode-eslint` issues

Fatal javascript OOM in GC during deserialization

ESlint is using VS Code’s old, built-in version of NodeJS (v12) as provided by Electron. Please add the following setting to use system default Node runtime instead:
```
{
  "eslint.runtime": "node"
}
```
Please visit microsoft/vscode-eslint#1498 (comment) as reference for details.
JavaScript heap out of memory

The default memory limit of Node.js is 1G, please add the following setting to increase the limit:
```
{
  "eslint.execArgv": ["--max_old_space_size=8192"]
}
```
Please visit microsoft/vscode-eslint#733 as reference for details.