aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/doc/ale-markdown.txt
blob: 3f45cbc012b244119ec5828f816c3af623b42f7b (plain) (blame)
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
===============================================================================
ALE Markdown Integration                                 *ale-markdown-options*


===============================================================================
cspell                                                    *ale-markdown-cspell*

See |ale-cspell-options|


===============================================================================
dprint                                                    *ale-markdown-dprint*

See |ale-dprint-options| and https://dprint.dev/plugins/markdown


===============================================================================
harper                                                    *ale-markdown-harper*

                                           *ale-options.markdown_harper_config*
                                                  *g:ale_markdown_harper_config*
                                                  *b:ale_markdown_harper_config*
markdown_harper_config
g:ale_markdown_harper_config
  Type: |Dictionary|
  Default: `{'harper-ls': {'diagnosticSeverity': 'hint', 'dialect': 'American', ...}}`

  Dictionary passed to harper-ls as LSP workspace configuration. The default
  enables spell check, sentence capitalization, repeated words, long
  sentences, a/an errors, and spacing rules, and disables spelled-out numbers
  and wrong-quote checks.

  Example: >
    let g:ale_markdown_harper_config = {
    \   'harper-ls': {
    \       'diagnosticSeverity': 'warning',
    \       'linters': {
    \           'SpellCheck': v:true,
    \           'LongSentences': v:false,
    \       },
    \   },
    \}
<


===============================================================================
markdownlint                                        *ale-markdown-markdownlint*

                                 *ale-options.markdown_markdownlint_executable*
                                       *g:ale_markdown_markdownlint_executable*
                                       *b:ale_markdown_markdownlint_executable*
markdown_markdownlint_executable
g:ale_markdown_markdownlint_executable
  Type: |String|
  Default: `'markdownlint'`

  Override the invoked `markdownlint` binary. You can use other binaries such as
  `markdownlint-cli2`.

                                    *ale-options.markdown_markdownlint_options*
                                          *g:ale_markdown_markdownlint_options*
                                          *b:ale_markdown_markdownlint_options*
markdown_markdownlint_options
g:ale_markdown_markdownlint_options
  Type: |String|
  Default: `''`

  This variable can be set to pass additional options to markdownlint.


===============================================================================
marksman                                                *ale-markdown-marksman*

                                     *ale-options.markdown_marksman_executable*
                                           *g:ale_markdown_marksman_executable*
                                           *b:ale_markdown_marksman_executable*
markdown_marksman_executable
g:ale_markdown_marksman_executable
  Type: |String|
  Default: `'marksman'`

  Override the invoked `marksman` binary.


===============================================================================
mdl                                                          *ale-markdown-mdl*

                                          *ale-options.markdown_mdl_executable*
                                                *g:ale_markdown_mdl_executable*
                                                *b:ale_markdown_mdl_executable*
markdown_mdl_executable
g:ale_markdown_mdl_executable
  Type: |String|
  Default: `'mdl'`

  Override the invoked mdl binary. This is useful for running mdl from
  binstubs or a bundle.

                                             *ale-options.markdown_mdl_options*
                                                   *g:ale_markdown_mdl_options*
                                                   *b:ale_markdown_mdl_options*
markdown_mdl_options
g:ale_markdown_mdl_options
  Type: |String|
  Default: `''`

  This variable can be set to pass additional options to mdl.


===============================================================================
pandoc                                                    *ale-markdown-pandoc*

                                       *ale-options.markdown_pandoc_executable*
                                             *g:ale_markdown_pandoc_executable*
                                             *b:ale_markdown_pandoc_executable*
markdown_pandoc_executable
g:ale_markdown_pandoc_executable
  Type: |String|
  Default: `'pandoc'`

  This variable can be set to specify where to find the pandoc executable

                                          *ale-options.markdown_pandoc_options*
                                                *g:ale_markdown_pandoc_options*
                                                *b:ale_markdown_pandoc_options*
markdown_pandoc_options
g:ale_markdown_pandoc_options
  Type: |String|
  Default: `'-f gfm -t gfm -s -'`

  This variable can be set to change the default options passed to pandoc


===============================================================================
prettier                                                *ale-markdown-prettier*

See |ale-javascript-prettier| for information about the available options.


===============================================================================
pymarkdown                                            *ale-markdown-pymarkdown*

pymarkdown can be used both as a linter and a fixer for Markdown files.

                                   *ale-options.markdown_pymarkdown_executable*
                                         *g:ale_markdown_pymarkdown_executable*
                                         *b:ale_markdown_pymarkdown_executable*
markdown_pymarkdown_executable
g:ale_markdown_pymarkdown_executable
  Type: |String|
  Default: `'pymarkdown'`

  See |ale-integrations-local-executables|

  Set this to `'pipenv'` to invoke `'pipenv` `run` `pymarkdown'`.
  Set this to `'poetry'` to invoke `'poetry` `run` `pymarkdown'`.

                                      *ale-options.markdown_pymarkdown_options*
                                            *g:ale_markdown_pymarkdown_options*
                                            *b:ale_markdown_pymarkdown_options*
