@mdx-js/typescript-plugin

[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]

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][vscode-mdx] 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][]:

``sh
npm install @mdx-js/language-service
`

Use

The [MDX extension for Visual Studio Code][vscode-mdx] 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:

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

$3

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

$3

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

This project is compatible Node.js 20.19+.

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][contribute] on our website for ways to get started.
See [§ Support][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][sponsor] on our site for how to help financially.

Vercel		Motif		HashiCorp		GitBook		Gatsby
Netlify		Coinbase	ThemeIsle	Expo	Boost Note	Markdown Space	Holloway
		You?

Changelog

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

License

[MIT][] © [Remco Haszing][author]

[author]: https://github.com/remcohaszing

[backers-badge]: https://opencollective.com/unified/backers/badge.svg

[build]: https://github.com/mdx-js/mdx-analyzer/actions

[build-badge]: https://github.com/mdx-js/mdx-analyzer/workflows/main/badge.svg

[chat]: https://github.com/mdx-js/mdx/discussions

[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg

[code of conduct]: https://github.com/mdx-js/.github/blob/main/code-of-conduct.md

[collective]: https://opencollective.com/unified

[contribute]: https://mdxjs.com/community/contribute/

[coverage]: https://codecov.io/github/mdx-js/mdx-analyzer

[coverage-badge]: https://img.shields.io/codecov/c/github/mdx-js/mdx-analyzer/main.svg

[downloads]: https://www.npmjs.com/package/@mdx-js/language-service

[downloads-badge]: https://img.shields.io/npm/dm/@mdx-js/language-service.svg

[mdx]: https://mdxjs.com

[mit]: LICENSE

[npm]: https://docs.npmjs.com/cli/install

[size]: https://bundlejs.com/?q=@mdx-js/language-service

[size-badge]: https://img.shields.io/bundlejs/size/@mdx-js/language-service

[sponsor]: https://mdxjs.com/community/sponsor/

[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg

[support]: https://mdxjs.com/community/support/

[typescript]: https://typescriptlang.org

[typescript plugin]: https://www.typescriptlang.org/tsconfig#plugins

[vscode-mdx]: https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx