Dotfiles

• Introduction
  • Getting Started
  • Making Changes
  • Docker Container
• Operating System
  • Nixpkgs
  • Home Manager
  • Emacs Overlay
  • NixOS Hardware
  • Nix On Droid
• Host Configurations
  • Default
    • Configuration
    • Hardware
  • Acernitro
    • Configuration
    • Hardware
  • Android
  • Homecloud
  • Raspberry
  • Zero-One
  • Zero-Two
• Development Shells
  • Go
  • gRPC
  • C/C++
  • Python
• Module Definitions
  • X11
  • Flakes
  • Cachix
  • Firefox
  • Moonlight
  • Teamviewer
  • Home Manager
    • Git
    • Gpg
    • Vim
    • GTK
• Emacs Configuration
  • Disable UI
  • Native Comp
  • Backup Files
  • Shell Commands
  • Nix Mode
  • Evil Mode
  • EXWM
  • General
  • Which Key
  • EWW
  • Dired
  • Icons
  • Emojis
  • EShell
  • VTerm
  • Magit
  • Fonts
  • Elfeed
  • Org Mode
  • Org Roam
  • Org Drill
  • Org Agenda
  • Org Pomodoro
  • Writegood Mode
  • Aspell
  • Hugo
  • Reveal
  • Passwords
  • MU4E
  • Projectile
  • LSP Mode
  • Company Mode
  • Go Mode
  • Python Mode
  • PlantUML
  • Swiper
  • Transparency
  • Doom Themes
  • Doom Modeline
• Footnotes

Immutable NixOS dotfiles.

Built for Life, Liberty, and the Open Road.

• 100% Immutable

• 100% Declarative

• 100% Reproducible

Introduction

This is my personal configuration(s) for GNU/Linux¹ systems. It enables a consistent experience and computing environment across all of my machines. This project is written with GNU/Emacs², leveraging its capabilities for Literate Programming³, a technique where programs are written in a natural language, such as English, interspersed with snippets of code to describe a software project.

This file is controlled by /etc/dotfiles/README.org

Getting Started

1. Download the latest version of NixOS https://nixos.org/download.html

2. Partition drives and mount the file system https://nixos.org/manual/nixos/stable/#sec-installation-partitioning

3. Clone the project to /mnt/etc/dotfiles git clone git@git.chrishayward.xyz:chris/dotfiles /mnt/etc/dotfiles

4. Load the default shell environment nix-shell /mnt/etc/dotfiles

5. Install the default system sudo nixos-install --flake /mnt/etc/dotfiles#nixos

6. Reboot and login, start a graphical system with startx

Making Changes

The nixos-rebuild command updates the system so that it corresponds to the configuration specified in the module. It builds the new system in /nix/store/, runs the activation scripts, and restarts and system services (if needed). The command has one required argument, which specifies the desired operation:

switch

Build and activate the new configuration, making it the new boot default

boot

Build the new configuration and make it the boot default, without activation

test

Build and activate the new configuration, without adding it to the boot menu

build

Build the new configuration, without activation, nor adding it to the boot menu

build-vm

Build a script that starts a virtual machine with the desired configuration

# Build and activate a new configuration.
sudo nixos-rebuild switch --flake $FLAKE#$HOSTNAME

Instead of building a new configuration, it's possible to rollback to a previous generation using the nixos-rebuild command, by supplying the --rollback argument.

# Rollback to the previous generation.
sudo nixos-rebuild switch --rollback

Docker Container

It's possible to use parts of this configuration using the container. By default, sandboxing is turned off inside of the container, even though it's enabled in new installations. This can lead to differences between derivations built inside containers, versus those built without any containerization. This is especially true if a derivation relies on sandboxing to block sideloading of dependencies.

# Derive from the official image.
FROM nixos/nix

# Add the unstable channel.
RUN nix-channel --add https://nixos.org/channels/nixpkgs-unstable nixpkgs
RUN nix-channel --update

# Setup the default environment.
WORKDIR /etc/dotfiles
COPY . .

# Load the default system shell.
RUN nix-shell /etc/dotfiles

Operating System

NixOS⁴ is a purely functional Linux distribution built on top of the Nix⁵ package manager. It uses a declarative configuration language to define entire computer systems, and allows reliable system upgrades and rollbacks. NixOS⁴ also has tool dedicated to DevOps and deployment tasks, and makes it trivial to share development environments.

# <<file-warning>>
{
  description = "<<description>>";

  inputs = {
    <<os-nixpkgs>> 
    <<os-home-manager>>
    <<os-emacs-overlay>>
    <<os-nixos-hardware>>
    <<os-nix-on-droid>>
  };

  outputs = inputs @ { self, nixpkgs, nixpkgs-unstable, ... }: {
    nixosConfigurations = {
      <<host-default>>
      <<host-acernitro>>
      <<host-android>>
      <<host-homecloud>>
      <<host-raspberry>>
      <<host-zero-one>>
      <<host-zero-two>>
    };
  };
}

Nixpkgs

Nixpkgs⁶ is a collection of over 60,000 software packages that can be installed with the Nix⁵ package manager. Two main branches are offered:

1. The current stable release

2. The Unstable branch following the latest development

nixpkgs.url = "nixpkgs/nixos-unstable";
nixpkgs-unstable.url = "nixpkgs/master";

Home Manager

Home Manager⁷ provides a basic system for managing user environments using the Nix⁵ package manager together with the Nix libraries found in Nixpkgs⁶. It allows declarative configuration of user specific (non-global) packages and files.

home-manager.url = "github:nix-community/home-manager";
home-manager.inputs.nixpkgs.follows = "nixpkgs";

Emacs Overlay

Adding the Emacs Overlay⁸ extends the GNU/Emacs² package set to contain the latest versions, and daily generations from popular package sources, including the needed dependencies to run GNU/Emacs² as a Window Manager.

emacs-overlay.url = "github:nix-community/emacs-overlay";

NixOS Hardware

NixOS Hardware⁹ is a collection of NixOS⁴ modules covering specific hardware quirks. Unlike the channel, this will update the git repository on a rebuild. However, it's easy to pin particular revisions for more stability.

nixos-hardware.url = "github:nixos/nixos-hardware";

Nix On Droid

Nix On Droid¹⁰ is a deployment of the Nix⁵ Package Manager on Android, in a single-click installable package. It does not require root, user namespace support, or disabling SELinux, but relies on proot. It has no relation to the Termux distribution.

nix-on-droid.url = "github:t184256/nix-on-droid/master";
nix-on-droid.inputs.nixpkgs.follows = "nixpkgs";

Host Configurations

NixOS⁴ typically stores the current machine configuration in /etc/nixos/configuration.nix. In this project, this file is stored in /etc/dotfiles/hosts/$HOSTNAME/..., and imported, along with the generated hardware configurations. This ensures that multiple host machines can share the same modules, and generating new host definitions is trivial.

Default

The default host, built using QEMU¹¹, a free and open-source emulator that can perform hardware virtualization. It features a lightweight system optimized for development, running GNU/Emacs² + EXWM¹² as the graphical environment.

nixos = nixpkgs.lib.nixosSystem {
  system = "x86_64-linux";
  specialArgs = { inherit inputs; };
  modules = [
    ./hosts/nixos
    <<module-x11>>
    <<module-flakes>>
    <<module-cachix>>
    <<module-home-manager>>
  ];
};

Deploy this configuration with nixos-rebuild switch --flake /etc/dotfiles/#nixos.

# <<file-warning>>
{ ... }:

{
  imports = [
    ./configuration.nix
    ./hardware.nix
  ];
}

Configuration

This is a basic default configuration that specified the indended default configuration of the system. Because NixOS⁴ has a declarative configuration model, you can create or edit a description of the desired configuration, and update it from one file.

# <<file-warning>>
{ config, pkgs, inputs, ... }:

{
  boot.loader.grub.enable = true;
  boot.loader.grub.version = 2;
  boot.loader.grub.device = "/dev/sda";

  time.timeZone = "America/Toronto";

  networking.hostName = "nixos";
  networking.useDHCP = false;
  networking.firewall.enable = false;
  networking.interfaces.ens3.useDHCP = true;

  programs.mtr.enable = true;
  programs.fish.enable = true;
  programs.gnupg.agent.enable = true;

  users.users.chris = {
    shell = pkgs.fish;
    isNormalUser = true;
    extraGroups = [ "wheel" ];
  };
}

Hardware

The file system for this host is a single 24GB QCOW file, a format for disk images used by QEMU¹¹. The file can be recreated easily by following the steps listed in the NixOS⁴ installation manual, specifically the section on disk formatting.

