]> git.madduck.net Git - etc/vim.git/blob - .vim/bundle/ale/doc/ale-html.txt

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Merge commit '76265755a1add77121c8f9dabb3e9bb70fe9a972' as '.vim/bundle/ale'
[etc/vim.git] / .vim / bundle / ale / doc / ale-html.txt
1 ===============================================================================
2 ALE HTML Integration                                         *ale-html-options*
3
4
5 ===============================================================================
6 angular                                                      *ale-html-angular*
7
8 ALE supports language server features for Angular. You can install it via `npm`: >
9
10   $ npm install --save-dev @angular/language-server
11 <
12 Angular 11 and up are supported.
13
14                                           *ale-options.html_angular_executable*
15                                                 *g:ale_html_angular_executable*
16                                                 *b:ale_html_angular_executable*
17 html_angular_executable
18 g:ale_html_angular_executable
19   Type: |String|
20   Default: `'ngserver'`
21
22   See |ale-integrations-local-executables|
23
24                                           *ale-options.html_angular_use_global*
25                                                 *g:ale_html_angular_use_global*
26                                                 *b:ale_html_angular_use_global*
27 html_angular_use_global
28 g:ale_html_angular_use_global
29   Type: |String|
30   Default: `get(g:, 'ale_use_global_executables', 0)`
31
32   See |ale-integrations-local-executables|
33
34
35 ===============================================================================
36 cspell                                                        *ale-html-cspell*
37
38 See |ale-cspell-options|
39
40
41 ===============================================================================
42 djlint                                                        *ale-html-djlint*
43
44 `djlint` options for HTML are the same as the options for htmlangular,
45 htmldjango, jinja, handlebars, nunjucks and gotmplhtml.
46
47                                            *ale-options.html_djlint_executable*
48                                                  *g:ale_html_djlint_executable*
49                                                  *b:ale_html_djlint_executable*
50 html_djlint_executable
51 g:ale_html_djlint_executable
52   Type: |String|
53   Default: `'djlint'`
54
55   See |ale-integrations-local-executables|
56
57                                               *ale-options.html_djlint_options*
58                                                     *g:ale_html_djlint_options*
59                                                     *b:ale_html_djlint_options*
60 html_djlint_options
61 g:ale_html_djlint_options
62   Type: |String|
63   Default: `''`
64
65   This variable can be changed to modify flags given to djlint.
66
67
68 ===============================================================================
69 fecs                                                            *ale-html-fecs*
70
71 `fecs` options for HTML are the same as the options for JavaScript, and both
72 of them read `./.fecsrc` as the default configuration file.
73
74 See: |ale-javascript-fecs|.
75
76
77 ===============================================================================
78 html-beautify                                               *ale-html-beautify*
79
80                                          *ale-options.html_beautify_executable*
81                                                *g:ale_html_beautify_executable*
82                                                *b:ale_html_beautify_executable*
83 html_beautify_executable
84 g:ale_html_beautify_executable
85   Type: |String|
86   Default: `'html-beautify'`
87
88   See |ale-integrations-local-executables|
89
90                                             *ale-options.html_beautify_options*
91                                                   *g:ale_html_beautify_options*
92                                                   *b:ale_html_beautify_options*
93 html_beautify_options
94 g:ale_html_beautify_options
95   Type: |String|
96   Default: `''`
97
98   This variable can be changed to modify flags given to html-beautify.
99
100                                          *ale-options.html_beautify_use_global*
101                                                *g:ale_html_beautify_use_global*
102                                                *b:ale_html_beautify_use_global*
103 html_beautify_use_global
104 g:ale_html_beautify_use_global
105   Type: |String|
106   Default: `get(g:, 'ale_use_global_executables', 0)`
107
108   See |ale-integrations-local-executables|
109
110
111 ===============================================================================
112 htmlhint                                                    *ale-html-htmlhint*
113
114                                          *ale-options.html_htmlhint_executable*
115                                                *g:ale_html_htmlhint_executable*
116                                                *b:ale_html_htmlhint_executable*
117 html_htmlhint_executable
118 g:ale_html_htmlhint_executable
119   Type: |String|
120   Default: `'htmlhint'`
121
122   See |ale-integrations-local-executables|
123
124                                             *ale-options.html_htmlhint_options*
125                                                   *g:ale_html_htmlhint_options*
126                                                   *b:ale_html_htmlhint_options*
127 html_htmlhint_options
128 g:ale_html_htmlhint_options
129   Type: |String|
130   Default: `''`
131
132   This variable can be changed to modify flags given to HTMLHint.
133
134                                          *ale-options.html_htmlhint_use_global*
135                                                *g:ale_html_htmlhint_use_global*
136                                                *b:ale_html_htmlhint_use_global*
137 html_htmlhint_use_global
138 g:ale_html_htmlhint_use_global
139   Type: |String|
140   Default: `get(g:, 'ale_use_global_executables', 0)`
141
142   See |ale-integrations-local-executables|
143
144
145 ===============================================================================
146 prettier                                                    *ale-html-prettier*
147
148 See |ale-javascript-prettier| for information about the available options.
149
150
151 ===============================================================================
152 rustywind                                                  *ale-html-rustywind*
153
154                                         *ale-options.html_rustywind_executable*
155                                               *g:ale_html_rustywind_executable*
156                                               *b:ale_html_rustywind_executable*
157 html_rustywind_executable
158 g:ale_html_rustywind_executable
159   Type: |String|
160   Default: `'rustywind'`
161
162   See |ale-integrations-local-executables|
163
164                                            *ale-options.html_rustywind_options*
165                                                  *g:ale_html_rustywind_options*
166                                                  *b:ale_html_rustywind_options*
167 html_rustywind_options
168 g:ale_html_rustywind_options
169   Type: |String|
170   Default: `''`
171
172   This variable can be changed to modify flags given to rustywind.
173
174
175 ===============================================================================
176 stylelint                                                  *ale-html-stylelint*
177
178                                         *ale-options.html_stylelint_executable*
179                                               *g:ale_html_stylelint_executable*
180                                               *b:ale_html_stylelint_executable*
181 html_stylelint_executable
182 g:ale_html_stylelint_executable
183   Type: |String|
184   Default: `'stylelint'`
185
186   See |ale-integrations-local-executables|
187
188                                            *ale-options.html_stylelint_options*
189                                                  *g:ale_html_stylelint_options*
190                                                  *b:ale_html_stylelint_options*
191 html_stylelint_options
192 g:ale_html_stylelint_options
193   Type: |String|
194   Default: `''`
195
196   This variable can be set to pass additional options to stylelint.
197
198                                         *ale-options.html_stylelint_use_global*
199                                               *g:ale_html_stylelint_use_global*
200                                               *b:ale_html_stylelint_use_global*
201 html_stylelint_use_global
202 g:ale_html_stylelint_use_global
203   Type: |String|
204   Default: `0`
205
206   See |ale-integrations-local-executables|
207
208
209 ===============================================================================
210 tidy                                                            *ale-html-tidy*
211
212 `tidy` is a console application which corrects and cleans up HTML and XML
213 documents by fixing markup errors and upgrading legacy code to modern
214 standards.
215
216 Note:
217 `/usr/bin/tidy` on macOS (installed by default) is too old. It was released
218 on 31 Oct 2006. It does not consider modern HTML specs (HTML5) and shows
219 outdated warnings. So |ale| ignores `/usr/bin/tidy` on macOS.
220
221 To use `tidy` on macOS, please install the latest version with Homebrew:
222 >
223   $ brew install tidy-html5
224 <
225 `/usr/local/bin/tidy` is installed.
226
227
228 -------------------------------------------------------------------------------
229 Options
230                                              *ale-options.html_tidy_executable*
231                                                    *g:ale_html_tidy_executable*
232                                                    *b:ale_html_tidy_executable*
233 html_tidy_executable
234 g:ale_html_tidy_executable
235   Type: |String|
236   Default: `'tidy'`
237
238   This variable can be changed to change the path to tidy.
239
240                                                 *ale-options.html_tidy_options*
241                                                       *g:ale_html_tidy_options*
242                                                       *b:ale_html_tidy_options*
243 html_tidy_options
244 g:ale_html_tidy_options
245   Type: |String|
246   Default: `'-q -e -language en'`
247
248   This variable can be changed to change the arguments provided to the
249   executable.
250
251   ALE will attempt to automatically detect the appropriate file encoding to
252   provide to html-tidy, and fall back to UTF-8 when encoding detection fails.
253
254   The recognized file encodings are as follows: ascii, big5, cp1252 (win1252),
255   cp850 (ibm858), cp932 (shiftjis), iso-2022-jp (iso-2022), latin1, macroman
256   (mac), sjis (shiftjis), utf-16le, utf-16, utf-8
257
258                                              *ale-options.html_tidy_use_global*
259                                                    *g:ale_html_tidy_use_global*
260 html_tidy_use_global
261 g:ale_html_tidy_use_global
262   Type: |Number|
263   Default: `get(g:, 'ale_use_global_executables', 0)`
264
265   See |ale-integrations-local-executables|
266
267
268 ===============================================================================
269 vscodehtml                                                    *ale-html-vscode*
270
271 Website: https://github.com/hrsh7th/vscode-langservers-extracted
272
273
274 -------------------------------------------------------------------------------
275 Installation
276
277 Install VSCode html language server either globally or locally: >
278
279   npm install -g vscode-langservers-extracted
280 <
281
282 ===============================================================================
283 write-good                                                *ale-html-write-good*
284
285 See |ale-write-good-options|
286
287
288 ===============================================================================
289   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: