diff --git a/README.md b/README.md index 9fd9681812..757325e715 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,8 @@ lightline plugin: When we do this, lightline will be set up to a sensible default, and will use gruvbox as the colorscheme, no extra configuration required! +Check out [this list of real world nixvim configs](https://nix-community.github.io/nixvim/user-guide/config-examples.html)! + ## Support/Questions If you have any question, please use the [discussions page](https://github.com/nix-community/nixvim/discussions/categories/q-a)! Alternatively, join the Matrix channel at [#nixvim:matrix.org](https://matrix.to/#/#nixvim:matrix.org)! diff --git a/docs/man/default.nix b/docs/man/default.nix index 38eafbcf17..e190c0b980 100644 --- a/docs/man/default.nix +++ b/docs/man/default.nix @@ -39,6 +39,7 @@ let ${./nixvim-header-start.5} \ ${mkMDSection ../user-guide/helpers.md} \ ${mkMDSection ../user-guide/faq.md} \ + ${mkMDSection ../user-guide/config-examples.md} \ ${./nixvim-header-end.5} \ >$out/nixvim-header.5 ''; diff --git a/docs/mdbook/SUMMARY.md b/docs/mdbook/SUMMARY.md index c73604fa64..9d2f41658b 100644 --- a/docs/mdbook/SUMMARY.md +++ b/docs/mdbook/SUMMARY.md @@ -1,10 +1,11 @@ -# Structure for nixvim docs +# Structure for nixvim docs # User guide - [Installation](./user-guide/install.md) - [Helpers](./user-guide/helpers.md) - [FAQ](./user-guide/faq.md) +- [Configuration examples](./user-guide/config-examples.md) # Platforms diff --git a/docs/user-guide/config-examples.md b/docs/user-guide/config-examples.md new file mode 100644 index 0000000000..b561561118 --- /dev/null +++ b/docs/user-guide/config-examples.md @@ -0,0 +1,43 @@ +# User configurations + +Want some help with starting your configuration? +Or maybe you're curious how others have done things? +Take a look at these configuration examples below. + + + +**Note:**\ +Most of those configurations are using a [standalone build](../modules/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] | | +| [GaetanLepage/nix-config] | Home-manager | +| [gwg313/nvim-nix] | | +| [hbjydev/hvim] | | +| [nicolas-goudry/nixvim-config] | Heavily inspired by AstroNvim | +| [pete3n/nixvim-flake] | | +| [redyf/Neve] | meticulously crafted custom configuration for Nixvim | +| [siph/nixvim-flake] | | +| [Tanish2002/neovim-config] | | +| [traxys/Nixfiles] | | + +[ahwxorg/nixvim-config]: https://github.com/ahwxorg/nixvim-config +[alisonjenkins/neovim-nix-flake]: https://github.com/alisonjenkins/neovim-nix-flake +[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 +[nicolas-goudry/nixvim-config]: https://github.com/nicolas-goudry/nixvim-config +[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 +[Tanish2002/neovim-config]: https://github.com/Tanish2002/neovim-config +[traxys/Nixfiles]: https://github.com/traxys/Nixfiles/tree/master/neovim + +## 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)