2023-02-06 19:10:37 +01:00
|
|
|
[[ch-try-it-out]]
|
|
|
|
== Try it out
|
|
|
|
|
2023-10-03 21:06:26 +02:00
|
|
|
Thanks to the portability of Nix, you can try out neovim-flake without actually installing it to your machine.
|
|
|
|
Below are the commands you may run to try out different configurations provided by this flake. As of v0.5, three
|
|
|
|
configurations are provided:
|
|
|
|
|
|
|
|
* Nix
|
|
|
|
* Tidal
|
|
|
|
* Maximal
|
|
|
|
|
|
|
|
You may try out any of the provided configurations using the `nix run` command on a system where Nix is installed.
|
|
|
|
|
2023-02-06 19:10:37 +01:00
|
|
|
[source,console]
|
|
|
|
----
|
|
|
|
$ cachix use neovim-flake # Optional: it'll save you CPU resources and time
|
2023-10-03 21:06:26 +02:00
|
|
|
$ nix run github:notashelf/neovim-flake#nix # will run the default minimal configuration
|
2023-02-06 19:10:37 +01:00
|
|
|
----
|
|
|
|
|
2023-10-03 21:06:26 +02:00
|
|
|
Do keep in mind that this is **susceptible to garbage collection** meaning it will be removed from your Nix store
|
|
|
|
once you garbage collect. If you wish to install neovim-flake, please take a look at
|
|
|
|
<<ch-custom-configuration,custom-configuration>> or <<ch-hm-module,home-manager>> sections for installation
|
|
|
|
instructions.
|
|
|
|
|
|
|
|
[[sec-using-prebuild-configs]]
|
|
|
|
=== Using Prebuilt Configs
|
2023-02-06 19:10:37 +01:00
|
|
|
|
2023-10-03 21:06:26 +02:00
|
|
|
[source,console]
|
|
|
|
----
|
|
|
|
$ nix run github:notashelf/neovim-flake#nix
|
|
|
|
$ nix run github:notashelf/neovim-flake#tidal
|
|
|
|
$ nix run github:notashelf/neovim-flake#maximal
|
|
|
|
----
|
2023-02-06 19:10:37 +01:00
|
|
|
|
|
|
|
|
2023-10-03 21:06:26 +02:00
|
|
|
[[sec-available-configs]]
|
|
|
|
=== Available Configs
|
2023-02-06 19:10:37 +01:00
|
|
|
|
2023-10-03 21:06:26 +02:00
|
|
|
==== Nix
|
2023-02-06 19:10:37 +01:00
|
|
|
|
2023-10-03 21:06:26 +02:00
|
|
|
`Nix` configuration by default provides LSP/diagnostic support for Nix alongisde a set of visual and functional plugins.
|
|
|
|
By running `nix run .`, which is the default package, you will build Neovim with this config.
|
2023-02-06 19:10:37 +01:00
|
|
|
|
2023-10-03 21:06:26 +02:00
|
|
|
==== Tidal
|
2023-02-06 19:10:37 +01:00
|
|
|
|
2023-10-03 21:06:26 +02:00
|
|
|
Tidal is an alternative config that adds vim-tidal on top of the plugins from the Nix configuration.
|
2023-04-15 11:06:03 +02:00
|
|
|
|
2023-10-03 21:06:26 +02:00
|
|
|
==== Maximal
|
2023-02-06 19:10:37 +01:00
|
|
|
|
2023-10-03 21:06:26 +02:00
|
|
|
`Maximal` is the ultimate configuration that will enable support for more commonly used language as well as additional
|
|
|
|
complementary plugins. Keep in mind, however, that this will pull a lot of dependencies.
|
2023-02-06 19:10:37 +01:00
|
|
|
|
2023-10-03 21:06:26 +02:00
|
|
|
You are *strongly* recommended to use the binary cache if you would like to try the Maximal configuration.
|