# <<file-warning>>
{ config, lib, pkgs, modulesPath, ... }:

{
  imports =
    [ (modulesPath + "/profiles/qemu-guest.nix")
    ];

  boot.initrd.availableKernelModules = [ "ata_piix" "floppy" "sd_mod" "sr_mod" ];
  boot.initrd.kernelModules = [ ];
  boot.kernelModules = [ ];
  boot.extraModulePackages = [ ];

  fileSystems."/" =
    { device = "/dev/disk/by-uuid/fddc37ff-a442-41fa-afc4-abf878be7c5a";
      fsType = "ext4";
    };

  swapDevices =
    [ { device = "/dev/disk/by-uuid/5fc0e3df-e796-4fe2-8482-c6acaed9d36f"; }
    ];
}

Acernitro

My gaming laptop, the model is an Acer Nitro AN-515-53¹³. The Nitro 5 has more in common with the mid-range notebooks rather than the gaming models due to its cooling design, chassis, and overall construction.

Here are the specs:

Slot	Component
CPU	Intel Core i5-8300H
GPU	NVIDIA GeForce GTX 1050Ti (4GB GDDR5)
RAM	16GB DDR4
Display	15.6" Full HD (1920 x 1080), IPS
Storage	1000GB HDD
Weight	2.48kg (5.5 lbs)

acernitro = nixpkgs.lib.nixosSystem {
  system = "x86_64-linux";
  specialArgs = { inherit inputs; };
  modules = [
    ./hosts/acernitro
    <<module-x11>>
    <<module-flakes>>
    <<module-cachix>>
    <<module-firefox>>
    <<module-moonlight>>
    <<module-teamviewer>>
    <<module-home-manager>>
  ];
};

Deploy this configuration with nixos-rebuild switch --flake /etc/dotfiles/#acernitro.

# <<file-warning>>
{ ... }:

{
  imports = [
    ./configuration.nix
    ./hardware.nix
  ];
}

Configuration

This configuration is nearly identical to the default, except for a few key differences:

• Enables sound

• Applies the desired hostname

• It adds support for UEFI systems

• Enables support for wireless networking

# <<file-warning>>
{ config, pkgs, inputs, ... }:

{
  boot.loader.systemd-boot.enable = true;
  boot.loader.efi.canTouchEfiVariables = true;

  time.timeZone = "America/Toronto";

  networking.hostName = "acernitro";
  networking.firewall.enable = false;
  networking.wireless.enable = true;
  networking.wireless.userControlled.enable = true;
  networking.useDHCP = false;
  networking.interfaces.enp6s0f1.useDHCP = true;
  networking.interfaces.wlp0s20f3.useDHCP = true;

  # Pre-configured wireless networks.
  networking.wireless.networks.MyWiFi_5C1870.pskRaw =
    "409b3c85fef1c5737f284d2f82f20dc6023e41804e862d4fa26265ef8193b326";

  services.openssh.enable = true;
  services.printing.enable = true;

  programs.mtr.enable = true;
  programs.fish.enable = true;
  programs.gnupg.agent.enable = true;

  users.users.chris = {
    shell = pkgs.fish;
    isNormalUser = true;
    extraGroups = [ "wheel" ];
  };
}

Hardware

• Override the default DPI

• Enables sound via PulseAudio

• Adds support for the NVIDIA Hybrid GPU

# <<file-warning>>
{ config, lib, pkgs, modulesPath, ... }:

{
  imports =
    [ (modulesPath + "/installer/scan/not-detected.nix")
    ];

  boot.initrd.availableKernelModules = [ "xhci_pci" "ahci" "usb_storage" "sd_mod" "rtsx_pci_sdmmc" ];
  boot.initrd.kernelModules = [ ];
  boot.kernelModules = [ "kvm-intel" ];
  boot.extraModulePackages = [ ];

  sound.enable = true;
  hardware.pulseaudio.enable = true;
  hardware.pulseaudio.support32Bit = true;

  services.xserver.dpi = 96;

  fileSystems."/" =
    { device = "/dev/disk/by-uuid/2f548eb9-47ce-4280-950f-9c6d1d162852";
      fsType = "ext4"; 
    };

  fileSystems."/boot" =
    { device = "/dev/disk/by-uuid/5BC3-73F3";
      fsType = "vfat";
    };

  swapDevices =
    [ { device = "/dev/disk/by-uuid/bef7bf62-d26f-45b1-a1f8-1227c2f8b26a"; }
    ];

  powerManagement.cpuFreqGovernor = lib.mkDefault "powersave";
}

TODO Android

This is my Samsung Galaxy S10+¹⁴ running Nix On Droid¹⁰ with the experimental support for Flakes being used to manage the configuration.

android = (inputs.nix-on-droid.lib.aarch64-linux.nix-on-droid {
  config = ./hosts/android/nix-on-droid.nix
}).activationPackage;

Build the activation package with nix build .#android --impure, and activate it with result/activate.

# <<file-warning>>
{ pkgs, ... }:

{
  environment.packages = [
    pkgs.git
    pkgs.vim
    pkgs.pass
    pkgs.gnupg
    pkgs.openssh
  ];
}

TODO Homecloud

TODO: Raspberry Pi 4B 8GB

# TODO: Homecloud

TODO Raspberry

TODO: Raspberry Pi 400

# TODO: Raspberry

TODO Zero-One

TODO: Raspberry Pi Zero/Zero WH

# TODO: Zero-One

TODO Zero-Two

# TODO: Zero-One

Development Shells

The command nix-shell¹⁵ will build the dependencies of the specified derivation, but not the derivation itself. It will then start an interactive shell in which all environment variables defined by the derivation path have been set to their corresponding values.

Import this shell with nix-shell /etc/dotfiles.

# <<file-warning>>
{ pkgs ? import <nixpkgs> { } }:

with pkgs;

let
  nixBin = writeShellScriptBin "nix" ''
    ${nixFlakes}/bin/nix --option experimental-features "nix-command flakes" "$@"
  '';

in mkShell {
  buildInputs = [
    git
  ];
  shellHook = ''
    export FLAKE="$(pwd)"
    export PATH="$FLAKE/bin:${nixBin}/bin:$PATH"
  '';
}

Go

Go¹⁶ is an open-source programming language that makes it easy to build simple, reliable, and efficient software. It's statically typed and compiled programming language. It's syntactically similar to C, but with memory safety, garbage collection, structural typing, and CSP-style concurrency.

Import this shell with nix-shell /etc/dotfiles/shells/go

# <<file-warning>>
{ pkgs ? import <nixpkgs> { } }:

with pkgs;
mkShell {
  buildInputs = [
    go
    gopls
    protoc-gen-go-grpc
  ];
  shellHook = ''
    export GO111MODULE=on
    export GOPATH=$HOME/.go/
    export PATH=$GOPATH/bin:$PATH
  '';
}

gRPC

gRPC¹⁷ is a modern open-source, high-performance Remote Procedure Call (RPC) framework that can run in any environment. It can efficiently connect services in and across data centres with pluggable support for load balancing, tracing, health checking, and authentication.

Import this shell with nix-shell /etc/dotfiles/shells/grpc

# <<file-warning>>
{ pkgs ? import <nixpkgs> { } }:

with pkgs;
mkShell {
  buildInputs = [
    grpc
    grpc-tools
    grpcui
    grpcurl
  ];
  shellHook = ''
  '';
}

C/C++

C¹⁸ is a general-purpose, procedural computer programming language support structured programming, lexical variable scope, and recursion. It has a static type system, and by design provides constructs that map efficiently to typical machine instructions. C++¹⁹ is a general-purpose programming language created as an extension of the C¹⁸ programming language.

Import this shell with nix-shell /etc/dotfiles/shells/cc

# <<file-warning>>
{ pkgs ? import <nixpkgs> { } }:

with pkgs;
mkShell {
  buildInputs = [
    ccls
    gnumake
    libstdcxx5
    gcc-unwrapped
  ];
  shellHook = ''
  '';
}

Python

Python²⁰ is an interpreted high-level, general-purpose programming language. Its design philosophy emphasizes code readability, with its notable use of significant indentation. Its language constructs, as well as its object-oriented approach aim to help programmers write clear, logical, code for small and large projects.

Import this shell with nix-shell /etc/dotfiles/shells/python

# <<file-warning>>
{ pkgs ? import <nixpkgs> { } }:

