mdwright-lsp 0.1.1

Language Server Protocol delivery for mdwright
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

# mdwright-lsp

[![docs.rs](https://docs.rs/mdwright-lsp/badge.svg)](https://docs.rs/mdwright-lsp)

Language Server Protocol delivery for
[mdwright](https://github.com/jcreinhold/mdwright).

A tower-lsp server over stdio that exposes mdwright's lint diagnostics and formatter to
any LSP-aware editor. Diagnostics are debounced (~300 ms); formatting requires UTF-8
position encoding. The server is normally launched through the `mdwright lsp` subcommand,
which is what editor recipes invoke.

The diagnostic and formatting logic itself lives in `mdwright-lint` and `mdwright-format`;
this crate is the protocol shell.

## Status

Pre-1.0. Public items are whatever `lib.rs` re-exports; breaking changes ship without
deprecation warnings.

## Use it

Run the server through the binary:

```bash
mdwright lsp
```

Embed it directly:

```toml
[dependencies]
mdwright-lsp = "0.1"
```

```rust
use mdwright_lsp::serve;
```

## See also

- Project: <https://github.com/jcreinhold/mdwright>
- Library walkthrough: <https://jcreinhold.github.io/mdwright/reference/public-api.html#use-mdwright-as-a-library>
- Editor integrations:
  <https://jcreinhold.github.io/mdwright/integration/editor-integrations.html>

## License

Licensed under MIT or Apache-2.0, at your option.