Examples for Emacs Twist

This repository is a collection of examples that wraps Emacs configurations using Emacs Twist. It is provided as a Nix flake with packages sandboxed with bubblewrap. This means you can try out configurations without installation on Linux. For Mac, you need to install configurations somehow.

Disclaimer: I am not going to maintain these profiles forever. I use this repository as a testbed for the library, and configurations in this repository are likely to be outdated. Also, the original authors of the configurations are not directly related to this project. Please contact me or create a ticket if you have found any issue with the use.

Bug reports are welcome. Please feel free to file an issue.

Trying out

Nix 2.9 is required. If you are using Linux, you can try out configs inside a sandbox.

Note: The sandboxing script temporarily creates ~/.emacs.d inside its namespace. If you have your Emacs configuration in ~/.config/emacs/ (or ${XDG_CONFIG_HOME}/emacs), it may leave an empty ~/.emacs.d directory. Please remove the directory after the sandboxed session finishes.

You may encounter build errors. Twist byte-compiles every package, so it is considered strict on grammatical mistakes. If one of the configurations fails to build, it is more likely to be an upstream issue. Please file a report to its corresponding repository.

To run terlar/emacs-config inside a sandbox:

nix run github:emacs-twist/examples#terlar.sandboxed

Run scimax inside a sandbox:

nix run github:emacs-twist/examples#scimax.sandboxed

Development

Before you run these operations, it is better to generate a personal token on GitHub and add it to ~/.config/nix/nix.conf:

access-tokens = github.com=ghp_XXXXXX

Update the lock file:

nix run .#lock-terlar --impure

Update ELPA packages:

nix run .#update-terlar --impure

Replace terlar with a profile name.

lib/inputs.nix defines input overrides, and lib/profile.nix defines build overrides. Specific profiles are defined in profiles directory.