with pkgs;
mkShell {
  buildInputs = [
    python39Packages.pip
    python39Packages.pip-tools
    python39Packages.pyls-mypy
    python39Packages.pyls-isort
    python39Packages.pyls-black
  ];
  shellHook = ''
  '';
}

Module Definitions

Modules are files combined by NixOS⁴ to produce the full system configuration. Modules wre introduced to allow extending NixOS⁴ without modifying its source code. They also allow splitting up configuration.nix, making the system configuration easier to maintain and use.

X11

./modules/x11.nix

X11, or X²¹ is the generic name for the X Window System Display Server. All graphical GNU/Linux¹ applications connect to an X-Window²¹ (or Wayland²²) to display graphical data on the monitor of a computer. Its a program that acts as the interface between graphical applications and the graphics subsystem of the computer.

# <<file-warning>>
{ config, pkgs, ... }:

{
  services.xserver.enable = true;
  services.xserver.layout = "us";
  services.xserver.libinput.enable = true;
  services.xserver.displayManager.startx.enable = true;

  environment = {
    systemPackages = with pkgs; [
      pkgs.sqlite
      pkgs.pfetch
      pkgs.cmatrix
      pkgs.asciiquarium
    ];
    extraInit = ''
      export XAUTHORITY=/tmp/Xauthority
      export xserverauthfile=$XAUTHORITY
      [ -e ~/.Xauthority ] && mv -f ~/.Xauthority "$XAUTHORITY"
    '';
  };

  services.picom.enable = true;
  services.openssh.enable = true;
  services.printing.enable = true;

  fonts.fonts = with pkgs; [
    iosevka
    emacs-all-the-icons-fonts
  ];
}

Flakes

./modules/flakes.nix

Nix Flakes²³ are an upcoming feature of the Nix package manager⁵. They allow you to specify your codes dependencies in a declarative way, simply by listing them inside of a flake.nix file. Each dependency is then pinned to a specific git-hash. Flakes²³ replace the nix-channels command and things like builtins.fetchGit, keeping dependencies at the top of the tree, and channels always in sync. Currently, Flakes²³ are not available unless explicitly enabled.

# <<file-warning>>
{ config, pkgs, inputs, ... }:

{
  nix = {
    package = pkgs.nixUnstable;
    extraOptions = ''
      experimental-features = nix-command flakes
    '';
  };

  nixpkgs = {
    config = { allowUnfree = true; };
    overlays = [ inputs.emacs-overlay.overlay ];
  };
}

Cachix

./modules/cachix.nix

Cachix²⁴ is a Command line client for Nix⁵ binary cache hosting. This allows downloading and usage of pre-compiled binaries for applications on nearly every available system architecture. This speeds up the time it takes to rebuild configurations.

# <<file-warning>>
{ config, ... }:

{
  nix = {
    binaryCaches = [
      "https://nix-community.cachix.org"
    ];
    binaryCachePublicKeys = [
      "nix-community.cachix.org-1:mB9FSh9qf2dCimDSUo8Zy7bkq5CX+/rkCWyvRCYg3Fs="
    ];
  };
}

Firefox

./modules/firefox.nix

Firefox Browser²⁵, also known as Mozilla Firefox or simply Firefox, is a free and open-source web browser developed by the Mozilla Foundation and its subsidiary, the Mozilla Corporation. Firefox uses the Gecko layout engine to render web pages, which implements current and anticipated web standards. In 2017, Firefox began incorporating new technology under the code name Quantum to promote parallelism and a more intuitive user interface.

# <<file-warning>>
{ pkgs, ... }:

{
  # NOTE: Use the binary until module is developed.
  environment.systemPackages = [
    pkgs.firefox-bin 
  ];
}

Moonlight

./modules/moonlight.nix

Moonlight²⁶ is an open-source implementation of NVIDIA's GameStream Protocol. You can stream your collection of PC games from your GameStream-compatible PC to any supported device and play them remotely. Moonlight²⁶ is perfect for gaming on the go (or on GNU/Linux¹) without sacrificing the graphics and game selection available for the PC.

# <<file-warning>>
{ pkgs, ... }:

{
  environment.systemPackages = [
    pkgs.moonlight-qt
  ];
}

Teamviewer

./modules/teamviewer.nix

The Teamviewer²⁷ remote connectivity cloud platform enables secure remote access to any device, across platforms, from anywhere, anytime. Teamviewer²⁷ connects computers, smartphones, servers, IoT devices, robots – anything – with fast, high performance connections through their global access network. It has been used in outer-space low-bandwidth environments.

# <<file-warning>>
{ pkgs, ... }:

{
  # NOTE: Neither of these are working!
  # services.teamviewer.enable = true;

  # environment.systemPackages = [
  #   pkgs.teamviewer
  # ];
}

Home Manager

Home Manager⁷ includes a flake.nix file for compatibility with Nix Flakes, a feature utilized heavily in this project. When using flakes, switching to a new configuration is done only for the entire system, using the command nixos-rebuild switch --flake <path>, instead of nixos-rebuild, and home-manager seperately.

inputs.home-manager.nixosModules.home-manager {
  home-manager.useGlobalPkgs = true;
  home-manager.useUserPackages = true;
  home-manager.users.chris = {
    imports = [
      <<module-git>>
      <<module-gpg>>
      <<module-vim>>
      <<module-gtk>>
      <<module-emacs>>
    ];
  };
}

Git

./modules/git.nix

Git²⁸ is a free and open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency. Git is easy to learn, has a tiny footprint, and lighting fast performance. It outclasses every other version control tool such as: SCM, Subversion, CVS, ClearCase, with features like cheap local branching, convinient staging areas, and multiple workflows.

# <<file-warning>>
{ pkgs, ... }:

{
  programs.git = {
    enable = true;
    userName = "Christopher James Hayward";
    userEmail = "chris@chrishayward.xyz";

    signing = {
      key = "37AB1CB72B741E478CA026D43025DCBD46F81C0F";
      signByDefault = true;
    };
  };
}

Gpg

./modules/gpg.nix

GNU Privacy Guard²⁹ is a free-software replacement for Symantec's PGP cryptographic software suite. It is compliant with RFC 4880, the IETF standards-track specification of OpenPGP. Modern versions of PGP are interoperable with GnuPG and other OpenPGP-compliant systems.

# <<file-warning>>
{ pkgs, ... }:

{
  services.gpg-agent = {
    enable = true;
    defaultCacheTtl = 1800;
    enableSshSupport = true;
    pinentryFlavor = "gtk2";
  };
}

Vim

./modules/vim.nix

Neovim³⁰ is a project that seeks to aggressively refactor Vim in order to:

• Simplify maintenance and encourage contributions

• Split the work between multiple developers

• Enable advanced UIs without core modification

• Maximize extensibility

# <<file-warning>>
{ pkgs, ... }:

{
  programs.neovim = {
    enable = true;
    viAlias = true;
    vimAlias = true;
    vimdiffAlias = true;
    extraConfig = ''
      set number relativenumber
      set nobackup
    '';
    extraPackages = [
      pkgs.nixfmt
    ];
    plugins = with pkgs.vimPlugins; [
      vim-nix
      vim-airline
      vim-polyglot
    ];
  };
}

GTK

./modules/gtk.nix

GTK³¹ is a free and open-source, cross-platform widget toolkit for graphical user interfaces. It's one of the most popular toolkits for the Wayland²² and X11²¹ windowing systems.

# <<file-warning>>
{ pkgs, ... }:

{
  home.packages = [
    pkgs.arc-theme
    pkgs.arc-icon-theme
    pkgs.lxappearance
  ];

  home.file.".gtkrc-2.0" = {
    text = ''
      gtk-theme-name="Arc-Dark"
      gtk-icon-theme-name="Arc"
      gtk-font-name="Sans 10"
      gtk-cursor-theme-size=0
      gtk-toolbar-style=GTK_TOOLBAR_BOTH_HORIZ
      gtk-toolbar-icon-size=GTK_ICON_SIZE_LARGE_TOOLBAR
      gtk-button-images=0
      gtk-menu-images=0
      gtk-enable-event-sounds=1
      gtk-enable-input-feedback-sounds=1
      gtk-xft-antialias=1
      gtk-xft-hinting=1
      gtk-xft-hintstyle="hintmedium"
    '';
  };
}

Emacs Configuration

./modules/emacs.nix

GNU/Emacs² is an extensible, customizable, free/libre text editor – and more. At its core is an interpreter for Emacs Lisp²⁹, a dialect of the Lisp programming language with extensions to support text editing. Other features include:

• Highly customizable

• Full Unicopde support

