Skip to content

Commit

Permalink
Merge branch 'main' into telescope-ext
Browse files Browse the repository at this point in the history
  • Loading branch information
NotAShelf authored Jan 25, 2025
2 parents 4b22740 + 4242640 commit 3e4503f
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 17 deletions.
15 changes: 9 additions & 6 deletions docs/man/header.5
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
.TH "nvf" "5" "01/01/1980" "nvf"
.TH "nvf" "5" "January 1, 1980" "nvf"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" enable line breaks after slashes
.cflags 4 /

.SH "NAME"
nvf configuration specification
.SH "OPTIONS"
.PP
You can use the following options to configure nvf:
.PP
nvf \- Configuration specification for the nvf.

.SH "DESCRIPTION"
The nvf configuration specification provides a declarative structure for configuring Neovim using Nix with few
lines of Nix. This document outlines the available options and their usage to create modular, reusable, and
reproducible configurations using nvf's module system options. For tips, tricks and possible quirks with available
plugins please visit https://notashelf.github.io/nvf/
41 changes: 30 additions & 11 deletions docs/man/nvf.1
Original file line number Diff line number Diff line change
@@ -1,33 +1,52 @@
.Dd January 1, 1980
.Dt nvf 1
.Dt NVF 1
.Os nvf
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" enable line breaks after slashes
.cflags 4 /

.Sh NAME
.Nm nvf
.Nd A highly modular, extensible and distro-agnostic Neovim configuration framework for Nix/NixOS.
.
.Nd A modular, extensible, and distro-agnostic Neovim configuration framework for Nix/NixOS.

.Sh DESCRIPTION
.Nm 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.

.Sh COMMANDS
The following commands are bundled with nvf to allow easier debugging of your configuration.

.Bl -tag -width Ds
.It Nm nvf-print-config
Outputs the full configuration of the current `nvf` setup. This command is useful for debugging
or inspecting the applied configuration.
.Pp
.It Nm nvf-print-config-path
Prints the file path to the configuration file currently in use. This command is helpful for locating
the source configuration file for troubleshooting or easily sharing it via online paste utilities.
.El

.Sh BUGS
.Pp
Please report any bugs that you might encounter on the
\m[blue]\fBproject issue tracker\fR\m[]\&.
Please report any bugs on the project issue tracker:
.Lk https://github.com/notashelf/nvf/issues

.Sh SEE ALSO
.Pp
\fBnvf\fR(5)
.Fn nvf 5

.Sh AUTHOR
.Pp
\fBnvf contributors\fR
.Fn nvf contributors
.RS 4
Author.
Primary contributors and maintainers of the project.
.RE

.Sh COPYRIGHT
.br
Copyright \(co 2023\(en2024 nvf contributors
.br
.Pp
Copyright (c) 2023–2025 nvf contributors.

0 comments on commit 3e4503f

Please sign in to comment.