diff options
| author | Michael Lingelbach <m.j.lbach@gmail.com> | 2021-11-27 09:01:30 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-11-27 09:01:30 -0500 |
| commit | d52e45acf9a55b025ce9c0161b922a814b65b631 (patch) | |
| tree | 4a1b3c54f46fa9b95c4e7ceaededa112ef4b9e18 /scripts | |
| parent | docs: update server_configurations.md (diff) | |
| download | nvim-lspconfig-d52e45acf9a55b025ce9c0161b922a814b65b631.tar nvim-lspconfig-d52e45acf9a55b025ce9c0161b922a814b65b631.tar.gz nvim-lspconfig-d52e45acf9a55b025ce9c0161b922a814b65b631.tar.bz2 nvim-lspconfig-d52e45acf9a55b025ce9c0161b922a814b65b631.tar.lz nvim-lspconfig-d52e45acf9a55b025ce9c0161b922a814b65b631.tar.xz nvim-lspconfig-d52e45acf9a55b025ce9c0161b922a814b65b631.tar.zst nvim-lspconfig-d52e45acf9a55b025ce9c0161b922a814b65b631.zip | |
docs: make |lspconfig-server-configurations| jump to the markdown file (#1497)
* generating the tags at docgen and modifying the
|lspconfig-server-configurations|
tag allows `:help lspconfig-server-configurations` take you to
./doc/server_configurations.md
* adding a modeline to the markdown file ensures it sets the
correct filetype
Co-authored-by: Javier López <graulopezjavier@gmail.com>
Diffstat (limited to 'scripts')
| -rw-r--r-- | scripts/README_template.md | 2 | ||||
| -rw-r--r-- | scripts/docgen.lua | 22 |
2 files changed, 23 insertions, 1 deletions
diff --git a/scripts/README_template.md b/scripts/README_template.md index becd1728..c077b147 100644 --- a/scripts/README_template.md +++ b/scripts/README_template.md @@ -1,7 +1,7 @@ # Configurations The following LSP configs are included. This documentation is autogenerated from the lua files. Follow a link to find documentation for -that config. +that config. This file is accessible in neovim via `:help lspconfig-server-configurations` {{implemented_servers_list}} diff --git a/scripts/docgen.lua b/scripts/docgen.lua index 7d0bf626..f72b984e 100644 --- a/scripts/docgen.lua +++ b/scripts/docgen.lua @@ -277,8 +277,30 @@ local function generate_readme(template_file, params) writer:close() end +local function generate_helptags() + -- Modify a help tag to point to server_configurations.md and append a modeline to it so it can be + -- displayed with the right filetype when using :help + vim.cmd [[ + helptags ./doc + edit doc/tags + set noswapfile + set noreadonly + call append('$', "lspconfig-server-configurations server_configurations.md /# Configurations") + silent write + ]] + print 'Added doc/server_configurations.md to helptags' + + vim.cmd [[ + edit doc/server_configurations.md + call append('$', "vim:ft=markdown") + silent write + ]] + print 'Added modeline to doc/server_configurations.md' +end + require_all_configs() generate_readme('scripts/README_template.md', { implemented_servers_list = make_implemented_servers_list(), lsp_server_details = make_lsp_sections(), }) +generate_helptags() |