mdxlint

The Visual Studio Code extension for mdxlint.

Table of Contents

• Installation
• Settings
• Configuration file
• Compatibility
• Related projects
• Sponsoring
• License

Installation

Use Ctrl + P to open the command palette. Then type the following and press Enter:

ext install remcohaszing.vscode-mdxlint

Settings

The mdxlint extension supports the following settings:

• mdxlint.requireConfig (boolean, default: false) — If true, only perform actions if a configuration file is found.

Configuration file

The mdxlint CLI loads one the following configuration files:

• The mdxlint key in package.json
• .mdxlintrc
• .mdxlintrc.json
• .mdxlintrc.js
• .mdxlintrc.cjs
• .mdxlintrc.mjs
• .mdxlintrc.yml
• .mdxlintrc.yaml

For examples, see the mdxlint examples. Ignore patterns can be specified in .mdxlintignore.

Compatibility

This project is compatible with Visual Studio Code 1.103 or greater.

Related projects

• mdxlint provides the CLI.
• mdxlint-language-server provides the language server.

Sponsoring

If you like this project, consider sponsoring me via GitHub Sponsors.

License

MIT © Remco Haszing