mirror of
https://github.com/NotAShelf/nvf.git
synced 2025-09-07 10:51:36 +00:00
docs: add helpful tips section (#520)
This commit is contained in:
parent
eb6e8b17b7
commit
9584fe25e2
4 changed files with 37 additions and 0 deletions
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.
|
Loading…
Add table
Add a link
Reference in a new issue