Doom Emacs Configuration

This is my Doom Emacs configuration. To update the configuration file at ./.doom.d/config.el, modify this file and use M-x org-babel-tangle to send the code blocks here to the configuration file.

Whenever you reconfigure a package, make sure to wrap your config in an after! block, otherwise Doom’s defaults may override your settings. For example,

(after! PACKAGE
  (setq x y))
  

The exceptions to this rule:

• Setting file/directory variables (like org-directory)
• Setting variables which explicitly tell you to set them before their package is loaded (see C-h v VARIABLE to look up their documentation).
• Setting doom variables (which start with doom- or +).

Here are some additional functions/macros that will help you configure Doom:

• load! for loading external *.el files relative to ~/.doom.d/config.el
• use-package! for configuring packages
• after! for running code after a package has loaded
• add-load-path! for adding directories to the load-path, relative to this file. Emacs searches the load-path when you load packages with require or use-package.
• map! for binding new keys

To get information about any of these functions/macros, move the cursor over the highlighted symbol at press ’K’ (non-evil users must press C-c c k). This will open documentation for it, including demos of how they are used. Alternatively, use C-h o to look up a symbol (functions, variables, faces, etc). You can also try gd (or C-c c d) to jump to their definition and see how they are implemented.

This must be at the top of the config file to enable lexical binding for Emacs.

;;; $DOOMDIR/config.el -*- lexical-binding: t; -*-

;; This is your private configuration file! Changes to this file should be made 
;; using the Org file ~/.dotfiles/doom-emacs.org. Remember, you do not need to
;; run 'doom sync' after modifying this file!

Some functionality uses this to identify you, e.g. GPG configuration, email clients, file templates and snippets. It is optional.

;; Specify user information
(setq user-full-name "J. Dylan White"
      user-mail-address "jdylanwhite5@gmail.com")

Doom exposes five (optional) variables for controlling fonts in Doom:

• doom-font: the primary font to use
• doom-variable-pitch-font: a non-monospace font (where applicable)
• doom-big-font: used for `doom-big-font-mode’; use this for presentations or streaming.
• doom-unicode-font: for unicode glyphs
• doom-serif-font: for the `fixed-pitch-serif’ face

See C-h v doom-font for documentation and more examples of what they accept. If you or Emacs can’t find your font, use M-x describe-font to look them up, M-x eval-region to execute elisp code, and M-x doom/reload-font to refresh your font settings. If Emacs still can’t find your font, it likely wasn’t installed correctly. Font issues are rarely Doom issues!

;; Set the doom themes
(setq doom-font "Fira Code Retina-11")
(setq doom-unicode-font "Fira Code Retina-11")
(setq doom-variable-pitch-font "Fira Sans 12")

There are two ways to load a theme. Both assume the theme is installed and available. You can either set doom-theme or manually load a theme with the load-theme function.

;; Set the theme of doom
(setq doom-theme 'doom-gruvbox)

doom-tomorrow-night

;; Add frame transparency
;; (add-to-list 'default-frame-alist '(alpha . 90))

;; Disable line numbers for some modes
(dolist (mode '(org-mode-hook
                term-mode-hook
                shell-mode-hook
                treemacs-mode-hook
                eshell-mode-hook))
  (add-hook mode (lambda () (display-line-numbers-mode 0))))

;; This determines the style of line numbers in effect. If set to `nil', line
;; numbers are disabled. For relative line numbers, set this to `relative'.
(setq display-line-numbers-type t)


;; Hide icons from the modeline
;; I was ultimately able to get icons to show up by running M-x and
;; nerd-icons-install-fonts and all-the-icons-install-fonts
;; (setq doom-modeline-icon nil)

;; Point to the location of Org Mode files
(setq org-directory "~/Documents/Org/")

;; Configure Org
(after! org
  (setq

    ;; Specify where to load org agenda
    org-agenda-files '("~/Documents/Org")

    ;; Default file for notes
    org-default-notes-file (expand-file-name "notes.org" org-directory)

    ;; Change how some symbols appear
    org-ellipsis " ▼ "
    org-superstar-headline-bullets-list '("◉" "●" "○" "◆" "●" "○" "◆")
    org-superstar-item-bullet-alist '((?+ . ?➤) (?- . ?✦)) ; changes +/- symbols in item lists
    org-hide-emphasis-markers 1

    ;; Add timestamp to org DONE entries
    org-log-done 'time

    ;; Upper bound to table conversions, useful for babel results
    org-table-convert-region-max-lines 20000

    ;; Set up to do keywords
    org-todo-keywords        ; This overwrites the default Doom org-todo-keywords
      '((sequence
         "TODO(t)"           ; A task that is ready to be tackled
         "PROJ(p)"           ; A project that contains other tasks
         "WAIT(w)"           ; Something is holding up this task
         "|"                 ; The pipe necessary to separate "active" states and "inactive" states
         "DONE(d)"           ; Task has been completed
         "CANCELLED(c)" ))   ; Task has been cancelled

    ;; Customize tags
    org-tag-alist
      '((:startgroup)
       ; Put mutually exclusive tags here
       (:endgroup)
       ("@errand" . ?E)
       ("@home" . ?H)
       ("@work" . ?W)
       ("agenda" . ?a)
       ("planning" . ?p)
       ("publish" . ?P)
       ("batch" . ?b)
       ("note" . ?n)
       ("music" .?m)
       ("game" .?g)
       ("chore" .?c)
       ("idea" . ?i))

    ;; Only one space after a tag
    org-tags-column 0

    ;; Some basic UI flags
    org-src-fontify-natively t
    org-src-tab-acts-natively t
    org-confirm-babel-evaluate nil
    org-edit-src-content-indentation 0))

