.vim/bundle/ale/doc/ale-markdown.txt

   1 ===============================================================================
   2 ALE Markdown Integration                                 *ale-markdown-options*
   3
   4
   5 ===============================================================================
   6 cspell                                                    *ale-markdown-cspell*
   7
   8 See |ale-cspell-options|
   9
  10
  11 ===============================================================================
  12 dprint                                                    *ale-markdown-dprint*
  13
  14 See |ale-dprint-options| and https://dprint.dev/plugins/markdown
  15
  16
  17 ===============================================================================
  18 markdownlint                                        *ale-markdown-markdownlint*
  19
  20                                  *ale-options.markdown_markdownlint_executable*
  21                                        *g:ale_markdown_markdownlint_executable*
  22                                        *b:ale_markdown_markdownlint_executable*
  23 markdown_markdownlint_executable
  24 g:ale_markdown_markdownlint_executable
  25   Type: |String|
  26   Default: `'markdownlint'`
  27
  28   Override the invoked `markdownlint` binary. You can use other binaries such as
  29   `markdownlint-cli2`.
  30
  31                                     *ale-options.markdown_markdownlint_options*
  32                                           *g:ale_markdown_markdownlint_options*
  33                                           *b:ale_markdown_markdownlint_options*
  34 markdown_markdownlint_options
  35 g:ale_markdown_markdownlint_options
  36   Type: |String|
  37   Default: `''`
  38
  39   This variable can be set to pass additional options to markdownlint.
  40
  41
  42 ===============================================================================
  43 marksman                                                *ale-markdown-marksman*
  44
  45                                      *ale-options.markdown_marksman_executable*
  46                                            *g:ale_markdown_marksman_executable*
  47                                            *b:ale_markdown_marksman_executable*
  48 markdown_marksman_executable
  49 g:ale_markdown_marksman_executable
  50   Type: |String|
  51   Default: `'marksman'`
  52
  53   Override the invoked `marksman` binary.
  54
  55
  56 ===============================================================================
  57 mdl                                                          *ale-markdown-mdl*
  58
  59                                           *ale-options.markdown_mdl_executable*
  60                                                 *g:ale_markdown_mdl_executable*
  61                                                 *b:ale_markdown_mdl_executable*
  62 markdown_mdl_executable
  63 g:ale_markdown_mdl_executable
  64   Type: |String|
  65   Default: `'mdl'`
  66
  67   Override the invoked mdl binary. This is useful for running mdl from
  68   binstubs or a bundle.
  69
  70                                              *ale-options.markdown_mdl_options*
  71                                                    *g:ale_markdown_mdl_options*
  72                                                    *b:ale_markdown_mdl_options*
  73 markdown_mdl_options
  74 g:ale_markdown_mdl_options
  75   Type: |String|
  76   Default: `''`
  77
  78   This variable can be set to pass additional options to mdl.
  79
  80
  81 ===============================================================================
  82 pandoc                                                    *ale-markdown-pandoc*
  83
  84                                        *ale-options.markdown_pandoc_executable*
  85                                              *g:ale_markdown_pandoc_executable*
  86                                              *b:ale_markdown_pandoc_executable*
  87 markdown_pandoc_executable
  88 g:ale_markdown_pandoc_executable
  89   Type: |String|
  90   Default: `'pandoc'`
  91
  92   This variable can be set to specify where to find the pandoc executable
  93
  94                                           *ale-options.markdown_pandoc_options*
  95                                                 *g:ale_markdown_pandoc_options*
  96                                                 *b:ale_markdown_pandoc_options*
  97 markdown_pandoc_options
  98 g:ale_markdown_pandoc_options
  99   Type: |String|
 100   Default: `'-f gfm -t gfm -s -'`
 101
 102   This variable can be set to change the default options passed to pandoc
 103
 104
 105 ===============================================================================
 106 prettier                                                *ale-markdown-prettier*
 107
 108 See |ale-javascript-prettier| for information about the available options.
 109
 110
 111 ===============================================================================
 112 pymarkdown                                            *ale-markdown-pymarkdown*
 113
 114                                    *ale-options.markdown_pymarkdown_executable*
 115                                          *g:ale_markdown_pymarkdown_executable*
 116                                           *b:ale_markdown_pymarkdown_executable*
 117 markdown_pymarkdown_executable
 118 g:ale_markdown_pymarkdown_executable
 119   Type: |String|
 120   Default: `'pymarkdown'`
 121
 122   See |ale-integrations-local-executables|
 123
 124   Set this to `'pipenv'` to invoke `'pipenv` `run` `pymarkdown'`.
 125   Set this to `'poetry'` to invoke `'poetry` `run` `pymarkdown'`.
 126
 127                                       *ale-options.markdown_pymarkdown_options*
 128                                             *g:ale_markdown_pymarkdown_options*
 129                                              *b:ale_markdown_pymarkdown_options*
 130 markdown_pymarkdown_options
 131 g:ale_markdown_pymarkdown_options
 132   Type: |String|
 133   Default: `''`
 134
 135   This variable can be changed to add command-line arguments to the
 136   pymarkdown invocation.
 137
 138                                    *ale-options.markdown_pymarkdown_use_global*
 139                                          *g:ale_markdown_pymarkdown_use_global*
 140                                           *b:ale_markdown_pymarkdown_use_global*
 141 markdown_pymarkdown_use_global
 142 g:ale_markdown_pymarkdown_use_global
 143   Type: |Number|
 144   Default: `get(g:, 'ale_use_global_executables', 0)`
 145
 146   See |ale-integrations-local-executables|
 147
 148                                   *ale-options.markdown_pymarkdown_auto_pipenv*
 149                                         *g:ale_markdown_pymarkdown_auto_pipenv*
 150                                          *b:ale_markdown_pymarkdown_auto_pipenv*
 151 markdown_pymarkdown_auto_pipenv
 152 g:ale_markdown_pymarkdown_auto_pipenv
 153   Type: |Number|
 154   Default: `0`
 155
 156   Detect whether the file is inside a pipenv, and set the executable to `pipenv`
 157   if true. This is overridden by a manually-set executable.
 158
 159                                   *ale-options.markdown_pymarkdown_auto_poetry*
 160                                         *g:ale_markdown_pymarkdown_auto_poetry*
 161                                          *b:ale_markdown_pymarkdown_auto_poetry*
 162 markdown_pymarkdown_auto_poetry
 163 g:ale_markdown_pymarkdown_auto_poetry
 164   Type: |Number|
 165   Default: `0`
 166
 167   Detect whether the file is inside a poetry, and set the executable to `poetry`
 168   if true. This is overridden by a manually-set executable.
 169
 170                                       *ale-options.markdown_pymarkdown_auto_uv*
 171                                             *g:ale_markdown_pymarkdown_auto_uv*
 172                                              *b:ale_markdown_pymarkdown_auto_uv*
 173 markdown_pymarkdown_auto_uv
 174 g:ale_markdown_pymarkdown_auto_uv
 175   Type: |Number|
 176   Default: `0`
 177
 178   Set the executable to `uv` if true. This is overridden by a manually-set
 179   executable.
 180
 181
 182 ===============================================================================
 183 remark-lint                                          *ale-markdown-remark-lint*
 184
 185                                   *ale-options.markdown_remark_lint_executable*
 186                                         *g:ale_markdown_remark_lint_executable*
 187                                         *b:ale_markdown_remark_lint_executable*
 188 markdown_remark_lint_executable
 189 g:ale_markdown_remark_lint_executable
 190   Type: |String|
 191   Default: `'remark'`
 192
 193   See |ale-integrations-local-executables|
 194
 195                                      *ale-options.markdown_remark_lint_options*
 196                                            *g:ale_markdown_remark_lint_options*
 197                                            *b:ale_markdown_remark_lint_options*
 198 markdown_remark_lint_options
 199 g:ale_markdown_remark_lint_options
 200   Type: |String|
 201   Default: `''`
 202
 203   This variable can be set to pass additional options to remark-lint.
 204
 205                                   *ale-options.markdown_remark_lint_use_global*
 206                                         *g:ale_markdown_remark_lint_use_global*
 207                                         *b:ale_markdown_remark_lint_use_global*
 208 markdown_remark_lint_use_global
 209 g:ale_markdown_remark_lint_use_global
 210   Type: |Number|
 211   Default: `get(g:, 'ale_use_global_executables', 0)`
 212
 213   See |ale-integrations-local-executables|
 214
 215
 216 ===============================================================================
 217 textlint                                                *ale-markdown-textlint*
 218
 219 See |ale-text-textlint|
 220
 221
 222 ===============================================================================
 223 write-good                                            *ale-markdown-write-good*
 224
 225 See |ale-write-good-options|
 226
 227
 228 ===============================================================================
 229   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: