emacs.d

The Emacs configuration directory.

Place this directory so that Emacs can find the init.el file. The auxiliary scripts used by Emacs is placed under the bin/ directory.

Convention

straight-use-package

The init.el is organized using use-package with straight.

Initializing a built-in package

Use :straight nil to avoid pulling the source:

(use-package builtin-package
  :straight nil
  …)

Use of init-loader

Package initialization files are in the lisp/ directory. The files actually loaded are symlinked in the init.d directory and loaded by the init-loader package. The files are sorted by file name and loaded in that order.

Run

init.d/symlinks.sh

to create symlinks under the init.d/ directory.

Key bindings

See the Key Binding Conventions section of the GNU Emacs Lisp Reference Manual.

Improving startup time

In Linux systems, the startup time for this Emacs initialization takes 1.5 - 2.0 seconds.

The find-at-startup option is removed from straight-check-for-modifications; see lisp/traight-use-package.el for caveat.

While the init.el in this repository is written primarily with readability and maintainability in mind, it pays well to be aware of improvement we can make with the startup time.

• Emacs の起動時間を”“詰める”” | Emacs JP
• Emacs の起動時間を”“詰める”” (free book version)

Packages to check out

• deadgrep
  • Fast, friendly searching with ripgrep and Emacs
  • See ALTERNATIVES.md for a good summary of alternative tools
• emr (Emacs Refactor)
  • A framework for providing language-specific refactoring
• iwindow
  • Interactively manipulate windows
• llm
  • A package abstracting llm capabilities
• migemo
  • Provides incremental search with romanized Japanese
• org-super-agenda
  • Supercharge your Org daily/weekly agenda by grouping items
• password-store
  • Allows pass integration for managing credentials
• reverse-im.el
  • Overrides function-key-map for preferred input method(s) to translate input sequences to English, so we can use emacs binding while a non-default system layout is active
• selected-window-accent-mode
  • Accentuate the active window
• symbols-outline.el
  • Display symbols (functions, variables, etc) in a side window.
• textsize
  • Automatically choose a font point size for the Emacs default face based on the size and pixel pitch of the display
• vlf
  • View large files

init.el repositories

Over the years, my Emacs init.el has been inspired by numerous sources, some of which are listed here in no particular order:

• https://github.com/abougouffa/minemacs
  • See docs/EXTERNAL-TOOLS.md
• https://github.com/freetonik/emacs-dotfiles/blob/master/init.el
• https://github.com/jamescherti/minimal-emacs.d
• https://github.com/kwpav/dotfiles/blob/master/emacs.org
• https://github.com/progfolio/.emacs.d/
• https://github.com/purcell/emacs.d
• https://github.com/trev-dev/emacs
• https://github.com/vedang/emacs-up
• https://gitlab.com/nathanfurnal/dotemacs/-/blob/master/init.el
• https://protesilaos.com/emacs/dotemacs
• https://sachachua.com/dotemacs/index.html
• https://takaxp.github.io/init.html
• axyz/early-init.el
• The reading-init-el channel at emacs-jp.slack.com