spacemacs/layers/+os/nixos/README.org

#+TITLE: NixOS layer

#+TAGS: layer|os

[[file:img/nixos.png]]

* Table of Contents                     :TOC_5_gh:noexport:
- [[#description][Description]]
  - [[#features][Features:]]
- [[#install][Install]]
  - [[#layer][Layer]]
- [[#configuration][Configuration]]
- [[#key-bindings][Key bindings]]
  - [[#nixos-options][NixOS Options]]

* Description
This layer adds tools for better integration of Emacs in NixOS.

** Features:
- Nix-mode using [[https://github.com/NixOS/nix-mode][nix-mode]]
- Auto-completion of NixOS Options using [[https://github.com/travisbhartwell/nix-emacs/blob/master/company-nixos-options.el][company-nixos-options]]
- Helm Lookup for NixOS Options [[https://github.com/travisbhartwell/nix-emacs/blob/master/helm-nixos-options.el][helm-nixos-options]]

* Install
** Layer
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
add =nixos= to the existing =dotspacemacs-configuration-layers= list in this
file.

* Configuration
On some systems, =company-nixos-options= may be very slow. If this is the case,
see the section on disabling the [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/DOCUMENTATION.org#disabling-layer-services-in-other-layers][disabling auto-complete]] for the =nixos= layer.

* Key bindings
** NixOS Options

| Key binding | Description             |
|-------------+-------------------------|
| ~SPC h >~   | Call helm-nixos-options |
Fix some documentation bugs - CSS links - GIFS in published version - Unify layer doc titles - Change emoji layer emojis to an image 2015-12-02 14:23:39 +00:00			`#+TITLE: NixOS layer`
Add NixOS Layer 2015-07-20 20:11:08 +00:00
Add more tags 2019-05-02 21:49:30 +00:00			`#+TAGS: layer\|os`

Update NixOS layer banner The NixOS logo has changed since the NixOS layer was made. This commit replaces the layers banner with the current official NixOS logo. Source of the new logo: https://github.com/NixOS/nixos-artwork/tree/master/logo 2019-10-19 07:04:12 +00:00			`[[file:img/nixos.png]]`
Add NixOS Layer 2015-07-20 20:11:08 +00:00
Switch to the new layers generator 2019-05-07 20:05:06 +00:00			`* Table of Contents :TOC_5_gh:noexport:`
update docs to the new toc-org format 2017-05-22 14:16:12 +00:00			`- [[#description][Description]]`
			`- [[#features][Features:]]`
			`- [[#install][Install]]`
			`- [[#layer][Layer]]`
[nixos] add toggle for company-nixos-options On some Nix setups, company completion via the Nix repl process can be extremely slow and hang emacs. This commit adds an option toggle to disable it in the `nixos` layer. The default behavior is unchanged. Also updates the comment and license headers to be consistent with other layers. 2020-01-07 03:23:06 +00:00			`- [[#configuration][Configuration]]`
documentation formatting: Wed Dec 5 03:03:03 UTC 2018 2018-12-05 03:03:03 +00:00			`- [[#key-bindings][Key bindings]]`
update docs to the new toc-org format 2017-05-22 14:16:12 +00:00			`- [[#nixos-options][NixOS Options]]`
Add NixOS Layer 2015-07-20 20:11:08 +00:00
			`* Description`
[doc] Fix typos and add missing/remove extra ~ Add missing ~ (tilde) around key bindings. Remove an extra ~. 2019-06-01 17:13:30 +00:00			`This layer adds tools for better integration of Emacs in NixOS.`
Add NixOS Layer 2015-07-20 20:11:08 +00:00
			`** Features:`
documentation fixes: Tue Oct 23 14:18:21 UTC 2018 2018-10-23 14:18:21 +00:00			`- Nix-mode using [[https://github.com/NixOS/nix-mode][nix-mode]]`
Add NixOS Layer 2015-07-20 20:11:08 +00:00			`- Auto-completion of NixOS Options using [[https://github.com/travisbhartwell/nix-emacs/blob/master/company-nixos-options.el][company-nixos-options]]`
documentation fixes: Tue Oct 23 14:18:21 UTC 2018 2018-10-23 14:18:21 +00:00			`- Helm Lookup for NixOS Options [[https://github.com/travisbhartwell/nix-emacs/blob/master/helm-nixos-options.el][helm-nixos-options]]`
Add NixOS Layer 2015-07-20 20:11:08 +00:00
			`* Install`
			`** Layer`
Update install layer section in REAMDE.org files 2016-01-06 05:21:55 +00:00			`To use this configuration layer, add it to your =~/.spacemacs=. You will need to`
			`add =nixos= to the existing =dotspacemacs-configuration-layers= list in this`
			`file.`
Add NixOS Layer 2015-07-20 20:11:08 +00:00
[nixos] add toggle for company-nixos-options On some Nix setups, company completion via the Nix repl process can be extremely slow and hang emacs. This commit adds an option toggle to disable it in the `nixos` layer. The default behavior is unchanged. Also updates the comment and license headers to be consistent with other layers. 2020-01-07 03:23:06 +00:00			`* Configuration`
[nixos] Update recommended method for disabling nixos-company-options Per discussion in #13164, we have a standard, consistent technique for doing this across any layer. Provided that `global-company-mode` is not set, this works as expected to disable company without requiring custom variables. 2020-01-25 23:47:22 +00:00			`On some systems, =company-nixos-options= may be very slow. If this is the case,`
			`see the section on disabling the [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/DOCUMENTATION.org#disabling-layer-services-in-other-layers][disabling auto-complete]] for the =nixos= layer.`
[nixos] add toggle for company-nixos-options On some Nix setups, company completion via the Nix repl process can be extremely slow and hang emacs. This commit adds an option toggle to disable it in the `nixos` layer. The default behavior is unchanged. Also updates the comment and license headers to be consistent with other layers. 2020-01-07 03:23:06 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018 2018-12-05 03:03:03 +00:00			`* Key bindings`
Add NixOS Layer 2015-07-20 20:11:08 +00:00			`** NixOS Options`

documentation formatting: Wed Dec 5 03:03:03 UTC 2018 2018-12-05 03:03:03 +00:00			`\| Key binding \| Description \|`
Add NixOS Layer 2015-07-20 20:11:08 +00:00			`\|-------------+-------------------------\|`
			`\| ~SPC h >~ \| Call helm-nixos-options \|`