{"id":13816631,"url":"https://github.com/nvim-neorg/nixpkgs-neorg-overlay","last_synced_at":"2025-04-27T16:32:13.606Z","repository":{"id":43422329,"uuid":"457954558","full_name":"nvim-neorg/nixpkgs-neorg-overlay","owner":"nvim-neorg","description":"Nixpkgs overlay for Neorg and related packages","archived":false,"fork":false,"pushed_at":"2025-04-19T22:15:39.000Z","size":786,"stargazers_count":27,"open_issues_count":0,"forks_count":6,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-19T23:23:03.809Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Nix","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nvim-neorg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-02-10T21:33:23.000Z","updated_at":"2025-04-19T22:15:42.000Z","dependencies_parsed_at":"2023-09-23T16:34:14.554Z","dependency_job_id":"543496dd-b02b-4de0-b87b-15fb45b4f2e7","html_url":"https://github.com/nvim-neorg/nixpkgs-neorg-overlay","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nvim-neorg%2Fnixpkgs-neorg-overlay","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nvim-neorg%2Fnixpkgs-neorg-overlay/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nvim-neorg%2Fnixpkgs-neorg-overlay/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nvim-neorg%2Fnixpkgs-neorg-overlay/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nvim-neorg","download_url":"https://codeload.github.com/nvim-neorg/nixpkgs-neorg-overlay/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251171565,"owners_count":21547112,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-04T05:00:48.187Z","updated_at":"2025-04-27T16:32:13.262Z","avatar_url":"https://github.com/nvim-neorg.png","language":"Nix","funding_links":[],"categories":["Integrations"],"sub_categories":[],"readme":"# Neorg overlay for [Nixpkgs](https://github.com/NixOS/nixpkgs)\n\nThis is a Nixpkgs overlay that gives Nix users access to unstable versions of Neorg and its associated projects.\n\nNixpkgs 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.\n\n## Installation\n\nFor documentation on how overlays work and how to use them, refer to the [Nixpkgs Manual](https://nixos.org/manual/nixpkgs/stable/#chap-overlays).\n\n**Please note that as of right now only flake-based systems are supported**, an example of which you can see below.\n\n## Example\n\nThe 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):\n\n```nix\n{\n  inputs = {\n    nixpkgs.url = \"github:NixOS/nixpkgs/nixpkgs-unstable\";\n    home-manager.url = \"github:nix-community/home-manager\";\n    neorg-overlay.url = \"github:nvim-neorg/nixpkgs-neorg-overlay\";\n  };\n  outputs = { self, nixpkgs, home-manager, neorg, ... }: {\n    nixosConfigurations.machine = nixpkgs.lib.nixosSystem {\n      system = \"x86_64-linux\";\n      modules = [\n        home-manager.nixosModules.home-manager\n        {\n          nixpkgs.overlays = [ neorg-overlay.overlays.default ];\n          home-manager.users.bandithedoge = {\n            programs.neovim = {\n              enable = true;\n              plugins = with pkgs.vimPlugins; [\n                neorg\n\n                # optional\n                neorg-telescope\n\n                # optional — only if you want additional grammars besides norg and\n                # norg_meta, otherwise auto-required.\n                #\n                # N.b.: Don't use plain nvim-treesitter as it would result in no\n                # grammars getting installed, always the withPlugins function.\n                # The minimal form is nvim-treesitter.withPlugins (_: [ ]) — the norg\n                # grammars are added automatically.\n                #\n                # For all available grammars, nvim-treesitter.withAllGrammars or the\n                # equivalent nvim-treesitter.withPlugins (_: nvim-treesitter.allGrammars)\n                # can be used.\n                (nvim-treesitter.withPlugins (p: with p; [\n                  # Keep calm and don't :TSInstall\n                  tree-sitter-lua\n                ]))\n              ];\n              extraConfig = ''\n                lua \u003c\u003c EOF\n                  require(\"nvim-treesitter.configs\").setup {\n                    highlight = {\n                      enable = true,\n                    }\n                  }\n\n                  require(\"neorg\").setup {\n                    load = {\n                      [\"core.defaults\"] = {}\n                    }\n                  }\n                EOF\n              '';\n            };\n          };\n        }\n      ];\n    };\n  };\n}\n```\n\n## Package list\n\n-   [`vimPlugins.neorg`](https://github.com/nvim-neorg/neorg)\n-   [`vimPlugins.neorg-telescope`](https://github.com/nvim-neorg/neorg-telescope)\n-   [`vimPlugins.nvim-treesitter.builtGrammars.tree-sitter-norg`](https://github.com/nvim-neorg/tree-sitter-norg)\n-   [`vimPlugins.nvim-treesitter.builtGrammars.tree-sitter-norg-meta`](https://github.com/nvim-neorg/tree-sitter-norg-meta)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnvim-neorg%2Fnixpkgs-neorg-overlay","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnvim-neorg%2Fnixpkgs-neorg-overlay","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnvim-neorg%2Fnixpkgs-neorg-overlay/lists"}