Added lang/nix barebone readme.
I added all the things I know about this module but there might be something I don't know about so check and validate. This is related to #1166 effort.
This commit is contained in:
parent
be396655c4
commit
75a9bcf56b
1 changed files with 55 additions and 0 deletions
55
modules/lang/nix/README.org
Normal file
55
modules/lang/nix/README.org
Normal file
|
@ -0,0 +1,55 @@
|
||||||
|
#+TITLE: lang/nix
|
||||||
|
#+DATE: May 4, 2020
|
||||||
|
#+SINCE: v2.0.7
|
||||||
|
#+STARTUP: inlineimages nofold
|
||||||
|
|
||||||
|
* Table of Contents :TOC_3:noexport:
|
||||||
|
- [[#description][Description]]
|
||||||
|
- [[#maintainers][Maintainers]]
|
||||||
|
- [[#module-flags][Module Flags]]
|
||||||
|
- [[#plugins][Plugins]]
|
||||||
|
- [[#prerequisites][Prerequisites]]
|
||||||
|
- [[#features][Features]]
|
||||||
|
- [[#configuration][Configuration]]
|
||||||
|
- [[#troubleshooting][Troubleshooting]]
|
||||||
|
|
||||||
|
* Description
|
||||||
|
Adds many tools for [[https://nixos.org/][nix(os)]] users in nice package for Doom users.
|
||||||
|
|
||||||
|
+ Syntax highlight
|
||||||
|
+ Completion through ~company~ / ~helm~
|
||||||
|
+ Nix option lookup
|
||||||
|
+ Formatting (~nixfmt~)
|
||||||
|
|
||||||
|
** Maintainers
|
||||||
|
This module has no dedicated maintainers.
|
||||||
|
|
||||||
|
** Module Flags
|
||||||
|
This module provides no flags.
|
||||||
|
|
||||||
|
** Plugins
|
||||||
|
+ [[https://github.com/NixOS/nix-mode][nix-mode]]
|
||||||
|
+ [[https://github.com/jwiegley/nix-update-el][nix-update]]
|
||||||
|
|
||||||
|
* Prerequisites
|
||||||
|
|
||||||
|
* Features
|
||||||
|
+ ~nixfmt~ is required to use formatting
|
||||||
|
+ If you have nix(os) installed it can be installed trough nix configuration ~enviroment.systemPackages = with pkgs; [ nixfmt ];~ (recommended)
|
||||||
|
+ Or trough nix-env ~nix-env -iA nixpkgs.nixfmt~
|
||||||
|
+ Or trough nix-shell ~nix-shell -f https://github.com/serokell/nixfmt/archive/master.tar.gz -i~
|
||||||
|
+ ~:editor format~ ~format-all~ also supports ~nixfmt~ so you can use that also to format nix code, default bindings ~SPC c f~ in evil.
|
||||||
|
|
||||||
|
* Configuration
|
||||||
|
| Binding | Description |
|
||||||
|
|-------------------+----------------------|
|
||||||
|
| ~<localleader> b~ | ~nix-build~ |
|
||||||
|
| ~<localleader> f~ | ~nix-update-fetch~ |
|
||||||
|
| ~<localleader> o~ | ~+nix/lookup-option~ |
|
||||||
|
| ~<localleader> p~ | ~nix-format-buffer~ |
|
||||||
|
| ~<localleader> r~ | ~nix-repl-show~ |
|
||||||
|
| ~<localleader> s~ | ~nix-repl-shell~ |
|
||||||
|
| ~<localleader> u~ | ~nix-unpack~ |
|
||||||
|
|
||||||
|
* Troubleshooting
|
||||||
|
+ There isn't any known problems.
|
Loading…
Add table
Add a link
Reference in a new issue