diff --git a/modules/lang/nix/README.org b/modules/lang/nix/README.org new file mode 100644 index 000000000..64f3d1ef3 --- /dev/null +++ b/modules/lang/nix/README.org @@ -0,0 +1,57 @@ +#+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]] + - [[#keybindings][Keybindings]] +- [[#configuration][Configuration]] +- [[#troubleshooting][Troubleshooting]] + +* Description +Adds many tools for [[https://nixos.org/][Nix(OS)]] users in nice package for Doom users. + ++ Syntax highlighting ++ 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 ++ ~nixfmt~ is required to use formatting + + If you have Nix(OS) installed it can be installed through Nix configuration ~environment.systemPackages = with pkgs; [ nixfmt ];~ (recommended) + + Or through nix-env ~nix-env -iA nixpkgs.nixfmt~ + + Or through 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 binding is ~SPC c f~ in evil. + +* Features +** Keybindings +| Binding | Description | +|-------------------+----------------------| +| ~ b~ | ~nix-build~ | +| ~ f~ | ~nix-update-fetch~ | +| ~ o~ | ~+nix/lookup-option~ | +| ~ p~ | ~nix-format-buffer~ | +| ~ r~ | ~nix-repl-show~ | +| ~ s~ | ~nix-repl-shell~ | +| ~ u~ | ~nix-unpack~ | + +* Configuration + +* Troubleshooting ++ There aren't any known problems.