ianpan870102 / Yay Evil Emacs

Ian's Yay-Evil Emacs: An even better 'better defaults'

Welcome!

This Emacs "distro" is based on my personal Emacs configuration. It's unopinionated and was created for general use in mind. The package settings are grouped in a logical manner, and I've documented as detailed as possible what each code snippet does in my config.org file.

You can find my opinionated personal configuration here (for macOS) and here (for WSL on Windows 10).

This Emacs config starts up super fast with an average init time of 0.7 second.

Installation

Back up your ~/.emacs.d/ first (if you have one):

mv ~/.emacs.d/ ~/.emacs.d.bak/

Git clone my configuration to your new ~/.emacs.d/ :

# For Emacs 26 and below
git clone https://github.com/ianpan870102/yay-evil-emacs.git ~/.emacs.d

# For Emacs 27
git clone https://github.com/ianpan870102/yay-evil-emacs.git ~/.config/emacs/

"Rolling" Release

I will constantly push new commits as soon as I discover new things suitable for this "distro".

How the config structure works

The init.el requires config.el, which is produced by org-babel and config.org. This allows me to put most of my configuration in an Org file with literate programming style (good for documenting code usage!).

Packages that I use:

Better package managing syntax and performance

• use-package

Vim editing habits (optional depending on your preferences)

• evil
• evil-collection
• evil-commentary
• evil-magit

Git integration

• magit

Better Emacs defaults

• company (auto-completion)
• ido-vertical-mode
• ido-completing-read+ (ido-ubiquitous)
• dashboard (welcome screen)

Org mode

• org-bullets

Friendly warnings

• flycheck

Lightweight syntax highlight improvement for all languages

• highlight-numbers
• highlight-escape-sequences

Appendix I: Themes I adore

• Gruvbox Dark
• Dracula
• Nord

If you prefer a theme pack with some of the most popular themes, I recommend the emacs-doom-themes package:

• Doom-themes package

Wilmersdorf Theme

The default installation of my Emacs configuration ships with the Wilmersdorf theme I made myself. It is inspired by Monochrome, Spacemacs Dark, Ariake Dark, and Raiju. You can find more information on my theme here.

Appendix II: Fonts I adore

• Menlo / DejaVu / Hack family (classic, default on lots of systems)
• Source Code Pro (playful and modern-looking, easy on the eyes)
• Consolas (beautifully modern)

FAQ:

1. But I'm not an Evil user

Sure! Simply delete the sections regarding Vi bindings in config.org.

2. How can I install extra packages that I want?

You should be able to install packages the normal way (M-x list-packages RET and i x on the desired package row). If you plan to sync your config files across machines, add the configuration in config.org with your preferred syntax (use-package is recommended). Yay-Evil sets all the packages :ensure to true by default, so you don't need to add :ensure t.

3. How can I remove packages that I don't need?

For this you need two steps:

• First, type M-x list-packages RET in Emacs bindings (or :list-packages RET in Evil Normal state) and delete the unwanted package by placing your cursor on the row and press d followed by an x.
• Next, in the config.org file, remove (or comment out) the relevant configuration code.