We use visual-fill-column to center org-mode buffers for a more pleasing writing experience as it centers the contents of the buffer horizontally to seem more like you are editing a document. This is really a matter of personal preference so you can remove the block below if you don’t like the behavior.

;; ;; Specify visual-fill centering settings
;; (defun my/org-mode-visual-fill ()
;;   (setq visual-fill-column-width 100
;;         visual-fill-column-center-text t)
;;   visual-fill-column-mode 1)

;; ;; Use visual-fill-column to center org-mode buffers
;; (use-package! visual-fill-column
;;   :after org
;;   :hook (org-mode . my/org-mode-visual-fill))

Org Mode’s structure templates feature enables you to quickly insert code blocks into your Org files in combination with org-tempo by typing < followed by the template name like el or py and then press TAB. For example, to insert an empty elisp block below, you can type <el and press TAB to expand into such a block.

You can add more src block templates below by copying one of the lines and changing the two strings at the end, the first to be the template name and the second to contain the name of the language as it is known by Org Babel.

;; Apply structure templates to quickly insert code blocks in org files
(use-package! org-tempo
  :after org
  :config
  (add-to-list 'org-structure-template-alist '("sh" . "src shell"))
  (add-to-list 'org-structure-template-alist '("el" . "src elisp"))
  (add-to-list 'org-structure-template-alist '("py" . "src python"))
  (add-to-list 'org-structure-template-alist '("r" . "src R"))
  (add-to-list 'org-structure-template-alist '("lua" . "src lua")))

This snippet adds a hook to org-mode buffers so that my/org-babel-tangle-config gets executed each time such a buffer gets saved. This function checks to see if the file being saved is in the directory ~/.dotfiles/, and if so, tangles the file to the file path specified in the header arguments for the code block to tangle.

;; Automatically tangle our Emacs.org config file when we save it
(defun my/org-babel-tangle-config ()
  (when (string-equal (file-name-directory (buffer-file-name))
                      (expand-file-name "~/.dotfiles/"))

    ;; Dynamic scoping to the rescue
    (let ((org-confirm-babel-evaluate nil))
      (org-babel-tangle))))

;; Add the function after saving an org-mode file
(add-hook 'org-mode-hook (lambda () (add-hook 'after-save-hook #'my/org-babel-tangle-config)))

Org-Roam is a plain text personal knowledge management system. To use it, you must specify so in the ~/.doom.d/init.el file.

;; Set location of Org-Roam files
(setq org-roam-directory "~/Documents/org/OrgRoam")

Org-Roam-UI is a graphical front-end showing linkages for the Org-Roam files you’ve made.

;; ;; Load websocket, a dependency for Org-Roam-UI
;; (use-package! websocket
;;   :after org-roam)

;; ;; Load and configure Org-Roam-UI
;; (use-package! org-roam-ui
;;   :after org-roam
;;   :config
;;   (setq org-roam-ui-sync-theme t
;;         org-roam-ui-follow t
;;         org-roam-ui-update-on-save t
;;         org-roam-ui-open-on-start t))

I use Miniconda for my Python environment and package management. To integrate it with Emacs, we can use the conda package.

;; Configure conda
(after! conda
  (setq conda-anaconda-home (expand-file-name "~/miniconda"))
  (setq conda-env-home-directory (expand-file-name "~/miniconda/")))

Projectile is a project interaction library for Emacs.

;; Specify where to search for projects
(setq projectile-project-search-path '("~/Documents/Projects/" "~/Documents"))

;; Tangle files with org-babel-tangle
(map! :leader
      :desc "Org babel tangle" "m B" #'org-babel-tangle)

Using Emacs on WSL can be annoying. For example, opening a link while running Emacs on Linux should be as easy as C-c C-o, but of course that isn’t the case. This changes that, all thanks to this helpful post by Hung-Yi.

;; When we're using WSL, change how we open links
(when (and (eq system-type 'gnu/linux)
           (string-match
            "Linux.*Microsoft.*Linux"
            (shell-command-to-string "uname -a")))
  (setq
   browse-url-generic-program  "/mnt/c/Windows/System32/cmd.exe"
   browse-url-generic-args     '("/c" "start")
   browse-url-browser-function #'browse-url-generic))