Compare commits

..

No commits in common. "b7bea89d9ab669c8ead928c5e087dedcfbb32202" and "eb6e8b17b7beffd3792d898e30b0e9cd80de06ae" have entirely different histories.

5 changed files with 14 additions and 59 deletions

36
.github/README.md vendored
View file

@ -206,16 +206,6 @@ features.
## Credits ## 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 ### Contributors
[mnw]: https://github.com/gerg-l/mnw [mnw]: https://github.com/gerg-l/mnw
@ -223,19 +213,21 @@ Alongside myself, nvf is developed by those talented folk:
nvf would not be what it is today without the awesome people below. Special, nvf would not be what it is today without the awesome people below. Special,
heart-felt thanks to heart-felt thanks to
- [**@fufexan**](https://github.com/fufexan) - For the transition to flake-parts - [@fufexan](https://github.com/fufexan) - For the transition to flake-parts and
and invaluable Nix assistance. invaluable Nix assistance.
- [**@FlafyDev**](https://github.com/FlafyDev) - For getting Home-Manager module - [@FlafyDev](https://github.com/FlafyDev) - For getting home-manager module to
to work and Nix assistance. work and Nix assistance.
- [**@n3oney**](https://github.com/n3oney) - For making custom keybinds finally - [@n3oney](https://github.com/n3oney) - For making custom keybinds finally
possible, and other module additions. possible, and other module additions.
- [**@Yavko**](https://github.com/Yavko) - For the amazing **nvf** logo - [@horriblename](https://github.com/horriblename) - For actively implementing
- [**@FrothyMarrow**](https://github.com/FrothyMarrow) - For seeing mistakes planned features and quality of life updates.
that I could not. - [@Yavko](https://github.com/Yavko) - For the amazing **nvf** logo
- [**@Gerg-l**](https://github.com/gerg-l) 🐸 - For the modern Neovim wrapper, - [@FrothyMarrow](https://github.com/FrothyMarrow) - For seeing mistakes that I
[mnw], and occasional code improvements. could not.
- [**@Soliprem**](https://github.com/soliprem) - Rigorously implementing missing - [@Diniamo](https://github.com/Diniamo) - For actively submitting pull
features and excellent work on new language modules. 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.
and everyone who has submitted issues or pull requests! and everyone who has submitted issues or pull requests!

View file

@ -11,7 +11,6 @@ try-it-out.md
default-configs.md default-configs.md
installation.md installation.md
configuring.md configuring.md
tips.md
``` ```
```{=include=} chapters ```{=include=} chapters

View file

@ -1,6 +0,0 @@
# Helpful Tips {#ch-helpful-tips}
```{=include=} chapters
tips/debugging-nvf.md
tips/offline-docs.md
```

View file

@ -1,19 +0,0 @@
# 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.

View file

@ -1,11 +0,0 @@
# 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.