• Content-aware editing modes

• Complete built-in documentation

• Wide range of functionality beyond text editing

# <<file-warning>>
{ pkgs, ... }:

let
  myEmacs = pkgs.emacsWithPackagesFromUsePackage {
    config = ../README.org;
    package = <<emacs-native-comp-package>>
    alwaysEnsure = true;
    alwaysTangle = true;
    extraEmacsPackages = epkgs: [
      # Required packages...
      <<emacs-exwm-package>>
      <<emacs-evil-package>>
      <<emacs-general-package>>
      <<emacs-which-key-package>>

      # Optional packages.
      <<emacs-org-package>>
      <<emacs-org-roam-package>>
      <<emacs-org-drill-package>>
      <<emacs-pomodoro-package>>
      <<emacs-writegood-package>>
      <<emacs-hugo-package>>
      <<emacs-reveal-package>>
      <<emacs-pass-package>>
      <<emacs-mu4e-package>>
      <<emacs-dired-package>>
      <<emacs-icons-package>>
      <<emacs-emoji-package>>
      <<emacs-eshell-package>>
      <<emacs-vterm-package>>
      <<emacs-magit-package>>
      <<emacs-fonts-package>>
      <<emacs-elfeed-package>>
      <<emacs-nix-mode-package>>
      <<emacs-projectile-package>>
      <<emacs-lsp-package>>
      <<emacs-company-package>>
      <<emacs-golang-package>>
      <<emacs-python-package>>
      <<emacs-plantuml-package>>
      <<emacs-swiper-package>>
      <<emacs-doom-themes-package>>
      <<emacs-doom-modeline-package>>
    ];
  };

in {
  home.packages = [
    <<emacs-exwm-extras>>
    <<emacs-hugo-extras>>
    <<emacs-pass-extras>>
    <<emacs-mu4e-extras>>
    <<emacs-aspell-extras>>
    <<emacs-plantuml-extras>>
    <<emacs-nix-mode-extras>>
  ];

  programs.emacs = {
    enable = true;
    package = myEmacs;
  };

  <<emacs-exwm-config>>
  <<emacs-exwm-xinitrc>>
  <<emacs-mu4e-config>>
}

When Emacs is started, it normally tries to load a Lisp program from an ititialization file, or init file. This file, if it exists, specifies how to initialize and configure Emacs.

;; <<file-warning>>

;; Required inputs.
<<emacs-exwm-elisp>>
<<emacs-evil-elisp>>
<<emacs-general-elisp>>
<<emacs-which-key-elisp>>

;; Optional inputs.
<<emacs-org-elisp>>
<<emacs-org-roam-elisp>>
<<emacs-org-drill-elisp>>
<<emacs-org-agenda-elisp>>
<<emacs-pomodoro-elisp>>
<<emacs-writegood-elisp>>
<<emacs-aspell-elisp>>
<<emacs-eww-elisp>>
<<emacs-hugo-elisp>>
<<emacs-reveal-elisp>>
<<emacs-pass-elisp>>
<<emacs-mu4e-elisp>>
<<emacs-dired-elisp>>
<<emacs-icons-elisp>>
<<emacs-emoji-elisp>>
<<emacs-eshell-elisp>>
<<emacs-vterm-elisp>>
<<emacs-magit-elisp>>
<<emacs-fonts-elisp>>
<<emacs-elfeed-elisp>>
<<emacs-projectile-elisp>>
<<emacs-lsp-elisp>>
<<emacs-company-elisp>>
<<emacs-golang-elisp>>
<<emacs-python-elisp>>
<<emacs-plantuml-elisp>>

;; User interface.
<<emacs-swiper-elisp>>
<<emacs-transparency-elisp>>
<<emacs-doom-themes-elisp>>
<<emacs-doom-modeline-elisp>>

It's somtimes desirable to have customization that takes effect during Emacs startup earlier than the normal init file. Place these configurations in ~/.emacs.d/early-init.el. Most customizations should be put in the normal init file ~/.emacs.d/init.el.

;; <<file-warning>>
<<emacs-disable-ui-elisp>>
<<emacs-native-comp-elisp>>
<<emacs-backup-files-elisp>>
<<emacs-shell-commands-elisp>>

Disable UI

Emacs² has been around since the 1980s, and it's painfully obvious when you're greeted with the default user interface. Disable some unwanted features to clean it up, and bring the appearance to something closer to a modern editor.

;; Disable unwanted UI elements.
(tooltip-mode -1)
(menu-bar-mode -1)
(tool-bar-mode -1)
(scroll-bar-mode -1)

;; Fix the scrolling behaviour.
(setq scroll-conservatively 101)

