Skip to content
MDX extension for Visual Studio Code
TypeScript Shell JavaScript
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode feat: improve basic grammar support Aug 4, 2019
assets feat: improve basic grammar support Aug 4, 2019
client chore(deps): bump dependencies, use union @1stG configurations Nov 18, 2019
server chore(deps): bump dependencies, use union @1stG configurations Nov 18, 2019
syntaxes feat: improve basic grammar support Aug 4, 2019
.commitlintrc chore(deps): bump dependencies, use union @1stG configurations Nov 18, 2019
.editorconfig feat: first blood, init from vscode examples Jul 30, 2019
.eslintignore chore(deps): bump dependencies, use union @1stG configurations Nov 18, 2019
.eslintrc chore(deps): bump dependencies, use union @1stG configurations Nov 18, 2019
.gitignore chore(deps): bump dependencies, use union @1stG configurations Nov 18, 2019
.huskyrc.js chore(deps): bump dependencies, use union @1stG configurations Nov 18, 2019
.lintstagedrc.js chore(deps): bump dependencies, use union @1stG configurations Nov 18, 2019
.prettierrc chore(deps): bump dependencies, use union @1stG configurations Nov 18, 2019
.renovaterc chore(deps): bump dependencies, use union @1stG configurations Nov 18, 2019
.travis.yml chore(deps): bump dependencies, use union @1stG configurations Nov 18, 2019
.versionrc chore: common coding environment Jul 30, 2019
.vscodeignore chore(deps): bump dependencies, use union @1stG configurations Nov 18, 2019
.yarnrc chore: use @types/vscode and vscode-test instead of vscode package Aug 8, 2019
CHANGELOG.md chore(release): 0.1.3 Nov 18, 2019
LICENSE Initial commit Jul 30, 2019
README.md chore(deps): bump dependencies, use union @1stG configurations Nov 18, 2019
deploy.sh chore(deps): bump dependencies, use union @1stG configurations Nov 18, 2019
language-configuration.json feat: improve basic grammar support Aug 4, 2019
package.json chore(deps): update dependency ts-node to ^8.5.4 Dec 2, 2019
tsconfig.base.json chore(deps): bump dependencies, use union @1stG configurations Nov 18, 2019
tsconfig.json chore(deps): bump dependencies, use union @1stG configurations Nov 18, 2019
yarn.lock chore(deps): update dependency ts-node to ^8.5.4 Dec 2, 2019

README.md

Visual Studio Code extension for MDX

Adds language support for MDX.

Installation

You can install this extension from the Marketplace.

Integration With VS Code ESLint

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

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

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

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"
]
You can’t perform that action at this time.