Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document editors that support MDX language server #475

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document editors that support MDX language server #475

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 31 additions & 4 deletions packages/language-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ A [language server][lsp] for [MDX][].
* [Configuration](#configuration)
* [TypeScript](#typescript)
* [Plugins](#plugins)
* [Examples](#examples)
* [Editors](#editors)
* [Emacs](#emacs)
* [Neovim](#neovim)
* [Visual Studio Code](#visual-studio-code)
* [Compatibility](#compatibility)
* [Security](#security)
Expand Down Expand Up @@ -124,16 +126,33 @@ For information on plugin support, see the
[Plugins section](https://github.com/mdx-js/mdx-analyzer#plugins) of the
repository readme.

## Examples
## Editors

MDX language server can be integrated with any server that supports
MDX language server can be integrated with any editor that supports
[language servers][lsp].
Does your editor support MDX language server, but is it not in this list?
Feel free to add it.

### Emacs

Use [`lsp-mode`][lsp-mode] to use the MDX language server with Emacs.

### Neovim

You can add MDX support to MDX via [`nvim-lspconfig`][nvim-lspconfig].
After installing MDX language server, add the language server setup to your
`init.lua`.

```lua
require'lspconfig'.mdx_analyzer.setup{}
```

For more details, see the
[`nvim-lspconfig` MDX analyzer][nvim-lspconfig mdx-analyzer] documentation.

### Visual Studio Code

Use `unifiedjs.vscode-mdx` to use the MDX language server with
Use [`unifiedjs.vscode-mdx`][vscode-mdx] to use the MDX language server with
[Visual Studio Code][vscode].

## Compatibility
Expand Down Expand Up @@ -271,12 +290,18 @@ Detailed changes for each release are documented in [CHANGELOG.md](./CHANGELOG.m

[lsp]: https://microsoft.github.io/language-server-protocol

[lsp-mode]: https://github.com/emacs-lsp/lsp-mode

[mdx]: https://mdxjs.com

[mit]: LICENSE

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

[nvim-lspconfig]: https://github.com/neovim/nvim-lspconfig

[nvim-lspconfig mdx-analyzer]: https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#mdx_analyzer

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

[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
Expand All @@ -294,3 +319,5 @@ Detailed changes for each release are documented in [CHANGELOG.md](./CHANGELOG.m
[vscode-languageserver]: https://github.com/microsoft/vscode-languageserver-node/tree/main/server

[vscode]: https://code.visualstudio.com

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