docs: formatting

This commit is contained in:
Soliprem 2025-12-11 19:06:49 +01:00
commit 71f352d41e
4 changed files with 86 additions and 49 deletions

View file

@ -6,49 +6,87 @@ formatters, and `nvim-lint` linter integration. This gets you capabilities
ranging from autocompletion to formatting to diagnostics. The following ranging from autocompletion to formatting to diagnostics. The following
languages have sections under the `vim.languages` attribute. languages have sections under the `vim.languages` attribute.
- Rust: [vim.languages.rust.enable](./options.html#option-vim-languages-rust-enable) - Rust:
- Nix: [vim.languages.nix.enable](./options.html#option-vim-languages-nix-enable) [vim.languages.rust.enable](./options.html#option-vim-languages-rust-enable)
- SQL: [vim.languages.sql.enable](./options.html#option-vim-languages-sql-enable) - Nix:
- C/C++: [vim.languages.clang.enable](./options.html#option-vim-languages-clang-enable) [vim.languages.nix.enable](./options.html#option-vim-languages-nix-enable)
- Typescript/Javascript: [vim.languages.ts.enable](./options.html#option-vim-languages-ts-enable) - SQL:
- Python: [vim.languages.python.enable](./options.html#option-vim-languages-python-enable): [vim.languages.sql.enable](./options.html#option-vim-languages-sql-enable)
- Zig: [vim.languages.zig.enable](./options.html#option-vim-languages-zig-enable) - C/C++:
- Markdown: [vim.languages.markdown.enable](./options.html#option-vim-languages-markdown-enable) [vim.languages.clang.enable](./options.html#option-vim-languages-clang-enable)
- HTML: [vim.languages.html.enable](./options.html#option-vim-languages-html-enable) - Typescript/Javascript:
- Dart: [vim.languages.dart.enable](./options.html#option-vim-languages-dart-enable) [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) - Go: [vim.languages.go.enable](./options.html#option-vim-languages-go-enable)
- Lua: [vim.languages.lua.enable](./options.html#option-vim-languages-lua-enable) - Lua:
- PHP: [vim.languages.php.enable](./options.html#option-vim-languages-php-enable) [vim.languages.lua.enable](./options.html#option-vim-languages-lua-enable)
- F#: [vim.languages.fsharp.enable](./options.html#option-vim-languages-fsharp-enable) - PHP:
- Assembly: [vim.languages.assembly.enable](./options.html#option-vim-languages-assembly-enable) [vim.languages.php.enable](./options.html#option-vim-languages-php-enable)
- Astro: [vim.languages.astro.enable](./options.html#option-vim-languages-astro-enable) - F#:
- Bash: [vim.languages.bash.enable](./options.html#option-vim-languages-bash-enable) [vim.languages.fsharp.enable](./options.html#option-vim-languages-fsharp-enable)
- Clang: [vim.languages.clang.enable](./options.html#option-vim-languages-clang-enable) - Assembly:
- Clojure: [vim.languages.clojure.enable](./options.html#option-vim-languages-clojure-enable) [vim.languages.assembly.enable](./options.html#option-vim-languages-assembly-enable)
- C#: [vim.languages.csharp.enable](./options.html#option-vim-languages-csharp-enable) - Astro:
- CSS: [vim.languages.css.enable](./options.html#option-vim-languages-css-enable) [vim.languages.astro.enable](./options.html#option-vim-languages-astro-enable)
- CUE: [vim.languages.cue.enable](./options.html#option-vim-languages-cue-enable) - Bash:
- Elixir: [vim.languages.elixir.enable](./options.html#option-vim-languages-elixir-enable) [vim.languages.bash.enable](./options.html#option-vim-languages-bash-enable)
- Gleam: [vim.languages.gleam.enable](./options.html#option-vim-languages-gleam-enable) - Clang:
- HCL: [vim.languages.hcl.enable](./options.html#option-vim-languages-hcl-enable) [vim.languages.clang.enable](./options.html#option-vim-languages-clang-enable)
- Helm: [vim.languages.helm.enable](./options.html#option-vim-languages-helm-enable) - Clojure:
- Julia: [vim.languages.julia.enable](./options.html#option-vim-languages-julia-enable) [vim.languages.clojure.enable](./options.html#option-vim-languages-clojure-enable)
- Kotlin: [vim.languages.kotlin.enable](./options.html#option-vim-languages-kotlin-enable) - C#:
- Nim: [vim.languages.nim.enable](./options.html#option-vim-languages-nim-enable) [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) - Nu: [vim.languages.nu.enable](./options.html#option-vim-languages-nu-enable)
- OCaml: [vim.languages.ocaml.enable](./options.html#option-vim-languages-ocaml-enable) - OCaml:
- Odin: [vim.languages.odin.enable](./options.html#option-vim-languages-odin-enable) [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) - R: [vim.languages.r.enable](./options.html#option-vim-languages-r-enable)
- Ruby: [vim.languages.ruby.enable](./options.html#option-vim-languages-ruby-enable) - Ruby:
- Scala: [vim.languages.scala.enable](./options.html#option-vim-languages-scala-enable) [vim.languages.ruby.enable](./options.html#option-vim-languages-ruby-enable)
- Svelte: [vim.languages.svelte.enable](./options.html#option-vim-languages-svelte-enable) - Scala:
- Tailwind: [vim.languages.tailwind.enable](./options.html#option-vim-languages-tailwind-enable) [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: - Terraform:
[vim.languages.terraform.enable](./options.html#option-vim-languages-terraform-enable) [vim.languages.terraform.enable](./options.html#option-vim-languages-terraform-enable)
- Typst: [vim.languages.typst.enable](./options.html#option-vim-languages-typst-enable) - Typst:
- Vala: [vim.languages.vala.enable](./options.html#option-vim-languages-vala-enable) [vim.languages.typst.enable](./options.html#option-vim-languages-typst-enable)
- WGSL: [vim.languages.wgsl.enable](./options.html#option-vim-languages-wgsl-enable) - Vala:
- YAML: [vim.languages.yaml.enable](./options.html#option-vim-languages-yaml-enable) [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 Adding support for more languages, and improving support for existing ones are
great places where you can contribute with a PR. great places where you can contribute with a PR.

View file

@ -1,10 +1,10 @@
# Overriding plugins {#ch-overriding-plugins} # Overriding plugins {#ch-overriding-plugins}
The [additional plugins section](./hacking.html#sec-additional-plugins) details the addition The [additional plugins section](./hacking.html#sec-additional-plugins) details
of new plugins to nvf under regular circumstances, i.e. while making a pull the addition of new plugins to nvf under regular circumstances, i.e. while
request to the project. You may _override_ those plugins in your config to making a pull request to the project. You may _override_ those plugins in your
change source versions, e.g., to use newer versions of plugins that are not yet config to change source versions, e.g., to use newer versions of plugins that
updated in **nvf**. are not yet updated in **nvf**.
```nix ```nix
vim.pluginOverrides = { vim.pluginOverrides = {

View file

@ -273,8 +273,7 @@ An example, simple keybinding, can look like this:
``` ```
There are many settings available in the options. Please refer to the There are many settings available in the options. Please refer to the
[documentation](./options.html#option-vim-keymaps) to [documentation](./options.html#option-vim-keymaps) to see a list of them.
see a list of them.
**nvf** provides a helper function, so that you don't have to write the mapping **nvf** provides a helper function, so that you don't have to write the mapping
attribute sets every time: attribute sets every time:

View file

@ -159,10 +159,10 @@ vim.api.nvim_set_keymap('n', '<leader>a', ':lua camelToSnake()<CR>', { noremap =
arguments to take `luaBefore`, `luaConfig` and `luaAfter` as strings, which arguments to take `luaBefore`, `luaConfig` and `luaAfter` as strings, which
are then concatted inside a lua block. are then concatted inside a lua block.
- Added {option}`vim.luaConfigPre` and {option} `vim-luaConfigPost` for inserting - Added {option}`vim.luaConfigPre` and {option} `vim-luaConfigPost` for
verbatim Lua configuration before and after the resolved Lua DAG respectively. inserting verbatim Lua configuration before and after the resolved Lua DAG
Both of those options take strings as the type, so you may read the contents respectively. Both of those options take strings as the type, so you may read
of a Lua file from a given path. the contents of a Lua file from a given path.
- Added `vim.spellchecking.ignoredFiletypes` and - Added `vim.spellchecking.ignoredFiletypes` and
`vim.spellChecking.programmingWordlist.enable` for ignoring certain filetypes `vim.spellChecking.programmingWordlist.enable` for ignoring certain filetypes