Skip to content

Commit

Permalink
doc: Document more integration options
Browse files Browse the repository at this point in the history
  • Loading branch information
artempyanykh committed Aug 27, 2022
1 parent fd2fc28 commit 3c20aef
Showing 1 changed file with 26 additions and 12 deletions.
38 changes: 26 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,18 +44,27 @@ for wiki-links to detect broken references and duplicate/ambiguous headings.
* VSCode via [Marksman VSCode][mn-vscode].
* Neovim:
* via [nvim-lsp-installer][nvim-marksman-lsp-installer] (automatic server installation),
* via [nvim-lspconfig][nvim-marksman].
* Emacs via [LSP Mode](https://emacs-lsp.github.io/lsp-mode/page/lsp-marksman/) (automatic server installation).

Example config for `use-package` users:

```lisp
(use-package markdown-mode
:hook (markdown-mode . lsp)
:config
(require 'lsp-marksman))
```

* via [nvim-lspconfig][nvim-marksman],
* via [CoC-marksman][coc-marksman].
* Emacs:
* via [LSP Mode](https://emacs-lsp.github.io/lsp-mode/page/lsp-marksman/) (automatic server installation).

Example config for `use-package` users:

```lisp
(use-package markdown-mode
:hook (markdown-mode . lsp)
:config
(require 'lsp-marksman))
```
* via [Eglot][eglot], requires configuration (unless
[eglot#1013][eglot-marksman-pr] gets merged); add the following to your

This comment has been minimized.

Copy link
@Freed-Wu

Freed-Wu Jun 17, 2023

@artempyanykh joaotavora/eglot#1013 has been merged. This document should be updated.

`init.el`

```lisp
(add-to-list 'eglot-server-programs '(markdown-mode . ("marksman")))
(add-hook 'markdown-mode-hook #'eglot-ensure)
````
* [Helix][helix-editor] requires configuration (unless
[helix#3499][helix-marksman-pr] gets merged); add the following to your
`~/.config/helix/languages.toml`:
Expand Down Expand Up @@ -208,3 +217,8 @@ LSP but it's not a part of the spec at least until and including v3.17.

[helix-editor]: https://helix-editor.com
[helix-marksman-pr]: https://github.com/helix-editor/helix/pull/3499

[coc-marksman]: https://github.com/yaegassy/coc-marksman

[eglot]: https://github.com/joaotavora/eglot
[eglot-marksman-pr]: https://github.com/joaotavora/eglot/pull/1013

0 comments on commit 3c20aef

Please sign in to comment.