88844e9cec
Fewer links means less confusion. - Merge doom-issue and doom-commit links into doom-ref (for auto-linking Issue/PR/commit references). - Merge doom-module-source and doom-docs-source links into doom-source. - Rename doom-report-issue to doom-report. - Use '!' as the icon for module issues link. - Remove doom-repo (replaced with "doom:*" in :lang org module). - Add doomdir and emacsdir links to :lang org module.
81 lines
2.7 KiB
Org Mode
81 lines
2.7 KiB
Org Mode
← [[doom-module-index:][Back to module index]] ! [[doom-module-issues:::lang nix][Issues]] ↖ [[doom-source:modules/lang/nix/][Github]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
|
--------------------------------------------------------------------------------
|
|
#+TITLE: :lang nix
|
|
#+SUBTITLE: I hereby declare "nix geht mehr!"
|
|
#+CREATED: December 02, 2017
|
|
#+SINCE: 2.0.8 (#280)
|
|
|
|
* Description :unfold:
|
|
This module adds support for the Nix language to Doom Emacs, along with tools
|
|
for managing [[https://nixos.org/][Nix(OS)]].
|
|
|
|
Includes:
|
|
- Syntax highlighting
|
|
- Completion through [[doom-package:][company]] and/or [[doom-package:][helm]]
|
|
- Nix option lookup
|
|
- Formatting (~nixfmt~)
|
|
|
|
** Maintainers
|
|
- [[doom-user:][@hlissner]]
|
|
|
|
[[doom-contrib-maintainer:][Become a maintainer?]]
|
|
|
|
** Module flags
|
|
/This module has no flags./
|
|
|
|
** Packages
|
|
- [[doom-package:][company-nixos-options]] if [[doom-module:][:completion company]]
|
|
- [[doom-package:][helm-nixos-options]] if [[doom-module:][:completion helm]]
|
|
- [[doom-package:][nix-mode]]
|
|
- [[doom-package:][nix-update]]
|
|
|
|
** Hacks
|
|
/No hacks documented for this module./
|
|
|
|
** TODO Changelog
|
|
# This section will be machine generated. Don't edit it by hand.
|
|
/This module does not have a changelog yet./
|
|
|
|
* TODO Installation
|
|
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
|
|
|
This module requires:
|
|
- [[https://nixos.org/guides/install-nix.html][The Nix package manager]], for a variety of its features (besides syntax
|
|
highlighting).
|
|
- =nixfmt=, for automatic formatting (requires [[doom-module:][:editor format]]).
|
|
|
|
- *MacOS:* TODO
|
|
- *Arch Linux:* TODO
|
|
- *NixOS:* in ~pkgs.nixfmt~
|
|
|
|
* TODO Usage
|
|
#+begin_quote
|
|
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
|
#+end_quote
|
|
|
|
** Keybindings
|
|
| Binding | Description |
|
|
|-----------------+----------------------|
|
|
| [[kbd:][<localleader> b]] | ~nix-build~ |
|
|
| [[kbd:][<localleader> f]] | ~nix-update-fetch~ |
|
|
| [[kbd:][<localleader> o]] | ~+nix/lookup-option~ |
|
|
| [[kbd:][<localleader> p]] | ~nix-format-buffer~ |
|
|
| [[kbd:][<localleader> r]] | ~nix-repl-show~ |
|
|
| [[kbd:][<localleader> s]] | ~nix-repl-shell~ |
|
|
| [[kbd:][<localleader> u]] | ~nix-unpack~ |
|
|
|
|
* TODO Configuration
|
|
#+begin_quote
|
|
🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
|
|
#+end_quote
|
|
|
|
* Troubleshooting
|
|
/There are no known problems with this module./ [[doom-report:][Report one?]]
|
|
|
|
* Frequently asked questions
|
|
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
|
|
|
|
* TODO Appendix
|
|
#+begin_quote
|
|
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
|
|
#+end_quote
|