mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-07-15 11:44:32 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

docs/config-examples: generate dynamically from a toml list

Browse source 
This should help to maintain uniformity and hopefully make contributions
easier.

Kept regression tests local to the derivation, however these are also
added to the flake checks.
This commit is contained in:
Matt Sturgeon 2024-12-14 18:54:27 +00:00
parent 8eeea073fc
commit a658e81d71
No known key found for this signature in database
GPG key ID: 4F91844CED1A8299
6 changed files with 361 additions and 56 deletions
Download patch file Download diff file Expand all files Collapse all files

70
docs/user-guide/config-examples.md
View file

@ -10,62 +10,20 @@ Take a look at these configuration examples below.
Most of those configurations are using a [standalone build](../platforms/standalone.html), however,
all of the nixvim options are accessible no matter how you are using it (flake, NixOS/HM module, nix-darwin...).
| Config | Comment |
|-|-|
| [ahwxorg/nixvim-config] | |
| [alisonjenkins/neovim-nix-flake] | |
| [bkp5190/home-manager-configs] | Home-manager |
| [dc-tec/nixvim] | NixVim config, inspired by some of the contributors in this list and LazyVIM |
| [elythh/nixvim] | |
| [fred-drake/neovim] | NixVim config, with format/lsp/debug configurations for Rust, Go, Python and more |
| [GaetanLepage/nix-config] | Home-manager |
| [gwg313/nvim-nix] | |
| [hbjydev/hvim] | |
| [JMartJonesy/kickstart.nixvim] | An implementation of kickstart.nvim using nixvim |
| [JMartJonesy/kickstart.nixvim/tree/standalone] | An implementation of kickstart.nvim using nixvim in a standalone flake |
| [khaneliman/khanelivim] | Constantly tweaked jack of all trades development focused configuration. |
| [MikaelFangel/nixvim-config] | An easy-setup configuration for NixVim, focused on straightforward customization |
| [nicolas-goudry/nixvim-config] | Heavily inspired by AstroNvim |
| [NikolayGalkin/gnvim] | Clean and simple Neovim configuration |
| [niksingh710/nvix] | Ported from a lazy-based lua config. Contains examples of most use cases, including custom, nixpkgs, & nixvim plugins. |
| [pete3n/nixvim-flake] | |
| [redyf/Neve] | Meticulously crafted custom configuration for Nixvim |
| [siph/nixvim-flake] | |
| [spector700/Akari] | Inspired from LazyVim with parts yoinked from other NixVim configs |
| [Tanish2002/neovim-config] | |
| [traxys/Nixfiles] | |
| [veeronniecaw/ronvim] | |
| [zainkergaye/nixosdotfiles] | NixVim editor primarily for Java and Asciidoc |
<!-- WARNING: Please ensure entries are alphabetically sorted ! -->
[ahwxorg/nixvim-config]: https://github.com/ahwxorg/nixvim-config
[alisonjenkins/neovim-nix-flake]: https://github.com/alisonjenkins/neovim-nix-flake
[bkp5190/home-manager-configs]: https://github.com/bkp5190/Home-Manager-Configs
[dc-tec/nixvim]: https://github.com/dc-tec/nixvim
[elythh/nixvim]: https://github.com/elythh/nixvim
[fred-drake/neovim]: https://github.com/fred-drake/neovim
[GaetanLepage/nix-config]: https://github.com/GaetanLepage/nix-config/tree/master/home/modules/tui/neovim
[gwg313/nvim-nix]: https://github.com/gwg313/nvim-nix
[hbjydev/hvim]: https://github.com/hbjydev/hvim
[JMartJonesy/kickstart.nixvim]: https://github.com/JMartJonesy/kickstart.nixvim
[JMartJonesy/kickstart.nixvim/tree/standalone]: https://github.com/JMartJonesy/kickstart.nixvim/tree/standalone
[khaneliman/khanelivim]: https://github.com/khaneliman/khanelivim
[MikaelFangel/nixvim-config]: https://github.com/MikaelFangel/nixvim-config
[nicolas-goudry/nixvim-config]: https://github.com/nicolas-goudry/nixvim-config
[NikolayGalkin/gnvim]: https://github.com/NikolayGalkin/gnvim
[niksingh710/nvix]: https://github.com/niksingh710/nvix
[pete3n/nixvim-flake]: https://github.com/pete3n/nixvim-flake
[redyf/Neve]: https://github.com/redyf/Neve
[siph/nixvim-flake]: https://github.com/siph/nixvim-flake
[spector700/Akari]: https://github.com/spector700/Akari
[Tanish2002/neovim-config]: https://github.com/Tanish2002/neovim-config
[traxys/Nixfiles]: https://github.com/traxys/Nixfiles/tree/master/neovim
[veeronniecaw/ronvim]: https://codeberg.org/veeronniecaw/ronvim
[zainkergaye/nixosdotfiles]: https://github.com/ZainKergaye/nixosdotfiles/tree/master/user/programs/nixvim
@USER_CONFIGS@
## Share your config !
To add a configuration to this list, either:
- Edit [this file](https://github.com/nix-community/nixvim/blob/main/docs/user-guide/config-examples.md) and make a PR on the [nixvim repo](https://github.com/nix-community/nixvim).
- Send a message to the [matrix _Documentation_ room](https://matrix.to/#/#nixvim-documentation:matrix.org)
> [!TIP]
> You can add your config to the list by editing the [`docs/user-configs/list.toml`] file.
Please use this format for both your commit message and PR title: \
`user-configs: add @Username's config"` \
(replacing `Username` with your github username)
Alternatively, message us in the [matrix _Documentation_ room] and we'll get it added.
[`docs/user-configs/list.toml`]: https://github.com/nix-community/nixvim/blob/main/docs/user-configs/list.toml
[matrix _Documentation_ room]: https://matrix.to/#/#nixvim-documentation:matrix.org