mirror of
https://github.com/NotAShelf/nvf.git
synced 2026-01-13 14:07:50 +00:00
Compare commits
2 commits
eb6e8b17b7
...
b7bea89d9a
| Author | SHA1 | Date | |
|---|---|---|---|
|
b7bea89d9a |
|||
|
9584fe25e2 |
5 changed files with 59 additions and 14 deletions
36
.github/README.md
vendored
36
.github/README.md
vendored
|
|
@ -206,6 +206,16 @@ features.
|
|||
|
||||
## Credits
|
||||
|
||||
### Co-Maintainers
|
||||
|
||||
Alongside myself, nvf is developed by those talented folk:
|
||||
|
||||
- [**@horriblename**](https://github.com/horriblename) - For actively
|
||||
implementing planned features and quality of life updates.
|
||||
- [**@Diniamo**](https://github.com/Diniamo)
|
||||
([Liberapay](https://en.liberapay.com/diniamo/)) - For actively submitting
|
||||
pull requests, issues and assistance with maintenance of nvf.
|
||||
|
||||
### Contributors
|
||||
|
||||
[mnw]: https://github.com/gerg-l/mnw
|
||||
|
|
@ -213,21 +223,19 @@ features.
|
|||
nvf would not be what it is today without the awesome people below. Special,
|
||||
heart-felt thanks to
|
||||
|
||||
- [@fufexan](https://github.com/fufexan) - For the transition to flake-parts and
|
||||
invaluable Nix assistance.
|
||||
- [@FlafyDev](https://github.com/FlafyDev) - For getting home-manager module to
|
||||
work and Nix assistance.
|
||||
- [@n3oney](https://github.com/n3oney) - For making custom keybinds finally
|
||||
- [**@fufexan**](https://github.com/fufexan) - For the transition to flake-parts
|
||||
and invaluable Nix assistance.
|
||||
- [**@FlafyDev**](https://github.com/FlafyDev) - For getting Home-Manager module
|
||||
to work and Nix assistance.
|
||||
- [**@n3oney**](https://github.com/n3oney) - For making custom keybinds finally
|
||||
possible, and other module additions.
|
||||
- [@horriblename](https://github.com/horriblename) - For actively implementing
|
||||
planned features and quality of life updates.
|
||||
- [@Yavko](https://github.com/Yavko) - For the amazing **nvf** logo
|
||||
- [@FrothyMarrow](https://github.com/FrothyMarrow) - For seeing mistakes that I
|
||||
could not.
|
||||
- [@Diniamo](https://github.com/Diniamo) - For actively submitting pull
|
||||
requests, issues and assistance with maintenance of nvf.
|
||||
- [@Gerg-l](https://github.com/gerg-l) - For the modern Neovim wrapper, [mnw],
|
||||
and occasional code improvements.
|
||||
- [**@Yavko**](https://github.com/Yavko) - For the amazing **nvf** logo
|
||||
- [**@FrothyMarrow**](https://github.com/FrothyMarrow) - For seeing mistakes
|
||||
that I could not.
|
||||
- [**@Gerg-l**](https://github.com/gerg-l) 🐸 - For the modern Neovim wrapper,
|
||||
[mnw], and occasional code improvements.
|
||||
- [**@Soliprem**](https://github.com/soliprem) - Rigorously implementing missing
|
||||
features and excellent work on new language modules.
|
||||
|
||||
and everyone who has submitted issues or pull requests!
|
||||
|
||||
|
|
|
|||
|
|
@ -11,6 +11,7 @@ try-it-out.md
|
|||
default-configs.md
|
||||
installation.md
|
||||
configuring.md
|
||||
tips.md
|
||||
```
|
||||
|
||||
```{=include=} chapters
|
||||
|
|
|
|||
6
docs/manual/tips.md
Normal file
6
docs/manual/tips.md
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
# Helpful Tips {#ch-helpful-tips}
|
||||
|
||||
```{=include=} chapters
|
||||
tips/debugging-nvf.md
|
||||
tips/offline-docs.md
|
||||
```
|
||||
19
docs/manual/tips/debugging-nvf.md
Normal file
19
docs/manual/tips/debugging-nvf.md
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
# Debugging nvf {#sec-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](https://github.com/sharkdp/bat).
|
||||
|
||||
```bash
|
||||
nvf-print-config | bat --language=lua
|
||||
```
|
||||
|
||||
Alternatively, `cat` or `less` may also be used.
|
||||
11
docs/manual/tips/offline-docs.md
Normal file
11
docs/manual/tips/offline-docs.md
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
# Offline Documentation {#sec-offline-documentation}
|
||||
|
||||
[https://notashelf.github.io/nvf/options.html]: https://notashelf.github.io/nvf/options.html
|
||||
|
||||
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.
|
||||
Loading…
Add table
Add a link
Reference in a new issue