NotAShelf/nvf
1
0
Fork 0
mirror of https://github.com/NotAShelf/nvf.git synced 2025-01-30 13:52:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

docs: improve manpages; mention helpful utilities (#584)
Some checks failed
Set up binary cache / cachix (default) (push) Has been cancelled
Details
Set up binary cache / cachix (maximal) (push) Has been cancelled
Details
Set up binary cache / cachix (nix) (push) Has been cancelled
Details
Validate flake & check documentation / Validate Flake Documentation (docs) (push) Has been cancelled
Details
Validate flake & check documentation / Validate Flake Documentation (docs-html) (push) Has been cancelled
Details
Validate flake & check documentation / Validate Flake Documentation (docs-json) (push) Has been cancelled
Details
Validate flake & check documentation / Validate Flake Documentation (docs-manpages) (push) Has been cancelled
Details
Validate flake & check documentation / Validate hyperlinks in documentation sources (push) Has been cancelled
Details
Validate flake & check formatting / Validate Flake (push) Has been cancelled
Details
Validate flake & check formatting / Formatting via Alejandra (push) Has been cancelled
Details
Build and deploy documentation / Check latest commit (push) Has been cancelled
Details
Check for typos in the source tree / check-typos (push) Has been cancelled
Details
Build and deploy documentation / publish (push) Has been cancelled
Details

Browse source
This commit is contained in:
raf 2025-01-25 17:25:46 +03:00 committed by GitHub
commit 4242640c98
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 39 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docs/man/header.5
View file

@ -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
docs/man/nvf.1
View file

@ -1,5 +1,5 @@
.Dd January 1, 1980
.Dt nvf 1
.Dt NVF 1
.Os nvf
.\" disable hyphenation
.nh
@ -7,27 +7,46 @@
.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.