os/doc/outputs/overlays.md

29 lines
766 B
Markdown
Raw Normal View History

2021-02-14 02:38:20 +00:00
# Overlays
2022-11-20 22:28:23 +00:00
2021-02-14 02:38:20 +00:00
Writing overlays is a common occurence when using a NixOS system. Therefore,
we want to keep the process as simple and straightforward as possible.
Any _.nix_ files declared in this directory will be assumed to be a valid
2021-04-19 02:26:27 +00:00
overlay, and will be automatically imported into all [hosts](../concepts/hosts.md), and
exported via `overlays.<channel>/<pkgName>` _as well as_
2021-02-14 02:38:20 +00:00
`packages.<system>.<pkgName>` (for valid systems), so all you have to do is
write it.
## Example
2022-11-20 22:28:23 +00:00
2021-02-14 02:38:20 +00:00
overlays/kakoune.nix:
2022-11-20 22:28:23 +00:00
2021-02-14 02:38:20 +00:00
```nix
final: prev: {
kakoune = prev.kakoune.override {
configure.plugins = with final.kakounePlugins; [
(kak-fzf.override { fzf = final.skim; })
kak-auto-pairs
kak-buffers
kak-powerline
kak-vertical-selection
];
};
}
```