markdown_pymarkdown_options
g:ale_markdown_pymarkdown_options
  Type: |String|
  Default: `''`

  This variable can be changed to add command-line arguments to the
  pymarkdown invocation.

                                   *ale-options.markdown_pymarkdown_use_global*
                                         *g:ale_markdown_pymarkdown_use_global*
                                         *b:ale_markdown_pymarkdown_use_global*
markdown_pymarkdown_use_global
g:ale_markdown_pymarkdown_use_global
  Type: |Number|
  Default: `get(g:, 'ale_use_global_executables', 0)`

  See |ale-integrations-local-executables|

                                  *ale-options.markdown_pymarkdown_auto_pipenv*
                                        *g:ale_markdown_pymarkdown_auto_pipenv*
                                        *b:ale_markdown_pymarkdown_auto_pipenv*
markdown_pymarkdown_auto_pipenv
g:ale_markdown_pymarkdown_auto_pipenv
  Type: |Number|
  Default: `0`

  Detect whether the file is inside a pipenv, and set the executable to `pipenv`
  if true. This is overridden by a manually-set executable.

                                  *ale-options.markdown_pymarkdown_auto_poetry*
                                        *g:ale_markdown_pymarkdown_auto_poetry*
                                        *b:ale_markdown_pymarkdown_auto_poetry*
markdown_pymarkdown_auto_poetry
g:ale_markdown_pymarkdown_auto_poetry
  Type: |Number|
  Default: `0`

  Detect whether the file is inside a poetry, and set the executable to `poetry`
  if true. This is overridden by a manually-set executable.

                                      *ale-options.markdown_pymarkdown_auto_uv*
                                            *g:ale_markdown_pymarkdown_auto_uv*
                                            *b:ale_markdown_pymarkdown_auto_uv*
markdown_pymarkdown_auto_uv
g:ale_markdown_pymarkdown_auto_uv
  Type: |Number|
  Default: `0`

  Set the executable to `uv` if true. This is overridden by a manually-set
  executable.


===============================================================================
remark-lint                                          *ale-markdown-remark-lint*

                                  *ale-options.markdown_remark_lint_executable*
                                        *g:ale_markdown_remark_lint_executable*
                                        *b:ale_markdown_remark_lint_executable*
markdown_remark_lint_executable
g:ale_markdown_remark_lint_executable
  Type: |String|
  Default: `'remark'`

  See |ale-integrations-local-executables|

                                     *ale-options.markdown_remark_lint_options*
                                           *g:ale_markdown_remark_lint_options*
                                           *b:ale_markdown_remark_lint_options*
markdown_remark_lint_options
g:ale_markdown_remark_lint_options
  Type: |String|
  Default: `''`

  This variable can be set to pass additional options to remark-lint.

                                  *ale-options.markdown_remark_lint_use_global*
                                        *g:ale_markdown_remark_lint_use_global*
                                        *b:ale_markdown_remark_lint_use_global*
markdown_remark_lint_use_global
g:ale_markdown_remark_lint_use_global
  Type: |Number|
  Default: `get(g:, 'ale_use_global_executables', 0)`

  See |ale-integrations-local-executables|


===============================================================================
rumdl                                                      *ale-markdown-rumdl*

                                        *ale-options.markdown_rumdl_executable*
                                              *g:ale_markdown_rumdl_executable*
                                              *b:ale_markdown_rumdl_executable*
markdown_rumdl_executable
g:ale_markdown_rumdl_executable
  Type: |String|
  Default: `'rumdl'`

  Override the invoked `rumdl` binary.

                                           *ale-options.markdown_rumdl_options*
                                                 *g:ale_markdown_rumdl_options*
                                                 *b:ale_markdown_rumdl_options*
markdown_rumdl_options
g:ale_markdown_rumdl_options
  Type: |String|
  Default: `''`

  This variable can be set to pass additional options to `rumdl server`.

                                       *ale-options.markdown_rumdl_fmt_options*
                                             *g:ale_markdown_rumdl_fmt_options*
                                             *b:ale_markdown_rumdl_fmt_options*
markdown_rumdl_fmt_options
g:ale_markdown_rumdl_fmt_options
  Type: |String|
  Default: `'--silent'`

  This variable can be set to pass additional options to `rumdl fmt`.


===============================================================================
textlint                                                *ale-markdown-textlint*

See |ale-text-textlint|


===============================================================================
write-good                                            *ale-markdown-write-good*

See |ale-write-good-options|


===============================================================================
redpen                                                    *ale-markdown-redpen*

See |ale-redpen-options|


===============================================================================
  vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: