Move linter documentation into separate files

2017-03-28 23:25:44 +01:00
parent 094eeb2673
commit d7f8324c3c
24 changed files with 919 additions and 721 deletions
--- a/doc/ale-html.txt
+++ b/doc/ale-html.txt
@@ -0,0 +1,67 @@
+===============================================================================
+ALE HTML Integration                                         *ale-html-options*
+
+
+-------------------------------------------------------------------------------
+htmlhint                                                    *ale-html-htmlhint*
+
+g:ale_html_htmlhint_options                       *g:ale_html_htmlhint_options*
+
+  Type: |String|
+  Default: `'--format=unix'`
+
+  This variable can be changed to modify flags given to HTMLHint.
+
+
+g:ale_html_htmlhint_executable                 *g:ale_html_htmlhint_executable*
+
+  Type: |String|
+  Default: `'htmlhint'`
+
+  ALE will first discover the htmlhint path in an ancestor node_modules
+  directory. If no such path exists, this variable will be used instead.
+
+  If you wish to use only a globally installed version of htmlhint, set
+  |g:ale_html_htmlhint_use_global| to `1`.
+
+
+g:ale_html_htmlhint_use_global                 *g:ale_html_htmlhint_use_global*
+
+  Type: |String|
+  Default: `0`
+
+  This variable controls whether or not ALE will search for a local path for
+  htmlhint first. If this variable is set to `1`, then ALE will always use the
+  global version of htmlhint, in preference to locally installed versions of
+  htmlhint in node_modules.
+
+
+-------------------------------------------------------------------------------
+tidy                                                            *ale-html-tidy*
+
+g:ale_html_tidy_executable                         *g:ale_html_tidy_executable*
+
+  Type: |String|
+  Default: `'tidy'`
+
+  This variable can be changed to change the path to tidy.
+
+
+g:ale_html_tidy_args                                     *g:ale_html_tidy_args*
+
+  Type: |String|
+  Default: `'-q -e -language en'`
+
+  This variable can be changed to change the arguments provided to the
+  executable.
+
+  ALE will attempt to automatically detect the appropriate file encoding to
+  provide to html-tidy, and fall back to UTF-8 when encoding detection fails.
+
+  The recognized file encodings are as follows: ascii, big5, cp1252 (win1252),
+  cp850 (ibm858), cp932 (shiftjis), iso-2022-jp (iso-2022), latin1, macroman
+  (mac), sjis (shiftjis), utf-16le, utf-16, utf-8
+
+
+-------------------------------------------------------------------------------
+  vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: