doomemacs/modules/lang/nix/README.org
Henrik Lissner e77a45bc22
docs: use lowercase keywords
As per Org's new defaults, which we're adopting elsewhere, so may as
well adopt it here.
2022-08-02 16:23:43 +02:00

2.8 KiB

:lang nix

Back to module index ! Issues ↖ Github ± Suggest edits ? Help


Description   unfold

This module adds support for the Nix language to Doom Emacs, along with tools for managing Nix(OS).

Includes:

  • Syntax highlighting
  • Completion through company and/or helm
  • Nix option lookup
  • Formatting (nixfmt)

Module flags

+tree-sitter
Leverages tree-sitter for better syntax highlighting and structural text editing. Requires :tools tree-sitter.

Hacks

No hacks documented for this module.

TODO Changelog

This module does not have a changelog yet.

TODO Installation

Enable this module in your doom! block.

This module requires:

  • The Nix package manager, for a variety of its features (besides syntax highlighting).
  • nixfmt, for automatic formatting (requires :editor format).
  • MacOS: TODO
  • Arch Linux: TODO
  • NixOS: in pkgs.nixfmt

TODO Usage

🔨 This module's usage documentation is incomplete. Complete it?

Keybindings

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

TODO Configuration

🔨 This module has no configuration documentation yet. Write some?

Troubleshooting

There are no known problems with this module. Report one?

Frequently asked questions

This module has no FAQs yet. Ask one?

TODO Appendix

🔨 This module has no appendix yet. Write one?