From 5087246c8223712fa0097098e910951aba8603fb Mon Sep 17 00:00:00 2001
From: Jeffrey Lau <9203+zoonfafer@users.noreply.github.com>
Date: Fri, 7 Jan 2022 22:57:29 +0800
Subject: Add yaml-language-server support for YAML (#2874) (#4029)

---
 doc/ale-yaml.txt | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)

(limited to 'doc/ale-yaml.txt')

diff --git a/doc/ale-yaml.txt b/doc/ale-yaml.txt
index 65e0d069..a5da85a5 100644
--- a/doc/ale-yaml.txt
+++ b/doc/ale-yaml.txt
@@ -105,6 +105,59 @@ g:ale_yaml_swaglint_use_global                 *g:ale_yaml_swaglint_use_global*
   See |ale-integrations-local-executables|
 
 
+===============================================================================
+yaml-language-server                                 *ale-yaml-language-server*
+
+Website: https://github.com/redhat-developer/yaml-language-server
+
+
+Installation
+-------------------------------------------------------------------------------
+
+Install yaml-language-server either globally or locally: >
+
+  npm install yaml-language-server -g  # global
+  npm install yaml-language-server     # local
+
+
+Options
+-------------------------------------------------------------------------------
+
+g:ale_yaml_ls_executable                             *g:ale_yaml_ls_executable*
+                                                     *b:ale_yaml_ls_executable*
+  Type: |String|
+  Default: `'yaml-language-server'`
+
+  This variable can be set to change the path to yaml-language-server.
+
+
+g:ale_yaml_ls_config                                     *g:ale_yaml_ls_config*
+                                                         *b:ale_yaml_ls_config*
+  Type: |Dictionary|
+  Default: `{}`
+
+  Dictionary containing configuration settings that will be passed to the
+  language server.  For example, to enable schema store: >
+      {
+    \   'yaml': {
+    \     'schemaStore': {
+    \         'enable': v:true,
+    \     },
+    \   },
+    \ }
+<
+  Consult the yaml-language-server documentation for more information about
+  settings.
+
+
+g:ale_yaml_ls_use_global                             *g:ale_yaml_ls_use_global*
+                                                     *b:ale_yaml_ls_use_global*
+  Type: |String|
+  Default: `get(g:, 'ale_use_global_executables', 0)`
+
+  See |ale-integrations-local-executables|
+
+
 ===============================================================================
 yamlfix                                                      *ale-yaml-yamlfix*
 
-- 
cgit v1.2.3