Skip to content

remcohaszing/mdxlint-language-server

mdxlint

github actions npm version npm downloads

A language server for mdxlint.

Table of Contents

Installation

npm install mdxlint-language-server

Usage

The mdxlint language server supports the following LSP features:

LSP settings

The mdxlint language server 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.

Plugins

The plugins property specifies which plugins or presets to load. All remark plugins and remark-lint rules are supported.

Settings

The settings property specifies how content is formatted. It accepts the same fields as the options from remark-stringify.

Compatibility

This project is compatible with Node.js 20 or greater and uses LSP version 3.17.

Related projects

Sponsoring

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

License

MIT © Remco Haszing

Sponsor this project