Neorg overlay for Nixpkgs
This is a Nixpkgs overlay that gives Nix users access to unstable versions of Neorg and its associated projects.
Nixpkgs already packages Neorg and the NFF Tree-sitter parser, however those are updated very rarely. This is a problem for rapidly growing projects such as Neorg and can cause the plugin and parser to go out-of-sync. This overlay is updated automatically every 2 hours and, apart from the base plugin and TS parser, provides additional Neorg-related packages.
Installation
For documentation on how overlays work and how to use them, refer to the Nixpkgs Manual.
Please note that as of right now only flake-based systems are supported, an example of which you can see below.
Example
The following minimal NixOS flake configures Neovim with Neorg and Tree-sitter support using Home Manager:
{
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
home-manager.url = "github:nix-community/home-manager";
neorg-overlay.url = "github:nvim-neorg/nixpkgs-neorg-overlay";
};
outputs = { self, nixpkgs, home-manager, neorg, ... }: {
nixosConfigurations.machine = nixpkgs.lib.nixosSystem {
system = "x86_64-linux";
modules = [
home-manager.nixosModules.home-manager
{
nixpkgs.overlays = [ neorg-overlay.overlays.default ];
home-manager.users.bandithedoge = {
programs.neovim = {
enable = true;
plugins = with pkgs.vimPlugins; [
neorg
# optional
neorg-telescope
# optional — only if you want additional grammars besides norg and
# norg_meta, otherwise auto-required.
#
# N.b.: Don't use plain nvim-treesitter as it would result in no
# grammars getting installed, always the withPlugins function.
# The minimal form is nvim-treesitter.withPlugins (_: [ ]) — the norg
# grammars are added automatically.
#
# For all available grammars, nvim-treesitter.withAllGrammars or the
# equivalent nvim-treesitter.withPlugins (_: nvim-treesitter.allGrammars)
# can be used.
(nvim-treesitter.withPlugins (p: with p; [
# Keep calm and don't :TSInstall
tree-sitter-lua
]))
];
extraConfig = ''
lua << EOF
require("nvim-treesitter.configs").setup {
highlight = {
enable = true,
}
}
require("neorg").setup {
load = {
["core.defaults"] = {}
}
}
EOF
'';
};
};
}
];
};
};
}