https://github.com/nvim-neorg/nixpkgs-neorg-overlay

Nixpkgs overlay for Neorg and related packages
https://github.com/nvim-neorg/nixpkgs-neorg-overlay

Last synced: 3 days ago
JSON representation

Nixpkgs overlay for Neorg and related packages

• Host: GitHub
• URL: https://github.com/nvim-neorg/nixpkgs-neorg-overlay
• Owner: nvim-neorg
• License: mit
• Created: 2022-02-10T21:33:23.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T14:15:32.000Z (16 days ago)
• Last Synced: 2024-10-29T17:24:05.490Z (16 days ago)
• Language: Nix
• Homepage:
• Size: 674 KB
• Stars: 23
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-neorg - nixpkgs-neorg-overlay - Nixpkgs overlay that gives Nix users access to unstable versions of Neorg and its associated projects. (Integrations)

README

        
# Neorg overlay for [Nixpkgs](https://github.com/NixOS/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](https://nixos.org/manual/nixpkgs/stable/#chap-overlays).

**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](https://nixos.wiki/wiki/Flakes) configures Neovim with Neorg and Tree-sitter support using [Home Manager](https://github.com/nix-community/home-manager):

```nix

{

  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

              '';

            };

          };

        }

      ];

    };

  };

}

```

## Package list

-   [`vimPlugins.neorg`](https://github.com/nvim-neorg/neorg)

-   [`vimPlugins.neorg-telescope`](https://github.com/nvim-neorg/neorg-telescope)

-   [`vimPlugins.nvim-treesitter.builtGrammars.tree-sitter-norg`](https://github.com/nvim-neorg/tree-sitter-norg)

-   [`vimPlugins.nvim-treesitter.builtGrammars.tree-sitter-norg-meta`](https://github.com/nvim-neorg/tree-sitter-norg-meta)