aboutsummaryrefslogtreecommitdiffstats
path: root/scripts/README_template.md
diff options
context:
space:
mode:
authorJavier Lopez <graulopezjavier@gmail.com>2021-11-30 09:27:12 -0500
committerGitHub <noreply@github.com>2021-11-30 09:27:12 -0500
commitcea6e0b0f6c7daf671b478bd58571768d0385711 (patch)
tree2ad11ab0887274b6e786e3750f2e944308e21989 /scripts/README_template.md
parentchore: use client.request instead of buf_request (#1503) (diff)
downloadnvim-lspconfig-cea6e0b0f6c7daf671b478bd58571768d0385711.tar
nvim-lspconfig-cea6e0b0f6c7daf671b478bd58571768d0385711.tar.gz
nvim-lspconfig-cea6e0b0f6c7daf671b478bd58571768d0385711.tar.bz2
nvim-lspconfig-cea6e0b0f6c7daf671b478bd58571768d0385711.tar.lz
nvim-lspconfig-cea6e0b0f6c7daf671b478bd58571768d0385711.tar.xz
nvim-lspconfig-cea6e0b0f6c7daf671b478bd58571768d0385711.tar.zst
nvim-lspconfig-cea6e0b0f6c7daf671b478bd58571768d0385711.zip
fix(help): workaround plugin/users overwritting tags (#1512)
Most plugin managers run :helptags in the plugin, which silently overwrites the existing doc/tags. this is an issue for us since lspconfig is manipulating the tags file to point to servers_configurations.md Instead create a markdown comment with the name of the wanted tag and make a copy in the repository of servers_configurations.md to server_configurations.txt. Now when :helptags runs it finds the txt file and generates the appropriate tag. The advantage is this solution should work in all platforms, it also removes lines from docgen CI.
Diffstat (limited to 'scripts/README_template.md')
-rw-r--r--scripts/README_template.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/scripts/README_template.md b/scripts/README_template.md
index c077b147..3a9baeaa 100644
--- a/scripts/README_template.md
+++ b/scripts/README_template.md
@@ -1,4 +1,5 @@
# Configurations
+<!-- *lspconfig-server-configurations* -->
The following LSP configs are included. This documentation is autogenerated from the lua files. Follow a link to find documentation for
that config. This file is accessible in neovim via `:help lspconfig-server-configurations`
@@ -6,3 +7,5 @@ that config. This file is accessible in neovim via `:help lspconfig-server-confi
{{implemented_servers_list}}
{{lsp_server_details}}
+
+vim:ft=markdown