mirror of
https://github.com/NotAShelf/nvf.git
synced 2025-10-02 23:13:30 +00:00
NotAShelf
b9dd1b816a
Signed-off-by: NotAShelf <raf@notashelf.dev> Change-Id: I6a6a6964afba43bdda6a2cbf037404ca3fa4f8c9
101 lines
3.7 KiB
Markdown
101 lines
3.7 KiB
Markdown
# Introduction {#nvf-manual}
|
|
|
|
Version @NVF_VERSION@
|
|
|
|
## Preface {#ch-preface}
|
|
|
|
### What is nvf {#sec-what-is-it}
|
|
|
|
**nvf** is a highly modular, configurable, extensible and easy to use Neovim
|
|
configuration framework built and designed to be used with Nix. Boasting
|
|
flexibility, robustness and ease of use, this projecct allows you to configure a
|
|
fully featured Neovim instance with a few lines of Nix with lots of options for
|
|
advanced users as well.
|
|
|
|
## 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, two specialized
|
|
configurations are provided:
|
|
|
|
- **Nix** (`packages.nix`) - Nix language server + simple utility plugins
|
|
- **Maximal** (`packages.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.
|
|
|
|
```sh
|
|
$ 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 that
|
|
the built outputs will be removed from your Nix store once you garbage collect.
|
|
|
|
## Using Prebuilt Configs {#sec-using-prebuilt-configs}
|
|
|
|
```bash
|
|
$ nix run github:notashelf/nvf#nix
|
|
$ nix run github:notashelf/nvf#maximal
|
|
```
|
|
|
|
### Available Configurations {#sec-available-configs}
|
|
|
|
> [!NOTE]
|
|
> The below configurations are provided for demonstration purposes, and are
|
|
> **not** designed to be installed as is. You may refer to the installation
|
|
> steps below and the helpful tips section for details on creating your own
|
|
> configurations.
|
|
|
|
#### Nix {#sec-configs-nix}
|
|
|
|
`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.
|
|
|
|
```bash
|
|
$ nix run github:notashelf/nvf#nix test.nix
|
|
# => This will open a file called `test.nix` with Nix LSP and syntax highlighting
|
|
```
|
|
|
|
This command will start Neovim with some opinionated plugin configurations, and
|
|
is designed specifically for Nix. the `nix` configuration lets you see how a
|
|
fully configured Neovim setup _might_ look like without downloading too many
|
|
packages or shell utilities.
|
|
|
|
#### 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.
|
|
|
|
```bash
|
|
$ nix run github:notashelf/nvf#maximal -- test.nix
|
|
# => This will open a file called `test.nix` with a variety of plugins available
|
|
```
|
|
|
|
It uses the same configuration template with the [Nix](#sec-configs-nix)
|
|
configuration, but supports many more languages, and enables more utility,
|
|
companion or fun plugins.
|
|
|
|
> [!WARNING]
|
|
> Running the maximal config will download _a lot_ of packages as it is
|
|
> downloading language servers, formatters, and more. If CPU time and bandwidth
|
|
> are concerns, please use the default package instead.
|
|
|
|
## Installing nvf {#ch-installation}
|
|
|
|
[module installation section]: #ch-module-installation
|
|
|
|
There are multiple ways of installing nvf on your system. You may either choose
|
|
the standalone installation method, which does not depend on a module system and
|
|
may be done on any system that has the Nix package manager or the appropriate
|
|
modules for NixOS and home-manager as described in the
|
|
[module installation section].
|
|
|
|
```{=include=}
|
|
installation/custom-configuration.md
|
|
installation/modules.md
|
|
```
|