;; Fix mouse-wheel scrolling behaviour.
(setq mouse-wheel-follow-mouse t
      mouse-wheel-progressive-speed t
      mouse-wheel-scroll-amount '(3 ((shift) . 3)))

Native Comp

pkgs.emacsGcc;

Native Comp, also known as GccEmacs, refers to the --with-native-compilation configuration option when building GNU/Emacs². It adds support for compiling Emacs Lisp to native code using libgccjit. All of the Emacs Lisp packages shipped with Emacs are native-compiled, providing a noticable performance iomprovement out-of-the-box.

;; Silence warnings from packages that don't support `native-comp'.
(setq comp-async-report-warnings-errors nil         ;; Emacs 27.2 ...
      native-comp-async-report-warnings-errors nil) ;; Emacs 28+  ...

Backup Files

Emacs² makes a backup for a file only the first time the file is saved from a buffer. No matter how many times the file is subsequently written to, the backup remains unchanged. For files managed by a version control system, backup files are redundant since the previous versions are already stored.

;; Disable unwanted features.
(setq make-backup-files nil
      create-lockfiles nil)

Shell Commands

Define some methods for interaction between GNU/Emacs², and the systems underyling shell:

1. Method to run an external process, launching any application on a new process without interferring with Emacs²

2. Method to apply commands to the curren call process, effecting the running instance of Emacs²

;; Define a method to run an external process.
(defun dotfiles/run (cmd)
  "Run an external process."
  (interactive (list (read-shell-command "λ ")))
  (start-process-shell-command cmd nil cmd))

;; Define a method to run a background process.
(defun dotfiles/run-in-background (cmd)
  (let ((command-parts (split-string cmd "[ ]+")))
    (apply #'call-process `(,(car command-parts) nil 0 nil ,@(cdr command-parts)))))

Nix Mode

pkgs.nixfmt

Nix-mode³² is an Emacs² major mode for editing Nix⁵ expressions. This provides basic handling of .nix files. Syntax highlighting and indentation support using SMIE are provided.

epkgs.nix-mode

Evil Mode

Evil¹³ is an extensible VI layer for GNU/Emacs². It emulates the main features of Vim³⁰, turning GNU/Emacs² into a modal editor.

epkgs.evil
epkgs.evil-collection
epkgs.evil-surround
epkgs.evil-nerd-commenter

The next time Emacs² is started, it will come up in normal state, denoted by <N> in the modeline. This is where the main vi bindings are defined. Like Emacs² in general, Evil¹³ is extensible in Emacs Lisp²⁹.

;; Enable the Extensible VI Layer for Emacs.
(setq evil-want-integration t   ;; Required for `evil-collection.'
      evil-want-keybinding nil) ;; Same as above.
(evil-mode +1)

;; Configure `evil-collection'.
(evil-collection-init)

;; Configure `evil-surround'.
(global-evil-surround-mode +1)

;; Configure `evil-nerd-commenter'.
(global-set-key (kbd "M-;") 'evilnc-comment-or-uncomment-lines)

EXWM

epkgs.exwm

EXWM (Emacs X Window Manager)¹² is a full-featured tiling X window manager for GNU/Emacs² built on-top of XELB. It features:

• Fully keyboard-driven operations

• Hybrid layout modes (tiling & stacking)

• Dynamic workspace support

• ICCM/EWMH compliance

pkgs.nitrogen
pkgs.autorandr

I wanted to leave (exwm-enable) out of my Emacs configuration (which does no harm anyways). This can be called when using the daemon to start EXWM¹².

xsession = {
  enable = true;
  windowManager.command = ''
    ${pkgs.nitrogen}/bin/nitrogen --restore
    ${myEmacs}/bin/emacs --daemon -f exwm-enable
    ${myEmacs}/bin/emacsclient -c
  '';
};

EXWM¹² cannot make an X window manager by itself, this is by design; You must tell X to do it. Override the ~/.xinitrc file to start the xsession.

home.file.".xinitrc" = {
  text = ''
    exec ./.xsession
  '';
};

;; Configure `exwm'.
(setq exwm-worspace-show-all-buffers t)
(setq exwm-input-prefix-keys
  '(?\M-x
  ?\C-g
  ?\C-\ ))
(setq exwm-input-global-keys
  `(([?\s-r] . exwm-reset)
    ,@(mapcar (lambda (i)
                `(,(kbd (format "s-%d" i)) .
                (lambda ()
                (interactive)
                (exwm-workspace-switch-create ,i))))
                (number-sequence 1 9))))

;; Configure `exwm-randr'.
(require 'exwm-randr)
(exwm-randr-enable)

;; Configure custom hooks.
(setq display-time-and-date t)
(add-hook 'exwm-init-hook
  (lambda ()
    (display-battery-mode +1) ;; Display battery info (if available).
    (display-time-mode +1)))  ;; Display the time in the modeline.

;; Setup buffer display names.
(add-hook 'exwm-update-class-hook
  (lambda ()
    (exwm-workspace-rename-buffer exwm-class-name))) ;; Use the system class name.

;; Configure monitor hot-swapping.
(add-hook 'exwm-randr-screen-change-hook
  (lambda ()
    (dotfiles/run-in-background "autorandr --change --force"))) ;; Swap to the next screen config.

General

epkgs.general

General³³ provides a more convenient method for binding keys in Emacs², providing a unified interface for key definitions. Its primary purpose is to build on existing functionality to make key definitions more clear and concise.

;; Use <SPC> as a leader key via `general.el'.
(general-create-definer dotfiles/leader
  :states '(normal motion)
  :keymaps 'override
  :prefix "SPC"
  :global-prefix "C-SPC")

;; Find files with <SPC> <period> ...
;; Switch buffers with <SPC> <comma> ...
(dotfiles/leader
  "." '(find-file :which-key "File")
  "," '(switch-to-buffer :which-key "Buffer")
  "c" '(kill-buffer-and-window :which-key "Close"))

;; Add keybindings for executing shell commands.
(dotfiles/leader
  "r" '(:ignore t :which-key "Run")
  "rr" '(dotfiles/run :which-key "Run")
  "ra" '(async-shell-command :which-key "Async"))

;; Add keybindings for quitting Emacs.
(dotfiles/leader
  "q" '(:ignore t :which-key "Quit")
  "qq" '(save-buffers-kill-emacs :which-key "Save")
  "qw" '(kill-emacs :which-key "Now")
  "qf" '(delete-frame :which-key "Frame"))

;; Add keybindings for toggles / tweaks.
(dotfiles/leader
  "t" '(:ignore t :which-key "Toggle / Tweak"))

;; Add keybindings for working with frames to replace
;; the C-x <num> <num> method of bindings, which is awful.
(dotfiles/leader
  "w" '(:ignore t :which-key "Windows")
  "ww" '(window-swap-states :which-key "Swap")
  "wc" '(delete-window :which-key "Close")
  "wh" '(windmove-left :which-key "Left")
  "wj" '(windmove-down :which-key "Down")
  "wk" '(windmove-up :which-key "Up")
  "wl" '(windmove-right :which-key "Right")
  "ws" '(:ignore t :which-key "Split")
  "wsj" '(split-window-below :which-key "Below")
  "wsl" '(split-window-right :which-key "Right"))

Which Key

Which-key³⁴ is a minor mode for Emacs² that displays the key bindings following your currently entered incomplete command (prefix) in a popup or mini-buffer.

epkgs.which-key

;; Configure `which-key' to see keyboard bindings in the
;; mini-buffer and when using M-x.
(setq which-key-idle-delay 0.0)
(which-key-mode +1)

EWW

The Emacs Web Wowser³⁵ is a Web browser written in Emacs Lisp²⁹ based on the shr.el library. It's my primary browser when it comes to text-based browsing.

• Use eww as the default browser

• Don't use any special fonts or colours

;; Set `eww' as the default browser.
(setq browse-url-browser-function 'eww-browse-url)

;; Configure the `shr' rendering engine.
(setq shr-use-fonts nil
      shr-use-colors nil)

Dired

epkgs.dired-single

Dired³⁶ shows a directory listing inside of an Emacs² buffer that can be used to perform various file operations on files and subdirectories. THe operations you can perform are numerous, from creating subdirectories, byte-compiling files, searching, and editing files. Dired-Extra³⁷ provides extra functionality for Dired³⁶.

;; Include `dired-x' for the `jump' method.
(require 'dired-x)

;; Configure `dired-single' to support `evil' keys.
(evil-collection-define-key 'normal 'dired-mode-map
  "h" 'dired-single-up-directory
  "l" 'dired-single-buffer)

;; Setup `all-the-icons' and the `dired' extension.

;; Configure keybindings for `dired'.
(dotfiles/leader
  "d" '(dired-jump :which-key "Dired"))

Icons

epkgs.all-the-icons
epkgs.all-the-icons-dired

All The Icons³⁸ is a utility package to collect various Icon Fonts and prioritize them within GNU/Emacs².

;; Setup `all-the-icons-dired'.
(add-hook 'dired-mode-hook 'all-the-icons-dired-mode)

;; Display default font ligatures.
(global-prettify-symbols-mode +1)

Emojis

epkgs.emojify

Emojify³⁹ is an Emacs² extension to display Emojis. It can display GitHub style Emojis like 😄 or plain ascii ones such as :). It tries to be as efficient as possible, while also providing flexibility.

;; Setup `emojify'.
(add-hook 'after-init-hook 'global-emojify-mode)

EShell

epkgs.eshell-prompt-extras

EShell ⁴⁰ is a shell-like command interpreter for GNU/Emacs² implemented in Emacs Lisp²⁹. It invokes no external processes except for those requested by the user. It's intended to be an alternative for IELM, and a full REPL envionment for Emacs².

;; Configure `eshell'.
(setq eshell-highlight-prompt nil
      eshell-prefer-lisp-functions nil)

;; Configure the lambda prompt.
(autoload 'epe-theme-lambda "eshell-prompt-extras")
(setq eshell-prompt-function 'epe-theme-lambda)

;; Configure keybindings for `eshell'.
(dotfiles/leader
  "e" '(eshell :which-key "EShell"))

VTerm

Emacs Libvterm (VTerm)⁴¹ is a fully-fledged terminal emulator inside GNU/Emacs² based on Libvterm⁴², a blazing fast C library used in Neovim³⁰. As a result of using compiled code (instead of Emacs Lisp²⁹), VTerm⁴¹ is capable, fast, and it can seamlessly handle large outputs.

epkgs.vterm

;; Add keybindings for interacting with the shell(s).
(dotfiles/leader
  "v" '(vterm :which-key "VTerm"))

Magit

Magit⁴³ is an interface to the Git²⁸ version control system, implemented as a GNU/Emacs² package written in Elisp²⁹. It fills the glaring gap between the Git²⁸ command line interface and various GUIs, letting you perform trivial as well as elaborate version control tasks within a few mnemonic key presses.

epkgs.magit

Key	Description
gg	Check the status of a repository
gc	Clone a remote repository
gf	Fetch the contents of the repository
gp	Pull the remotes of the repository

;; Add keybindings for working with `magit'.
(dotfiles/leader
  "g" '(:ignore t :which-key "Git")
  "gg" '(magit-status :which-key "Status")
  "gc" '(magit-clone :which-key "Clone")
  "gf" '(magit-fetch :which-key "Fetch")
  "gp" '(magit-pull :which-key "Pull"))

Fonts

epkgs.hydra

;; Configure the font when running as `emacs-server'.
(custom-set-faces
  '(default ((t (:inherit nil :height 96 :family "Iosevka")))))

;; Set all three of Emacs' font faces.
;; NOTE: This only works without `emacs-server'.
;; (set-face-attribute 'default nil :font "Iosevka" :height 96)
;; (set-face-attribute 'fixed-pitch nil :font "Iosevka" :height 96)
;; (set-face-attribute 'variable-pitch nil :font "Iosevka" :height 96)

;; Define a `hydra' function for scaling the text interactively.
(defhydra hydra-text-scale (:timeout 4)
  "Scale text"
  ("j" text-scale-decrease "Decrease")
  ("k" text-scale-increase "Increase")
  ("f" nil "Finished" :exit t))

;; Create keybinding for calling the function.
(dotfiles/leader
  "tf" '(hydra-text-scale/body :which-key "Font"))

Elfeed

epkgs.elfeed

Elfeed⁴⁴ is an extensible web feed reader for GNU/Emacs², support both Atom and RSS. It requires Emacs 24.3+ and is available for download from the standard repositories.

Key	Command
l	Open
u	Update

;; Add custom feeds for `elfeed' to fetch.
(setq elfeed-feeds (quote
                     (("https://hexdsl.co.uk/rss.xml")
                      ("https://lukesmith.xyz/rss.xml")
                      ("https://friendo.monster/rss.xml")
                      ("https://chrishayward.xyz/index.xml")
                      ("https://protesilaos.com/codelog.xml"))))

;; Add custom keybindings for `elfeed'.
(dotfiles/leader
  "l" '(:ignore t :which-key "Elfeed")
  "ll" '(elfeed :which-key "Open")
  "lu" '(elfeed-update :which-key "Update"))

Org Mode

epkgs.org

Org-mode⁴⁵ is a document editing and organizing mode, designed for notes, planning, and authoring within the free software text editor GNU/Emacs². The name is used to encompass plain text files (such as this one) that include simple marks to indicate levels of a hierarchy, and an editor with functions that can read the markup and manipulate the hierarchy elements.

;; Configure `org-mode' source blocks.
(setq org-src-fontify-natively t      ;; Make source blocks prettier.
      org-src-tab-acts-natively t     ;; Use TAB indents within source blocks.
      org-src-preserve-indentation t) ;; Stop `org-mode' from formatting blocks.

;; Add an `org-mode-hook'.
(add-hook 'org-mode-hook
  (lambda ()
    (org-indent-mode)
    (visual-line-mode)))

;; Remove the `Validate XHTML 1.0' message from HTML export.
(setq org-export-html-validation-link nil
      org-html-validation-link nil)

;; TODO: Configure default structure templates.
;; (require 'org-tempo)

;; Apply custom keybindings.
(dotfiles/leader
  "o" '(:ignore t :which-key "Org")
  "oe" '(org-export-dispatch :which-key "Export")
  "ot" '(org-babel-tangle :which-key "Tangle")
  "oi" '(org-toggle-inline-images :which-key "Images")
  "of" '(:ignore t :which-key "Footnotes")
  "ofn" '(org-footnote-normalize :which-key "Normalize"))

Org Roam

epkgs.org-roam
epkgs.org-roam-server

Org Roam⁴⁶ is a plain-text knowledge management system. It borrows principles from the Zettelkasten method⁴⁷, providing a solution for non-hierarchical note-taking. It should also work as a plug-and-play solution for anyone already using Org Mode⁴⁵ for their personal wiki (me). Org Roam Server⁴⁸ is a Web application to visualize the Org Roam⁴⁶ database. Although it should automatically reload if there's a change in the database, it can be done so manually by clicking the reload button on the Web interface.

;; Setup `org-roam' hooks.
(add-hook 'after-init-hook
  (lambda ()
    (org-roam-mode)
    (org-roam-server-mode)))

;; Configure `org-roam'.
(setq org-roam-encrypt-files t
      org-roam-directory (expand-file-name "/etc/dotfiles")
      org-roam-capture-templates '()
      org-roam-dailies-capture-templates '())

;; Encrypt files with the public key.
(setq epa-file-select-keys 2
      epa-file-encrypt-to "37AB1CB72B741E478CA026D43025DCBD46F81C0F"
      epa-cache-passphrase-for-symmetric-encryption t)

;; Define a new `title-to-slug' function to override the default `org-roam-title-to-slug' function.
;; This is done to change the replacement character from "_" to "-".
(require 'cl-lib)
(defun dotfiles/title-to-slug (title)
  "Convert TITLE to a filename-suitable slug."
  (cl-flet* ((nonspacing-mark-p (char)
                                (eq 'Mn (get-char-code-property char 'general-category)))
             (strip-nonspacing-marks (s)
                                     (apply #'string (seq-remove #'nonspacing-mark-p
                                                                 (ucs-normalize-NFD-string s))))
             (cl-replace (title pair)
                         (replace-regexp-in-string (car pair) (cdr pair) title)))
    (let* ((pairs `(("[^[:alnum:][:digit:]]" . "-") ;; Convert anything not alphanumeric.
                    ("--*" . "-")                   ;; Remove sequential dashes.
                    ("^-" . "")                     ;; Remove starting dashes.
                    ("-$" . "")))                   ;; Remove ending dashes.
           (slug (-reduce-from #'cl-replace (strip-nonspacing-marks title) pairs)))
      (downcase slug))))
(setq org-roam-title-to-slug-function #'dotfiles/title-to-slug)

;; Configure capture templates.
;; Standard document.
(add-to-list 'org-roam-capture-templates
  '("d" "Default" entry (function org-roam-capture--get-point)
        "%?"
        :file-name "docs/${slug}"
        :unnarrowed t
        :head 
"
,#+TITLE: ${title}
,#+AUTHOR: Christopher James Hayward
,#+EMAIL: chris@chrishayward.xyz
"))

;; Course document.
(add-to-list 'org-roam-capture-templates
  '("c" "Course" plain (function org-roam-capture--get-point)
        "%?"
        :file-name "docs/courses/${slug}"
        :unnarrowed t
        :head
"
,#+TITLE: ${title}
,#+SUBTITLE:
,#+AUTHOR: Christopher James Hayward
,#+EMAIL: chris@chrishayward.xyz

,#+OPTIONS: num:nil toc:nil todo:nil tasks:nil tags:nil
,#+OPTIONS: skip:nil author:nil email:nil creator:nil timestamp:nil
"))

;; Daily notes.
(add-to-list 'org-roam-dailies-capture-templates
  '("d" "Default" entry (function org-roam-capture--get-point)
           "* %?"
           :file-name "docs/daily/%<%Y-%m-%d>"
           :head
"
,#+TITLE: %<%Y-%m-%d>
,#+AUTHOR: Christopher James Hayward

,#+OPTIONS: num:nil toc:nil todo:nil tasks:nil tags:nil
,#+OPTIONS: skip:nil author:nil email:nil creator:nil timestamp:nil
"))

;; Apply custom keybindings.
(dotfiles/leader
  "or"  '(:ignore t :which-key "Roam")
  "ori" '(org-roam-insert :which-key "Insert")
  "orf" '(org-roam-find-file :which-key "Find")
  "orc" '(org-roam-capture :which-key "Capture")
  "orb" '(org-roam-buffer-toggle-display :which-key "Buffer"))

;; Apply custom keybindings for dailies.
(dotfiles/leader
  "ord" '(:ignore t :which-key "Dailies")
  "ordd" '(org-roam-dailies-find-date :which-key "Date")
  "ordt" '(org-roam-dailies-find-today :which-key "Today")
  "ordm" '(org-roam-dailies-find-tomorrow :which-key "Tomorrow")
  "ordy" '(org-roam-dailies-find-yesterday :which-key "Yesterday"))

Org Drill

epkgs.org-drill

Org Drill⁴⁹ is an extension for Org Mode⁴⁵ that uses a spaced repition algorithm to conduct interactive Drill Sessions using Org files as sources of facts to be memorized.

;; Configure keybindings for `org-drill'.
(dotfiles/leader
  "od" '(:ignore t :which-key "Drill")
  "odd" '(org-drill :which-key "Drill")
  "odc" '(org-drill-cram :which-key "Cram")
  "odr" '(org-drill-resume :which-key "Resume"))

Org Agenda

The way Org Mode⁴⁵ works, TODO items, time-stamped items, and tagged headlines can be scattered throughout a file, or even a number of files. To get an overview of open action items, or of events that are important for a particular date, this information must be collected, sorted, and displayed in an organized way.

;; Configure `org-agenda' to use the project files.
(setq org-agenda-files '("/etc/dotfiles/"
                         "/etc/dotfiles/docs/"
                         "/etc/dotfiles/docs/courses/"
                         "/etc/dotfiles/docs/daily/"
                         "/etc/dotfiles/docs/notes/"
                         "/etc/dotfiles/docs/posts/"
                         "/etc/dotfiles/docs/slides/"))

;; Include files encrypted with `gpg'.
(require 'org)
(unless (string-match-p "\\.gpg" org-agenda-file-regexp)
  (setq org-agenda-file-regexp
    (replace-regexp-in-string "\\\\\\.org" "\\\\.org\\\\(\\\\.gpg\\\\)?"
                              org-agenda-file-regexp)))

;; Open an agenda buffer with SPC o a.
(dotfiles/leader
  "oa" '(org-agenda :which-key "Agenda"))

Org Pomodoro

epkgs.org-pomodoro

Org Pomodoro⁵⁰ adds basic support for the Pomodoro Technique⁵¹ in GNU/Emacs². It can be started for the task at point, or the last task time was clocked for. Each session starts a timer of 25 minutes, finishing with a break of 5 minutes. After 4 sessions, ther will be a break of 20 minutes. All values are customizable.

;; Configure `org-pomodor' with the overtime workflow.
(setq org-pomodoro-manual-break t
      org-pomodoro-keep-killed-time t)

;; Configure keybindings.
(dotfiles/leader
  "op" '(org-pomodoro :which-key "Pomodoro"))

Writegood Mode

epkgs.writegood-mode

Writegood Mode⁵² is an Emacs² minor mode to aid in finding common writing problems. It highlights the text based on the following criteria:

• Weasel Words

• Passive Voice

• Duplicate Words

;; Configure `writegood-mode'.
(dotfiles/leader
  "tg" '(writegood-mode :which-key "Grammar"))

Aspell

pkgs.aspell
pkgs.aspellDicts.en
pkgs.aspellDicts.en-science
pkgs.aspellDicts.en-computers

GNU Aspell⁵³ is a Free and Open Source spell checker designed to replace ISpell. It can be used as a library, or an independent spell checker. Its main feature is that it does a superior job of suggesting possible replacements for mis-spelled words than any other spell checker for the English language.

;; Use `aspell' as a drop-in replacement for `ispell'.
(setq ispell-program-name "aspell"
      ispell-eextra-args '("--sug-mode=fast"))

;; Configure the built-in `flyspell-mode'.
(dotfiles/leader
  "ts" '(flyspell-mode :which-key "Spelling"))

Hugo

pkgs.hugo

Hugo⁵⁴ is one of the most popular open-source static site generators.

epkgs.ox-hugo

Ox-Hugo⁵⁵ is an Org-Mode⁴⁵ exporter for Hugo⁵⁴ compabile markdown. I post nonsense on my Personal Blog⁵⁶, and share my notes on various textbooks, articles, and software Here⁵⁷.

;; Configure `ox-hugo' as an `org-mode-export' backend.
(require 'ox-hugo)

;; Capture templates.
;; Personal blog post.
(add-to-list 'org-roam-capture-templates
             '("p" "Post" plain (function org-roam-capture--get-point)
               "%?"
               :file-name "docs/posts/${slug}"
               :unnarrowed t
               :head
"
,#+TITLE: ${title}
,#+AUTHOR: Christopher James Hayward
,#+DATE: %<%Y-%m-%d>

,#+OPTIONS: num:nil todo:nil tasks:nil

,#+EXPORT_FILE_NAME: ${slug}
,#+ROAM_KEY: https://chrishayward.xyz/posts/${slug}/

,#+HUGO_BASE_DIR: ../
,#+HUGO_AUTO_SET_LASTMOD: t
,#+HUGO_SECTION: posts
,#+HUGO_DRAFT: true
"))

;; Shared notes.
(add-to-list 'org-roam-capture-templates
             '("n" "Notes" plain (function org-roam-capture--get-point)
                "%?"
                :file-name "docs/notes/${slug}"
                :unnarrowed t
                :head
"
,#+TITLE: ${title}
,#+AUTHOR: Christopher James Hayward

,#+OPTIONS: num:nil todo:nil tasks:nil
,#+EXPORT_FILE_NAME: ${slug}
,#+ROAM_KEY: https://chrishayward.xyz/notes/${slug}/

,#+HUGO_BASE_DIR: ../
,#+HUGO_AUTO_SET_LASTMOD: t
,#+HUGO_SECTION: notes
,#+HUGO_DRAFT: true
"))

Reveal

epkgs.ox-reveal

Reveal.js⁵⁸ is an open source HTML presentation framework. It enables anyone with a web browser to create fully-featured and beautiful presentations for free. Presentations with Reveal.js⁵⁸ are built on open web technologies. That means anything you can do on the web, you can do in your presentation. Ox Reveal⁵⁹ is an Org Mode⁴⁵ export backend.

;; Configure `ox-reveal' as an `org-mode-export' backend.
(require 'ox-reveal)

;; Don't rely on any local software.
(setq org-reveal-root "https://cdn.jsdelivr.net/npm/reveal.js")

;; Create a capture template.
(add-to-list 'org-roam-capture-templates
             '("s" "Slides" plain (function org-roam-capture--get-point)
               "%?"
               :file-name "docs/slides/${slug}"
               :unnarrowed t
               :head
"
,#+TITLE: ${title}
,#+AUTHOR: Christopher James Hayward
,#+EMAIL: chris@chrishayward.xyz

,#+REVEAL_ROOT: https://cdn.jsdelivr.net/npm/reveal.js
,#+REVEAL_THEME: serif

,#+EXPORT_FILE_NAME: ${slug}

,#+OPTIONS: reveal_title_slide:nil
,#+OPTIONS: num:nil toc:nil todo:nil tasks:nil tags:nil
,#+OPTIONS: skip:nil author:nil email:nil creator:nil timestamp:nil
"))

Passwords

pkgs.pass

With Pass⁶⁰, each password lives inside of an encrypted gpg file, whose name is the title of the website or resource that requires the password. These encrypted files may be organized into meaningful folder hierarchies, compies from computer to computer, and in general, manipulated using standard command line tools.

epkgs.password-store

Configure keybindings for passwords behind SPC p:

Key	Description
p	Copy a password
r	Rename a password
g	Generate a password

;; Set the path to the password store.
(setq password-store-dir (expand-file-name "~/.password-store"))

;; Apply custom keybindings.
(dotfiles/leader
  "p" '(:ignore t :which-key "Passwords")
  "pp" '(password-store-copy :which-key "Copy")
  "pr" '(password-store-rename :which-key "Rename")
  "pg" '(password-store-generate :which-key "Generate"))

MU4E

pkgs.mu
pkgs.isync

epkgs.mu4e-alert

home.file.".mbsyncrc" = {
  text = ''
    IMAPStore xyz-remote
    Host mail.chrishayward.xyz
    User chris@chrishayward.xyz
    PassCmd "pass chrishayward.xyz/chris"
    SSLType IMAPS
    
    MaildirStore xyz-local
    Path ~/.cache/mail/
    Inbox ~/.cache/mail/inbox
    SubFolders Verbatim
    
    Channel xyz
    Far :xyz-remote:
    Near :xyz-local:
    Patterns * !Archives
    Create Both
    Expunge Both
    SyncState *
  '';
};

mbsync -a
mu init --maildir="~/.cache/mail" --my-address="chris@chrishayward.xyz"
mu index

;; Add the `mu4e' shipped with `mu' to the load path.
(add-to-list 'load-path "/etc/profiles/per-user/chris/share/emacs/site-lisp/mu4e/")
(require 'mu4e)

;; Confiugure `mu4e'.
(setq mu4e-maildir "~/.cache/mail"
      mu4e-update-interval (* 5 60)
      mu4e-get-mail-command "mbsync -a"
      mu4e-compose-format-flowed t
      mu4e-change-filenames-when-moving t
      mu4e-compose-signature (concat "Chris Hayward\n"
                                     "chris@chrishayward.xyz"))

;; Sign all outbound email with GPG.
(add-hook 'message-send-hook 'mml-secure-message-sign-pgpmime)
(setq message-send-mail-function 'smtpmail-send-it
      mml-secure-openpgp-signers '("37AB1CB72B741E478CA026D43025DCBD46F81C0F"))

;; Setup `mu4e' accounts.
(setq mu4e-contexts
  (list
    ;; Main
    ;; chris@chrishayward.xyz
    (make-mu4e-context
      :name "Main"
      :match-func
        (lambda (msg)
          (when msg
            (string-prefix-p "/Main" (mu4e-message-field msg :maildir))))
      :vars
        '((user-full-name . "Christopher James Hayward")
          (user-mail-address . "chris@chrishayward.xyz")
          (smtpmail-smtp-server . "mail.chrishayward.xyz")
          (smtpmail-smtp-service . 587)
          (smtpmail-stream-type . starttls)))))

;; Setup `mu4e-alert'.
(setq mu4e-alert-set-default-style 'libnotify)
(mu4e-alert-enable-notifications)
(mu4e-alert-enable-mode-line-display)

;; Open the `mu4e' dashboard.
(dotfiles/leader
  "m" '(mu4e :which-key "Mail"))

Projectile

epkgs.projectile

Projectile⁶¹ is a project interaction library for GNU/Emacs². Its goal is to provide a nice set of features operating on a project level, without introducing external dependencies.

;; Configure the `projectile-project-search-path'.
(setq projectile-project-search-path '("~/.local/source"))
(projectile-mode +1)

LSP Mode

epkgs.lsp-mode
epkgs.lsp-ui

The Language Server Protocol (LSP)⁶² defines the protocol used between an Editor or IDE, and a language server that provides features like:

• Auto Complete

• Go To Defintion

• Find All References

;; Configure `lsp-mode'.
(setq lsp-idle-delay 0.5
      lsp-prefer-flymake t)

;; Configure `lsp-ui'.
(setq lsp-ui-doc-position 'at-point
      lsp-ui-doc-delay 0.5)

Company Mode

epkgs.company

Company⁶³ is a text completion framework for GNU/Emacs². The name stands for Complete Anything. It uses pluggable back-ends and front-ends to retieve and display completion candidates.

;; Configure `company-mode'.
(setq company-backend 'company-capf
      lsp-completion-provider :capf)

;; Enable it globally.
(global-company-mode +1)

Go Mode

epkgs.go-mode

Go Mode⁶⁴ is a major mode for editing Golang¹⁶ source code in GNU/Emacs².

;; Configure `go-mode' to work with `lsp-mode'.
(defun dotfiles/go-hook ()
  (add-hook 'before-save-hook #'lsp-format-buffer t t)
  (add-hook 'before-save-hook #'lsp-organize-imports t t))

;; Configure a custom `before-save-hook'.
(add-hook 'go-mode-hook #'dotfiles/go-hook)

Python Mode

epkgs.pretty-mode

The built in Python Mode⁶⁵ has a nice feature set for working with Python²⁰ code in GNU/Emacs². It is complimented with the addition of an LSP⁶² server. These tools are included in the Development Shell¹⁵ for Python²⁰.

;; Configure `pretty-mode' to work with `python-mode'.
(add-hook 'python-mode-hook
  (lambda ()
    (turn-on-pretty-mode)))

PlantUML

pkgs.plantuml

PlantUML⁶⁶ is an open-source tool allowing users to create diagrams from a plain-text language. Besides various UML diagrams, PlantUML⁶⁶ has support for various other software developmented related formats, as well as visualizations of JSON and YAML files.

epkgs.plantuml-mode

PlantUML Mode⁶⁷ is a major mode for editing PlantUML⁶⁶ sources in GNU/Emacs².

;; Configure `plantuml-mode'.
(setq plantuml-default-exec-mode 'executable)

Swiper

epkgs.ivy
epkgs.counsel
epkgs.ivy-rich
epkgs.ivy-posframe
epkgs.ivy-prescient

Ivy (Swiper)⁶⁸ is a generic completion mechanism for GNU/Emacs². While operating similarily to other completion schemes like icomplete-mode, it aims to be more efficient, smaller, simpler, and smoother to use, while remaining highly customizable.

;; Configure `ivy'.
(setq counsel-linux-app-format-function
  #'counsel-linux-app-format-function-name-only)
(ivy-mode +1)
(counsel-mode +1)

;; Configure `ivy-rich'.
(ivy-rich-mode +1)

;; Configure `ivy-posframe'.
(setq ivy-posframe-parameters '((parent-frame nil))
      ivy-posframe-display-functions-alist '((t . ivy-posframe-display)))
(ivy-posframe-mode +1)

;; Configure `ivy-prescient'.
(setq ivy-prescient-enable-filtering nil)
(ivy-prescient-mode +1)

Transparency

It's possible to control the frame opacity in GNU/Emacs². Unlike other transparency hacks, it's not merely showing the desktop background image, but is true transparency – you can se other windows behind the Emacs² window.

;; Configure the default frame transparency.
(set-frame-parameter (selected-frame) 'alpha '(95 . 95))
(add-to-list 'default-frame-alist '(alpha . (95 . 95)))

Doom Themes

epkgs.doom-themes

Doom Themes⁶⁹ is a theme megapack for GNU/Emacs², inspired by community favourites.

;; Include modern themes from `doom-themes'.
(setq doom-themes-enable-bold t
      doom-themes-enable-italic t)

;; Load the `doom-moonlight' theme.
(load-theme 'doom-moonlight t)
(doom-modeline-mode +1)

;; Load a new theme with <SPC> t t.
(dotfiles/leader
  "tt" '(counsel-load-theme :which-key "Theme"))

Doom Modeline

epkgs.doom-modeline

Doom Modeline⁷⁰ is a fancy and fast modeline inspired by minimalism design. It's integrated into Centaur Emacs, Doom Emacs, and Spacemacs.

;; Add the `doom-modeline' after initialization.
(add-hook 'after-init-hook 'doom-modeline-mode)
(setq doom-modeline-height 16
      doom-modeline-icon t)

Footnotes

---

¹

https://gnu.org

²

https://gnu.org/software/emacs/

³

https://literateprogramming.com/knuthweb.pdf

⁴

https://nixos.org/manual/nixos/stable

⁵

https://nixos.org/manual/nix/stable

⁶

https://nixos.org/manual/nixpkgs/stable

⁷

https://github.com/nix-community/home-manager

⁸

https://github.com/nix-community/emacs-overlay

⁹

https://github.com/nixos/nixos-hardware

¹⁰

https://github.com/t184256/nix-on-droid

¹¹

https://qemu.org

¹²

https://github.com/ch11ng/exwm

¹³

https://evil.readthedocs.io/en/latest/overview.html

¹⁴

https://samsung.com/us/mobile/galaxy-s10/buy/

¹⁵

https://nixos.org/manual/nix/unstable/command-ref/nix-shell.html

¹⁶

https://golang.org

¹⁷

https://grpc.io

¹⁸

https://iso.org/standard/74528.html

¹⁹

https://en.wikipedia.org/wiki/C++

²⁰

https://python.org

²¹

https://x.org/wiki/

²²

https://wayland.freedesktop.org

²³

https://nixos.wiki/wiki/Flakes

²⁴

https://nix-community.cachix.org

²⁵

https://en.wikipedia.org/wiki/Firefox

²⁶

https://moonlight-stream.org

²⁷

https://teamviewer.com

²⁸

https://git-scm.com

²⁹

https://emacswiki.org/emacs/LearnEmacsLisp

³⁰

https://neovim.io

³¹

https://gtk.org

³²

https://github.com/nixos/nix-mode

³³

https://github.com/noctuid/general.el

³⁴

https://github.com/justbur/emacs-which-key

³⁵

https://emacswiki.org/emacs/eww

³⁶

https://emacswiki.org/emacs/DiredMode

³⁷

https://emacswiki.org/emacs/DiredExtra#Dired_X

³⁸

https://github.com/domtronn/all-the-icons.el

³⁹

https://github.com/iqbalansari/emacs-emojify

⁴⁰

https://gnu.org/software/emacs/manual/html_mono/eshell.html

⁴¹

https://github.com/akermu/emacs-libvterm

⁴²

https://github.com/neovim/libvterm

⁴³

https://magit.vc

⁴⁴

https://github.com/skeeto/elfeed

⁴⁵

https://orgmode.org

⁴⁶

https://github.com/org-roam/org-roam

⁴⁷

https://zettelkasten.de

⁴⁸

https://github.com/org-roam/org-roam-server

⁴⁹

https://orgmode.org/worg/org-contrib/org-drill.html

⁵⁰

https://marcinkoziej/org-pomodoro

⁵¹

https://en.wikipedia.org/wiki/Pomodoro_Technique

⁵²

https://github.com/bnbeckwith/writegood-mode

⁵³

https://aspell.net

⁵⁴

https://gohugo.io

⁵⁵

https://oxhugo.scripter.co

⁵⁶

https://chrishayward.xyz/posts/

⁵⁷

https://chrishayward.xyz/notes/

⁵⁸

https://revealjs.com

⁵⁹

https://github.com/hexmode/ox-reveal

⁶⁰

https://password-store.org

⁶¹

https://projectile.mx

⁶²

https://microsoft.github.io/language-server-protocol

⁶³

https://company-mode.github.io

⁶⁴

https://emacswiki.org/emacs/GoMode

⁶⁵

https://emacswiki.org/emacs/PythonProgrammingInEmacs

⁶⁶

https://plantuml.com

⁶⁷

https://github.com/skuro/plantuml-mode

⁶⁸

https://github.com/abo-abo/swiper

⁶⁹

https://github.com/hlissner/emacs-doom-themes

⁷⁰

https://github.com/seagle0128/doom-modeline