@@ -11,23 +11,23 @@ A [language server][lsp] for [MDX][].
11
11
12
12
## Contents
13
13
14
- * [ What is this?] ( #what-is-this )
15
- * [ When should I use this?] ( #when-should-i-use-this )
16
- * [ Install] ( #install )
17
- * [ Use] ( #use )
18
- * [ Language server features] ( #language-server-features )
19
- * [ Initialize Options] ( #initialize-options )
20
- * [ Configuration] ( #configuration )
21
- * [ TypeScript] ( #typescript )
22
- * [ Plugins] ( #plugins )
23
- * [ Examples] ( #examples )
24
- * [ Visual Studio Code] ( #visual-studio-code )
25
- * [ Compatibility] ( #compatibility )
26
- * [ Security] ( #security )
27
- * [ Contribute] ( #contribute )
28
- * [ Sponsor] ( #sponsor )
29
- * [ Changelog] ( #changelog )
30
- * [ License] ( #license )
14
+ * [ What is this?] ( #what-is-this )
15
+ * [ When should I use this?] ( #when-should-i-use-this )
16
+ * [ Install] ( #install )
17
+ * [ Use] ( #use )
18
+ * [ Language server features] ( #language-server-features )
19
+ * [ Initialize Options] ( #initialize-options )
20
+ * [ Configuration] ( #configuration )
21
+ * [ TypeScript] ( #typescript )
22
+ * [ Plugins] ( #plugins )
23
+ * [ Examples] ( #examples )
24
+ * [ Visual Studio Code] ( #visual-studio-code )
25
+ * [ Compatibility] ( #compatibility )
26
+ * [ Security] ( #security )
27
+ * [ Contribute] ( #contribute )
28
+ * [ Sponsor] ( #sponsor )
29
+ * [ Changelog] ( #changelog )
30
+ * [ License] ( #license )
31
31
32
32
## What is this?
33
33
@@ -69,45 +69,46 @@ features specific to MDX.
69
69
70
70
MDX language server supports the following LSP initialization options:
71
71
72
- * ` typescript.enabled ` (` boolean ` , default: ` false ` ) —
73
- If true, enable TypeScript.
74
- * ` typescript.tsdk ` (` string ` , required) —
75
- The path from which to load TypeScript.
76
- * ` locale ` (` string ` , optional) —
77
- The locale to use for TypeScript error messages.
72
+ * ` typescript.enabled ` (` boolean ` , default: ` false ` ) —
73
+ If true, enable TypeScript.
74
+ * ` typescript.tsdk ` (` string ` , required) —
75
+ The path from which to load TypeScript.
76
+ * ` locale ` (` string ` , optional) —
77
+ The locale to use for TypeScript error messages.
78
78
79
79
### Configuration
80
80
81
81
MDX language server supports the following LSP configuration options:
82
82
83
- * ` mdx.trace.server.verbosity ` (` "off" ` | ` "messages" ` | ` "compact" ` |
84
- ` "verbose" ` , default: ` "off" ` ) —
85
- Trace MDX language server requests in the output console.
86
- * ` mdx.trace.server.format ` (` "text" ` | ` "json" ` , default: ` "text" ` ) —
87
- How to format traced MDX language server requests.
88
- * ` mdx.validate.validateReferences ` (` "ignore" ` | ` "hint" ` | ` "warning" ` |
89
- ` "error" ` , default: ` "warning" ` ) —
90
- Diagnostic level for invalid reference links, e.g. ` [text][no-such-ref] ` .
91
- * ` mdx.validate.validateFragmentLinks ` (` "ignore" ` | ` "hint" ` | ` "warning" ` |
92
- ` "error" ` , default: ` "warning" ` ) —
93
- Diagnostic level for fragments links to headers in the current file that
94
- don’t exist, e.g. ` [text](#no-such-header) `
95
- * ` mdx.validate.validateFileLinks ` (` "ignore" ` | ` "hint" ` | ` "warning" ` |
96
- ` "error" ` , default: ` "warning" ` ) —
97
- Diagnostic level for links to local files that don’t exist, e.g.
98
- ` [text](./no-such-file.png) ` .
99
- * ` mdx.validate.validateMarkdownFileLinkFragments ` (` "ignore" ` | ` "hint" ` |
100
- ` "warning" ` | ` "error" ` , default: ` "warning" ` ) —
101
- Diagnostic level for the fragment part of links to other local markdown
102
- files , e.g. ` [text](./no-such-file.png) ` .
103
- * ` mdx.validate.validateUnusedLinkDefinitions ` (` "ignore" ` | ` "hint" ` |
104
- ` "warning" ` | ` "error" ` , default: ` "warning" ` ) —
105
- Diagnostic level for link definitions that aren’t used anywhere.
106
- ` [never-used]: http://example.com ` .
107
- * ` mdx.validate.validateDuplicateLinkDefinitions ` (` "ignore" ` | ` "hint" ` | ` "warning" ` | ` "error" ` , default: ` "warning" ` ) —
108
- Diagnostic level for duplicate link definitions.
109
- * ` mdx.validate.ignoreLinks ` (` Array<string> ` , optional) —
110
- Glob of links that should not be validated.
83
+ * ` mdx.trace.server.verbosity ` (` "off" ` | ` "messages" ` | ` "compact" ` |
84
+ ` "verbose" ` , default: ` "off" ` ) —
85
+ Trace MDX language server requests in the output console.
86
+ * ` mdx.trace.server.format ` (` "text" ` | ` "json" ` , default: ` "text" ` ) —
87
+ How to format traced MDX language server requests.
88
+ * ` mdx.validate.validateReferences ` (` "ignore" ` | ` "hint" ` | ` "warning" ` |
89
+ ` "error" ` , default: ` "warning" ` ) —
90
+ Diagnostic level for invalid reference links, e.g. ` [text][no-such-ref] ` .
91
+ * ` mdx.validate.validateFragmentLinks ` (` "ignore" ` | ` "hint" ` | ` "warning" ` |
92
+ ` "error" ` , default: ` "warning" ` ) —
93
+ Diagnostic level for fragments links to headers in the current file that don’t
94
+ exist, e.g. ` [text](#no-such-header) `
95
+ * ` mdx.validate.validateFileLinks ` (` "ignore" ` | ` "hint" ` | ` "warning" ` |
96
+ ` "error" ` , default: ` "warning" ` ) —
97
+ Diagnostic level for links to local files that don’t exist, e.g.
98
+ ` [text](./no-such-file.png) ` .
99
+ * ` mdx.validate.validateMarkdownFileLinkFragments ` (` "ignore" ` | ` "hint" ` |
100
+ ` "warning" ` | ` "error" ` , default: ` "warning" ` ) —
101
+ Diagnostic level for the fragment part of links to other local markdown files,
102
+ e.g. ` [text](./no-such-file.png) ` .
103
+ * ` mdx.validate.validateUnusedLinkDefinitions ` (` "ignore" ` | ` "hint" ` |
104
+ ` "warning" ` | ` "error" ` , default: ` "warning" ` ) —
105
+ Diagnostic level for link definitions that aren’t used anywhere.
106
+ ` [never-used]: http://example.com ` .
107
+ * ` mdx.validate.validateDuplicateLinkDefinitions ` (` "ignore" ` | ` "hint" ` |
108
+ ` "warning" ` | ` "error" ` , default: ` "warning" ` ) —
109
+ Diagnostic level for duplicate link definitions.
110
+ * ` mdx.validate.ignoreLinks ` (` Array<string> ` , optional) —
111
+ Glob of links that should not be validated.
111
112
112
113
### TypeScript
113
114
0 commit comments