diff --git a/index.xhtml b/index.xhtml index 7eaf526a..66995c39 100644 --- a/index.xhtml +++ b/index.xhtml @@ -33,7 +33,7 @@
-

Table of Contents

Preface
What is nvf
Bugs & Suggestions
Try it out
Using Prebuilt Configs
Default Configs
Maximal
Nix
Installing nvf
Standalone Installation
Standalone Installation on NixOS
Standalone Installation on Home-Manager
Module Installation
NixOS Module
Home-Manager Module
Configuring nvf
Custom Neovim Package
Custom Plugins
Adding Plugins
Custom Inputs
Language Support
LSP Custom Packages/Command
Using DAGs
entryAnywhere
entryAfter
entryBefore
entryBetween
entriesAnywhere
entriesAfter
entriesBefore
entriesBetween
DAG entries in nvf
vim.luaConfigRC (top-level DAG)
Hacking nvf
Getting Started
Guidelines
Testing Changes
Keybinds
Adding Plugins
A. Known Issues and Quirks
NodeJS
B. Neovim Flake Configuration Options
C. Release Notes
Release 0.1
Release 0.2
Release 0.3
Release 0.4
Release 0.5
Release 0.6
Release 0.7
+

Table of Contents

Preface
What is nvf
Bugs & Suggestions
Try it out
Using Prebuilt Configs
Default Configs
Maximal
Nix
Installing nvf
Standalone Installation
Standalone Installation on NixOS
Standalone Installation on Home-Manager
Module Installation
NixOS Module
Home-Manager Module
Configuring nvf
Custom Neovim Package
Custom Plugins
Adding Plugins
Custom Inputs
Language Support
LSP Custom Packages/Command
Using DAGs
entryAnywhere
entryAfter
entryBefore
entryBetween
entriesAnywhere
entriesAfter
entriesBefore
entriesBetween
DAG entries in nvf
vim.luaConfigRC (top-level DAG)
Helpful Tips
Debugging nvf
Offline Documentation
Hacking nvf
Getting Started
Guidelines
Testing Changes
Keybinds
Adding Plugins
A. Known Issues and Quirks
NodeJS
B. Neovim Flake Configuration Options
C. Release Notes
Release 0.1
Release 0.2
Release 0.3
Release 0.4
Release 0.5
Release 0.6
Release 0.7

Preface

Table of Contents

What is nvf
Bugs & Suggestions

What is nvf

nvf is a highly modular, configurable, extensible and easy to use Neovim configuration in Nix. Designed for flexibility and ease of use, nvf allows you to easily configure your fully featured Neovim instance with a few lines of Nix.

@@ -648,6 +648,20 @@ own plugins) DAG, used to set up internal plugins

  • < direct DAG, but is converted to, and resolved as one internally

  • mappings - the result of vim.maps

  • + +

    Helpful Tips

    Debugging nvf

    There may be instances where the your Nix configuration evaluates to invalid +Lua, or times when you will be asked to provide your built Lua configuration for +easier debugging by nvf maintainers. nvf provides two helpful utilities out of +the box.

    nvf-print-config and nvf-print-config-path will be bundled with nvf as +lightweight utilities to help you view or share your built configuration when +necessary.

    To view your configuration with syntax highlighting, you may use the +bat pager.

    nvf-print-config | bat --language=lua
    +

    Alternatively, cat or less may also be used.

    +

    Offline Documentation

    The manpages provided by nvf contains an offline version of the option search +normally available at https://notashelf.github.io/nvf/options.html. You may +use the man 5 nvf command to view option documentation from the comfort of +your terminal.

    Note that this is only available for NixOS and Home-Manager module +installations.

    Hacking nvf

    Table of Contents

    Getting Started
    Guidelines
    Adding Documentation
    Formatting Code
    Formatting Commits
    Commit Style
    Example Commit
    Code Style
    Testing Changes
    Keybinds
    Custom Key Mappings Support for a Plugin
    Adding Plugins
    Modular setup options
    Details of toLuaObject
    Lazy plugins

    nvf is designed for the developer as much as it is designed for the end-user. We would like for any contributor to be able to propagate their changes, or add new