mirror of
				https://github.com/NotAShelf/nvf.git
				synced 2025-10-31 02:52:37 +00:00 
			
		
		
		
	docs: add helpful tips section
This commit is contained in:
		
					parent
					
						
							
								eb6e8b17b7
							
						
					
				
			
			
				commit
				
					
						dabcfa12cf
					
				
			
		
					 4 changed files with 37 additions and 0 deletions
				
			
		|  | @ -11,6 +11,7 @@ try-it-out.md | ||||||
| default-configs.md | default-configs.md | ||||||
| installation.md | installation.md | ||||||
| configuring.md | configuring.md | ||||||
|  | tips.md | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| ```{=include=} chapters | ```{=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