diff options
| -rw-r--r-- | .editorconfig | 4 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 2 | ||||
| -rw-r--r-- | scripts/docgen.lua | 4 |
3 files changed, 3 insertions, 7 deletions
diff --git a/.editorconfig b/.editorconfig index 489c20c0..bb6a1423 100644 --- a/.editorconfig +++ b/.editorconfig @@ -8,10 +8,6 @@ end_of_line = lf insert_final_newline = true charset = utf-8 -[*.lua] -indent_style = space -indent_size = 2 - [{Makefile,**/Makefile,runtime/doc/*.txt}] indent_style = tab indent_size = 8 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e97d6591..2d04b23f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -125,7 +125,7 @@ PRs are checked with [luacheck](https://github.com/mpeterv/luacheck), [StyLua](h ## Generating docs -Github Actions automatically generates `server_configurations.md`. Only modify `scripts/README_template.md` or the `docs` table in the server config Lua file. Do not modify `server_configurations.md` directly. +GitHub Actions automatically generates `server_configurations.md`. Only modify `scripts/README_template.md` or the `docs` table in the server config Lua file. Do not modify `server_configurations.md` directly. To preview the generated `server_configurations.md` locally, run `scripts/docgen.lua` from `nvim` (from the project root): diff --git a/scripts/docgen.lua b/scripts/docgen.lua index 119353ba..9f6c1bc1 100644 --- a/scripts/docgen.lua +++ b/scripts/docgen.lua @@ -196,7 +196,7 @@ local function make_lsp_sections() end -- https://github.github.com/gfm/#backslash-escapes - local function excape_markdown_punctuations(str) + local function escape_markdown_punctuations(str) local pattern = '\\(\\*\\|\\.\\|?\\|!\\|"\\|#\\|\\$\\|%\\|\'\\|(\\|)\\|,\\|-\\|\\/\\|:\\|;\\|<\\|=\\|>\\|@\\|\\[\\|\\\\\\|\\]\\|\\^\\|_\\|`\\|{\\|\\\\|\\|}\\)' return fn.substitute(str, pattern, '\\\\\\0', 'g') @@ -223,7 +223,7 @@ local function make_lsp_sections() make_section(2, '\n\n', { { v.default and 'Default: ' .. tick(inspect(v.default, { newline = '', indent = '' })) }, { v.items and 'Array items: ' .. tick(inspect(v.items, { newline = '', indent = '' })) }, - { excape_markdown_punctuations(v.description) }, + { escape_markdown_punctuations(v.description) }, }), }) end) |