From 4156ecfb21a46722cc456fca92fa45a7dae22723 Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Thu, 7 Nov 2024 15:06:07 +0300 Subject: [PATCH] docs/try-it-out: correct number of available configs; fix typos --- docs/manual/try-it-out.md | 39 ++++++++++++++++++++++++--------------- 1 file changed, 24 insertions(+), 15 deletions(-) diff --git a/docs/manual/try-it-out.md b/docs/manual/try-it-out.md index bd8c69bb..8244c2b7 100644 --- a/docs/manual/try-it-out.md +++ b/docs/manual/try-it-out.md @@ -1,25 +1,27 @@ # Try it out {#ch-try-it-out} -Thanks to the portability of Nix, you can try out nvf 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 +Thanks to the portability of Nix, you can try out nvf 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, two specialized configurations are provided: -- Nix -- Maximal +- **Nix** - Nix language server + simple utility plugins +- **Maximal** - Variable language servers + utility and decorative plugins -You may try out any of the provided configurations using the `nix run` command on a system where Nix is installed. +You may try out any of the provided configurations using the `nix run` command +on a system where Nix is installed. -```console +```bash $ cachix use nvf # Optional: it'll save you CPU resources and time $ nix run github:notashelf/nvf#nix # will run the default minimal configuration ``` -Do keep in mind that this is **susceptible to garbage collection** meaning it will be removed from your Nix store -once you garbage collect. +Do keep in mind that this is **susceptible to garbage collection** meaning it +will be removed from your Nix store once you garbage collect. -## Using Prebuilt Configs {#sec-using-prebuild-configs} +## Using Prebuilt Configs {#sec-using-prebuilt-configs} -```console +```bash $ nix run github:notashelf/nvf#nix $ nix run github:notashelf/nvf#maximal ``` @@ -28,12 +30,19 @@ $ nix run github:notashelf/nvf#maximal #### Nix {#sec-configs-nix} -`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. +`Nix` configuration by default provides LSP/diagnostic support for Nix alongside +a set of visual and functional plugins. By running `nix run .#`, which is the +default package, you will build Neovim with this config. #### Maximal {#sec-configs-maximal} -`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. +`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. -You are _strongly_ recommended to use the binary cache if you would like to try the Maximal configuration. +::: {.tip} + +You are _strongly_ recommended to use the binary cache if you would like to try +the Maximal configuration. + +:::