From 71f352d41ee17150a7b8cf8dab6135edd020fc4c Mon Sep 17 00:00:00 2001 From: Soliprem Date: Thu, 11 Dec 2025 19:06:49 +0100 Subject: [PATCH] docs: formatting --- docs/manual/configuring/languages.md | 114 ++++++++++++------ docs/manual/configuring/overriding-plugins.md | 10 +- docs/manual/hacking.md | 3 +- docs/manual/release-notes/rl-0.6.md | 8 +- 4 files changed, 86 insertions(+), 49 deletions(-) diff --git a/docs/manual/configuring/languages.md b/docs/manual/configuring/languages.md index 1b8c5330..f956a0e3 100644 --- a/docs/manual/configuring/languages.md +++ b/docs/manual/configuring/languages.md @@ -6,49 +6,87 @@ formatters, and `nvim-lint` linter integration. This gets you capabilities ranging from autocompletion to formatting to diagnostics. The following languages have sections under the `vim.languages` attribute. -- Rust: [vim.languages.rust.enable](./options.html#option-vim-languages-rust-enable) -- Nix: [vim.languages.nix.enable](./options.html#option-vim-languages-nix-enable) -- SQL: [vim.languages.sql.enable](./options.html#option-vim-languages-sql-enable) -- C/C++: [vim.languages.clang.enable](./options.html#option-vim-languages-clang-enable) -- Typescript/Javascript: [vim.languages.ts.enable](./options.html#option-vim-languages-ts-enable) -- Python: [vim.languages.python.enable](./options.html#option-vim-languages-python-enable): -- Zig: [vim.languages.zig.enable](./options.html#option-vim-languages-zig-enable) -- Markdown: [vim.languages.markdown.enable](./options.html#option-vim-languages-markdown-enable) -- HTML: [vim.languages.html.enable](./options.html#option-vim-languages-html-enable) -- Dart: [vim.languages.dart.enable](./options.html#option-vim-languages-dart-enable) +- Rust: + [vim.languages.rust.enable](./options.html#option-vim-languages-rust-enable) +- Nix: + [vim.languages.nix.enable](./options.html#option-vim-languages-nix-enable) +- SQL: + [vim.languages.sql.enable](./options.html#option-vim-languages-sql-enable) +- C/C++: + [vim.languages.clang.enable](./options.html#option-vim-languages-clang-enable) +- Typescript/Javascript: + [vim.languages.ts.enable](./options.html#option-vim-languages-ts-enable) +- Python: + [vim.languages.python.enable](./options.html#option-vim-languages-python-enable): +- Zig: + [vim.languages.zig.enable](./options.html#option-vim-languages-zig-enable) +- Markdown: + [vim.languages.markdown.enable](./options.html#option-vim-languages-markdown-enable) +- HTML: + [vim.languages.html.enable](./options.html#option-vim-languages-html-enable) +- Dart: + [vim.languages.dart.enable](./options.html#option-vim-languages-dart-enable) - Go: [vim.languages.go.enable](./options.html#option-vim-languages-go-enable) -- Lua: [vim.languages.lua.enable](./options.html#option-vim-languages-lua-enable) -- PHP: [vim.languages.php.enable](./options.html#option-vim-languages-php-enable) -- F#: [vim.languages.fsharp.enable](./options.html#option-vim-languages-fsharp-enable) -- Assembly: [vim.languages.assembly.enable](./options.html#option-vim-languages-assembly-enable) -- Astro: [vim.languages.astro.enable](./options.html#option-vim-languages-astro-enable) -- Bash: [vim.languages.bash.enable](./options.html#option-vim-languages-bash-enable) -- Clang: [vim.languages.clang.enable](./options.html#option-vim-languages-clang-enable) -- Clojure: [vim.languages.clojure.enable](./options.html#option-vim-languages-clojure-enable) -- C#: [vim.languages.csharp.enable](./options.html#option-vim-languages-csharp-enable) -- CSS: [vim.languages.css.enable](./options.html#option-vim-languages-css-enable) -- CUE: [vim.languages.cue.enable](./options.html#option-vim-languages-cue-enable) -- Elixir: [vim.languages.elixir.enable](./options.html#option-vim-languages-elixir-enable) -- Gleam: [vim.languages.gleam.enable](./options.html#option-vim-languages-gleam-enable) -- HCL: [vim.languages.hcl.enable](./options.html#option-vim-languages-hcl-enable) -- Helm: [vim.languages.helm.enable](./options.html#option-vim-languages-helm-enable) -- Julia: [vim.languages.julia.enable](./options.html#option-vim-languages-julia-enable) -- Kotlin: [vim.languages.kotlin.enable](./options.html#option-vim-languages-kotlin-enable) -- Nim: [vim.languages.nim.enable](./options.html#option-vim-languages-nim-enable) +- Lua: + [vim.languages.lua.enable](./options.html#option-vim-languages-lua-enable) +- PHP: + [vim.languages.php.enable](./options.html#option-vim-languages-php-enable) +- F#: + [vim.languages.fsharp.enable](./options.html#option-vim-languages-fsharp-enable) +- Assembly: + [vim.languages.assembly.enable](./options.html#option-vim-languages-assembly-enable) +- Astro: + [vim.languages.astro.enable](./options.html#option-vim-languages-astro-enable) +- Bash: + [vim.languages.bash.enable](./options.html#option-vim-languages-bash-enable) +- Clang: + [vim.languages.clang.enable](./options.html#option-vim-languages-clang-enable) +- Clojure: + [vim.languages.clojure.enable](./options.html#option-vim-languages-clojure-enable) +- C#: + [vim.languages.csharp.enable](./options.html#option-vim-languages-csharp-enable) +- CSS: + [vim.languages.css.enable](./options.html#option-vim-languages-css-enable) +- CUE: + [vim.languages.cue.enable](./options.html#option-vim-languages-cue-enable) +- Elixir: + [vim.languages.elixir.enable](./options.html#option-vim-languages-elixir-enable) +- Gleam: + [vim.languages.gleam.enable](./options.html#option-vim-languages-gleam-enable) +- HCL: + [vim.languages.hcl.enable](./options.html#option-vim-languages-hcl-enable) +- Helm: + [vim.languages.helm.enable](./options.html#option-vim-languages-helm-enable) +- Julia: + [vim.languages.julia.enable](./options.html#option-vim-languages-julia-enable) +- Kotlin: + [vim.languages.kotlin.enable](./options.html#option-vim-languages-kotlin-enable) +- Nim: + [vim.languages.nim.enable](./options.html#option-vim-languages-nim-enable) - Nu: [vim.languages.nu.enable](./options.html#option-vim-languages-nu-enable) -- OCaml: [vim.languages.ocaml.enable](./options.html#option-vim-languages-ocaml-enable) -- Odin: [vim.languages.odin.enable](./options.html#option-vim-languages-odin-enable) +- OCaml: + [vim.languages.ocaml.enable](./options.html#option-vim-languages-ocaml-enable) +- Odin: + [vim.languages.odin.enable](./options.html#option-vim-languages-odin-enable) - R: [vim.languages.r.enable](./options.html#option-vim-languages-r-enable) -- Ruby: [vim.languages.ruby.enable](./options.html#option-vim-languages-ruby-enable) -- Scala: [vim.languages.scala.enable](./options.html#option-vim-languages-scala-enable) -- Svelte: [vim.languages.svelte.enable](./options.html#option-vim-languages-svelte-enable) -- Tailwind: [vim.languages.tailwind.enable](./options.html#option-vim-languages-tailwind-enable) +- Ruby: + [vim.languages.ruby.enable](./options.html#option-vim-languages-ruby-enable) +- Scala: + [vim.languages.scala.enable](./options.html#option-vim-languages-scala-enable) +- Svelte: + [vim.languages.svelte.enable](./options.html#option-vim-languages-svelte-enable) +- Tailwind: + [vim.languages.tailwind.enable](./options.html#option-vim-languages-tailwind-enable) - Terraform: [vim.languages.terraform.enable](./options.html#option-vim-languages-terraform-enable) -- Typst: [vim.languages.typst.enable](./options.html#option-vim-languages-typst-enable) -- Vala: [vim.languages.vala.enable](./options.html#option-vim-languages-vala-enable) -- WGSL: [vim.languages.wgsl.enable](./options.html#option-vim-languages-wgsl-enable) -- YAML: [vim.languages.yaml.enable](./options.html#option-vim-languages-yaml-enable) +- Typst: + [vim.languages.typst.enable](./options.html#option-vim-languages-typst-enable) +- Vala: + [vim.languages.vala.enable](./options.html#option-vim-languages-vala-enable) +- WGSL: + [vim.languages.wgsl.enable](./options.html#option-vim-languages-wgsl-enable) +- YAML: + [vim.languages.yaml.enable](./options.html#option-vim-languages-yaml-enable) Adding support for more languages, and improving support for existing ones are great places where you can contribute with a PR. diff --git a/docs/manual/configuring/overriding-plugins.md b/docs/manual/configuring/overriding-plugins.md index e44c1d08..55979ce7 100644 --- a/docs/manual/configuring/overriding-plugins.md +++ b/docs/manual/configuring/overriding-plugins.md @@ -1,10 +1,10 @@ # Overriding plugins {#ch-overriding-plugins} -The [additional plugins section](./hacking.html#sec-additional-plugins) details the addition -of new plugins to nvf under regular circumstances, i.e. while making a pull -request to the project. You may _override_ those plugins in your config to -change source versions, e.g., to use newer versions of plugins that are not yet -updated in **nvf**. +The [additional plugins section](./hacking.html#sec-additional-plugins) details +the addition of new plugins to nvf under regular circumstances, i.e. while +making a pull request to the project. You may _override_ those plugins in your +config to change source versions, e.g., to use newer versions of plugins that +are not yet updated in **nvf**. ```nix vim.pluginOverrides = { diff --git a/docs/manual/hacking.md b/docs/manual/hacking.md index 609ddc92..7af0fed9 100644 --- a/docs/manual/hacking.md +++ b/docs/manual/hacking.md @@ -273,8 +273,7 @@ An example, simple keybinding, can look like this: ``` There are many settings available in the options. Please refer to the -[documentation](./options.html#option-vim-keymaps) to -see a list of them. +[documentation](./options.html#option-vim-keymaps) to see a list of them. **nvf** provides a helper function, so that you don't have to write the mapping attribute sets every time: diff --git a/docs/manual/release-notes/rl-0.6.md b/docs/manual/release-notes/rl-0.6.md index 13cdd7bb..f40ecb43 100644 --- a/docs/manual/release-notes/rl-0.6.md +++ b/docs/manual/release-notes/rl-0.6.md @@ -159,10 +159,10 @@ vim.api.nvim_set_keymap('n', 'a', ':lua camelToSnake()', { noremap = arguments to take `luaBefore`, `luaConfig` and `luaAfter` as strings, which are then concatted inside a lua block. -- Added {option}`vim.luaConfigPre` and {option} `vim-luaConfigPost` for inserting - verbatim Lua configuration before and after the resolved Lua DAG respectively. - Both of those options take strings as the type, so you may read the contents - of a Lua file from a given path. +- Added {option}`vim.luaConfigPre` and {option} `vim-luaConfigPost` for + inserting verbatim Lua configuration before and after the resolved Lua DAG + respectively. Both of those options take strings as the type, so you may read + the contents of a Lua file from a given path. - Added `vim.spellchecking.ignoredFiletypes` and `vim.spellChecking.programmingWordlist.enable` for ignoring certain filetypes