You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
László Vaskó fee14d217b home-manager: set `services.emacs.package` only if it is defined 3 months ago
.github/workflows github actions: action to update init.el 9 months ago
modules home-manager: set `services.emacs.package` only if it is defined 3 months ago
test/doom.d test/doom.d/init.el: Updating from hlissner/doom-emacs - 80c32eaa 3 months ago
LICENSE Initial commit 2 years ago
README.md README.md: Reformat and fix spelling 9 months ago
advice.el advice.el: make it compatible with newer doom revisions 5 months ago
default.nix Add a patch for restart-emacs 4 months ago
evil-escape.patch Nix expression to install and configure doom-emacs 2 years ago
fix-paths.patch elfeed: use `doom-cache-dir` which is outside of the nix store 1 year ago
flake-compat-helper.nix github actions: niv -> flakes 9 months ago
flake.lock org: package renamed, org-contrib added 3 months ago
flake.nix org: package renamed, org-contrib added 3 months ago
nix-integration.patch Fix nix-integration.patch. 5 months ago
overrides.nix org: package renamed, org-contrib added 3 months ago
restart-emacs.patch Add a patch for restart-emacs 4 months ago

README.md

nix-doom-emacs

Status
Build on master Build Status on master
Build on develop Build Status on develop
Dependency updater Dependency Updater Status

Nix expression to install and configure doom-emacs.

The expression builds a doom-emacs distribution with dependencies pre-installed based on an existing ~/.doom.d directory.

It is not a fully fledged experience as some dependencies are not installed and some may not be fully compatible as the version available in NixOS or emacs-overlay may not be compatible with the doom-emacs requirements.

Getting started

Using home-manager:

{ pkgs, ... }:

let
  doom-emacs = pkgs.callPackage (builtins.fetchTarball {
    url = https://github.com/vlaci/nix-doom-emacs/archive/master.tar.gz;
  }) {
    doomPrivateDir = ./doom.d;  # Directory containing your config.el init.el
                                # and packages.el files
  };
in {
  home.packages = [ doom-emacs ];
  home.file.".emacs.d/init.el".text = ''
      (load "default.el")
  '';
}

./doom.d should contain the following three files: config.el, init.el and packages.el. If you don't already have an existing doom-emacs configuration, you can use the contents of test/doom.d as a template.

Using flake.nix:

{
  inputs = {
    home-manager.url = "github:rycee/home-manager";
    nix-doom-emacs.url = "github:vlaci/nix-doom-emacs";
  };

  outputs = {
    self,
    nixpkgs,
    home-manager,
    nix-doom-emacs,
    ...
  }: {
    nixosConfigurations.exampleHost = nixpkgs.lib.nixosSystem {
      system = "x86_64-linux";
      modules = [
        home-manager.nixosModules.home-manager
        {
          home-manager.users.exampleUser = { pkgs, ... }: {
            imports = [ nix-doom-emacs.hmModule ];
            programs.doom-emacs = {
              enable = true;
              doomPrivateDir = ./doom.d;
            };
          };
        }
      ];
    };
  };
}

Under the hood

This expression leverages nix-straight.el under the hood for installing dependencies. The restrictions of that package apply here too.

Usage

instead of running emacs.d/bin/doom, once you have update your config files (packages.el, init.el, config.el), rebuild doom-emacs with nix. If you are using home-manager, simply run home-manager switch

Troubleshooting

On macOS on a fresh install, you might run into the error Too many files open. running ulimit -S -n 2048 will only work for the duration of your shell and will fix the error

Installing emacs packages

In the initial packages.el instructions for how to install packages can be found. However some packages might require a particular software dependency to be installed. Trying to install those would give you an error of the type: Searching for program: No such file or directory, git (Missing git dependency) Here is how you would go installing magit-delta for example (which requires git).

Under the line: doomPrivateDir = ./doom.d; in your configuration, you would add the following:

  emacsPackagesOverlay = self: super: {
     magit-delta = super.magit-delta.overrideAttrs (esuper: {
       buildInputs = esuper.buildInputs ++ [ pkgs.git ];
     });
  };

To make the git dependency available. trying to rebuild doom-emacs with home-manager switch should work correctly now.

Using the daemon

To use the daemon, simply enable the emacs service (with NixOS, home-manager or nix-darwin) and use the doom emacs package. doom-emacs will need to be referenced at the top of your config file.

services.emacs = {
  enable = true;
  package = doom-emacs;  # use programs.emacs.package instead if using home-manager
}

to connect to the daemon you can now run emacsclient -c