@mdx-js/typescript-plugin

A TypeScript plugin to support language features in MDX files.

Contents

• What is this?
• When should I use this?
• Install
• Use
  • TypeScript
  • Plugins
• API
• Compatibility
• Security
• Contribute
• Sponsor
• Changelog
• License

What is this?

This package provides a TypeScript plugin for MDX. This TypeScript plugin provides editor features such as completion and diagnostics in TypeScript based editors.

When should I use this?

The MDX extension for Visual Studio Code registers this plugin by default. Other editors may install this in their own integration. You can also choose to install the plugin in your project locally in order to pin a version.

Install

In Node.js (version 16+), install with npm:

npm install @mdx-js/language-service

Use

The MDX extension for Visual Studio Code registers this plugin by default. Other editors may install this in their own integration.

If you wish to add this plugin manually, add the following to your tsconfig.json file:

{
  "compilerOptions": {
    "plugins": [
      {
        "name": "@mdx-js/typescript-plugin"
      }
    ]
  }
}

TypeScript

For further instruction, see the TypeScript section of the repository readme.

Plugins

For information on plugin support, see the Plugins section of the repository readme.

API

This package exports a TypeScript plugin. This is not intended for programmatic use.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

Security

This package provides editor support for MDX files. Some editor features modify your source code, for example suggestions and automatic refactors. It is recommended to keep your source code under version control.

Contribute

See § Contribute on our website for ways to get started. See § Support for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

Sponsor

See § Sponsor on our site for how to help financially.

Changelog

Detailed changes for each release are documented in CHANGELOG.md.

License

MIT © Remco Haszing