#+TITLE: Personal DOOM Emacs Configuration #+AUTHOR: Sravan Balaji #+AUTO_TANGLE: t #+STARTUP: showeverything * Table of Contents :TOC_3:noexport: - [[#welcome][Welcome]] - [[#configuration-files][Configuration Files]] - [[#initel][init.el]] - [[#input][Input]] - [[#completion][Completion]] - [[#user-interface][User Interface]] - [[#editor][Editor]] - [[#emacs][Emacs]] - [[#terminal][Terminal]] - [[#checkers][Checkers]] - [[#tools][Tools]] - [[#os][OS]] - [[#languages][Languages]] - [[#email][Email]] - [[#apps][Apps]] - [[#config][Config]] - [[#configel][config.el]] - [[#user-configuration][User Configuration]] - [[#user-interface-1][User Interface]] - [[#org-mode][Org Mode]] - [[#projectile][Projectile]] - [[#prettier-formatter][Prettier Formatter]] - [[#file-extension-mode-association][File Extension Mode Association]] - [[#packagesel][packages.el]] - [[#packages][Packages]] * Welcome My personal configuration of [[https://github.com/hlissner/doom-emacs][DOOM Emacs]], written as an [[https://orgmode.org][Org Mode]] document. * Configuration Files ** init.el This file controls which Doom modules are enabled and what order they load in. Remember to run =doom sync= after modifying it! #+BEGIN_SRC emacs-lisp :tangle init.el ;;; init.el -*- lexical-binding: t; -*- #+END_SRC *NOTE* Press =SPC h d h= (or =C-h d h= for non-vim users) to access Doom's documentation. There you'll find a "Module Index" link where you'll find a comprehensive list of Doom's modules and what flags they support. *NOTE* Move your cursor over a module's name (or its flags) and press =K= (or =C-c c k= for non-vim users) to view its documentation. This works on flags as well (those symbols that start with a plus). Alternatively, press =gd= (or =C-c c d=) on a module to browse its directory (for easy access to its source code). *** Input #+BEGIN_SRC emacs-lisp :tangle init.el (doom! :input ;;chinese ;;japanese ;;layout ; auie,ctsrnm is the superior home row #+END_SRC *** Completion #+BEGIN_SRC emacs-lisp :tangle init.el :completion company ; the ultimate code completion backend ;;helm ; the *other* search engine for love and life ;;ido ; the other *other* search engine... ;;ivy ; a search engine for love and life vertico ; the search engine of the future #+END_SRC *** User Interface #+BEGIN_SRC emacs-lisp :tangle init.el :ui ;;deft ; notational velocity for Emacs doom ; what makes DOOM look the way it does doom-dashboard ; a nifty splash screen for Emacs doom-quit ; DOOM quit-message prompts when you quit Emacs ;;(emoji +unicode) ; 🙂 hl-todo ; highlight TODO/FIXME/NOTE/DEPRECATED/HACK/REVIEW ;;hydra indent-guides ; highlighted indent columns ligatures ; ligatures and symbols to make your code pretty again ;;minimap ; show a map of the code on the side modeline ; snazzy, Atom-inspired modeline, plus API nav-flash ; blink cursor line after big motions ;;neotree ; a project drawer, like NERDTree for vim ophints ; highlight the region an operation acts on (popup +defaults) ; tame sudden yet inevitable temporary windows ;;tabs ; a tab bar for Emacs treemacs ; a project drawer, like neotree but cooler ;;unicode ; extended unicode support for various languages vc-gutter ; vcs diff in the fringe vi-tilde-fringe ; fringe tildes to mark beyond EOB ;;window-select ; visually switch windows workspaces ; tab emulation, persistence & separate workspaces ;;zen ; distraction-free coding or writing #+END_SRC *** Editor #+BEGIN_SRC emacs-lisp :tangle init.el :editor (evil +everywhere); come to the dark side, we have cookies file-templates ; auto-snippets for empty files fold ; (nigh) universal code folding ;;(format +onsave) ; automated prettiness ;;god ; run Emacs commands without modifier keys ;;lispy ; vim for lisp, for people who don't like vim multiple-cursors ; editing in many places at once ;;objed ; text object editing for the innocent ;;parinfer ; turn lisp into python, sort of ;;rotate-text ; cycle region at point between text candidates snippets ; my elves. They type so I don't have to word-wrap ; soft wrapping with language-aware indent #+END_SRC *** Emacs #+BEGIN_SRC emacs-lisp :tangle init.el :emacs dired ; making dired pretty [functional] electric ; smarter, keyword-based electric-indent ;;ibuffer ; interactive buffer management undo ; persistent, smarter undo for your inevitable mistakes vc ; version-control and Emacs, sitting in a tree #+END_SRC *** Terminal #+BEGIN_SRC emacs-lisp :tangle init.el :term eshell ; the elisp shell that works everywhere ;;shell ; simple shell REPL for Emacs ;;term ; basic terminal emulator for Emacs vterm ; the best terminal emulation in Emacs #+END_SRC *** Checkers #+BEGIN_SRC emacs-lisp :tangle init.el :checkers syntax ; tasing you for every semicolon you forget (spell +flyspell) ; tasing you for misspelling mispelling grammar ; tasing grammar mistake every you make #+END_SRC *** Tools #+BEGIN_SRC emacs-lisp :tangle init.el :tools ;;ansible ;;debugger ; FIXME stepping through code, to help you add bugs ;;direnv ;;docker ;;editorconfig ; let someone else argue about tabs vs spaces ein ; tame Jupyter notebooks with emacs (eval +overlay) ; run code, run (also, repls) ;;gist ; interacting with github gists lookup ; navigate your code and its documentation lsp ; M-x vscode magit ; a git porcelain for Emacs make ; run make tasks from Emacs ;;pass ; password manager for nerds pdf ; pdf enhancements ;;prodigy ; FIXME managing external services & code builders rgb ; creating color strings ;;taskrunner ; taskrunner for all your projects ;;terraform ; infrastructure as code ;;tmux ; an API for interacting with tmux ;;upload ; map local to remote projects via ssh/ftp #+END_SRC *** OS #+BEGIN_SRC emacs-lisp :tangle init.el :os (:if IS-MAC macos) ; improve compatibility with macOS tty ; improve the terminal Emacs experience #+END_SRC *** Languages #+BEGIN_SRC emacs-lisp :tangle init.el :lang ;;agda ; types of types of types of types... ;;beancount ; mind the GAAP (cc +lsp) ; C > C++ == 1 ;;clojure ; java with a lisp ;;common-lisp ; if you've seen one lisp, you've seen them all ;;coq ; proofs-as-programs ;;crystal ; ruby at the speed of c ;;csharp ; unity, .NET, and mono shenanigans data ; config/data formats ;;(dart +flutter) ; paint ui and not much else ;;dhall ;;elixir ; erlang done right ;;elm ; care for a cup of TEA? emacs-lisp ; drown in parentheses ;;erlang ; an elegant language for a more civilized age ;;ess ; emacs speaks statistics ;;factor ;;faust ; dsp, but you get to keep your soul ;;fsharp ; ML stands for Microsoft's Language ;;fstar ; (dependent) types and (monadic) effects and Z3 ;;gdscript ; the language you waited for ;;(go +lsp) ; the hipster dialect (haskell +dante) ; a language that's lazier than I am ;;hy ; readability of scheme w/ speed of python ;;idris ; a language you can depend on json ; At least it ain't XML ;;(java +meghanada) ; the poster child for carpal tunnel syndrome (javascript +lsp) ; all(hope(abandon(ye(who(enter(here)))))) (julia +lsp) ; a better, faster MATLAB ;;kotlin ; a better, slicker Java(Script) latex ; writing papers in Emacs has never been so fun ;;lean ; for folks with too much to prove ;;ledger ; be audit you can be ;;lua ; one-based indices? one-based indices markdown ; writing docs for people to ignore ;;nim ; python + lisp at the speed of c ;;nix ; I hereby declare "nix geht mehr!" ;;ocaml ; an objective camel org ; organize your plain life in plain text ;;php ; perl's insecure younger brother ;;plantuml ; diagrams for confusing people more ;;purescript ; javascript, but functional (python +lsp) ; beautiful is better than ugly ;;qt ; the 'cutest' gui framework ever ;;racket ; a DSL for DSLs ;;raku ; the artist formerly known as perl6 ;;rest ; Emacs as a REST client ;;rst ; ReST in peace ;;(ruby +rails) ; 1.step {|i| p "Ruby is #{i.even? ? 'love' : 'life'}"} ;;rust ; Fe2O3.unwrap().unwrap().unwrap().unwrap() ;;scala ; java, but good ;;(scheme +guile) ; a fully conniving family of lisps (sh +lsp) ; she sells {ba,z,fi}sh shells on the C xor ;;sml ;;solidity ; do you need a blockchain? No. ;;swift ; who asked for emoji variables? ;;terra ; Earth and Moon in alignment for performance. (web +lsp) ; the tubes yaml ; JSON, but readable ;;zig ; C, but simpler #+END_SRC *** Email #+BEGIN_SRC emacs-lisp :tangle init.el :email ;;(mu4e +org +gmail) ;;notmuch ;;(wanderlust +gmail) #+END_SRC *** Apps #+BEGIN_SRC emacs-lisp :tangle init.el :app ;;calendar ;;emms ;;everywhere ; *leave* Emacs!? You must be joking ;;irc ; how neckbeards socialize ;;(rss +org) ; emacs as an RSS reader ;;twitter ; twitter client https://twitter.com/vnought #+END_SRC *** Config #+BEGIN_SRC emacs-lisp :tangle init.el :config ;;literate (default +bindings +smartparens)) #+END_SRC ** config.el Place your private configuration here! Remember, you do not need to run =doom sync= after modifying this file! Here are some additional functions/macros that could help you configure Doom: - =load!= for loading external *.el files relative to this one - =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. You can also try =gd= (or =C-c c d=) to jump to their definition and see how they are implemented. #+BEGIN_SRC emacs-lisp :tangle config.el ;;; $DOOMDIR/config.el -*- lexical-binding: t; -*- #+END_SRC *** User Configuration Some functionality uses this to identify you, e.g. GPG configuration, email clients, file templates and snippets. #+BEGIN_SRC emacs-lisp :tangle config.el (setq user-full-name "Sravan Balaji") #+END_SRC *** User Interface **** Fonts Doom exposes five (optional) variables for controlling fonts in Doom. Here are the three important ones: - =doom-font= - =doom-variable-pitch-font= - =doom-big-font= -- used for =doom-big-font-mode=; use this for presentations or streaming. They all accept either a font-spec, font string ("Input Mono-12"), or xlfd font string. You generally only need these two: #+BEGIN_EXAMPLE (setq doom-font (font-spec :family "monospace" :size 12 :weight 'semi-light) doom-variable-pitch-font (font-spec :family "sans" :size 13)) #+END_EXAMPLE Set regular, variable pitch, and big fonts. #+BEGIN_SRC emacs-lisp :tangle config.el (setq doom-font (font-spec :family "VictorMono Nerd Font Mono" :size 14) doom-variable-pitch-font (font-spec :family "Cantarell" :size 14) doom-big-font (font-spec :family "sb/source-code-font" :size 24)) #+END_SRC Enable *bold* and /italic/ text. #+BEGIN_SRC emacs-lisp :tangle config.el (after! doom-themes (setq doom-themes-enable-bold t doom-themes-enable-italic t)) #+END_SRC Make comments and keywords /italicized/. #+BEGIN_SRC emacs-lisp :tangle config.el (custom-set-faces! '(font-lock-comment-face :slant italic) '(font-lock-keyword-face :slant italic)) #+END_SRC **** Theme 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. #+BEGIN_SRC emacs-lisp :tangle config.el (setq doom-theme 'doom-dracula) #+END_SRC **** Opacity #+BEGIN_SRC emacs-lisp :tangle config.el (doom/set-frame-opacity 95) #+END_SRC **** Line Numbers 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=. #+BEGIN_SRC emacs-lisp :tangle config.el (setq display-line-numbers-type t) #+END_SRC **** Tab Width #+BEGIN_SRC emacs-lisp :tangle config.el (setq-default tab-width 4) #+END_SRC **** Highlight Indent Guides #+BEGIN_SRC emacs-lisp :tangle config.el (setq highlight-indent-guides-method 'fill) (setq highlight-indent-guides-responsive 'stack) (setq highlight-indent-guides-delay 0) #+END_SRC *** Org Mode If you use =org= and don't want your org files in the default location below, change =org-directory=. It must be set before org loads! **** Directory #+BEGIN_SRC emacs-lisp :tangle config.el (setq org-directory "~/org/") #+END_SRC **** Auto Tangle #+BEGIN_SRC emacs-lisp :tangle config.el (use-package! org-auto-tangle :defer t :hook (org-mode . org-auto-tangle-mode) :config (setq org-auto-tangle-default t) ) #+END_SRC **** Source Code Indentation #+BEGIN_SRC emacs-lisp :tangle config.el (setq org-src-preserve-indentation nil org-edit-src-content-indentation 0) #+END_SRC **** Hide Emphasis Markers #+BEGIN_SRC emacs-lisp :tangle config.el (setq org-hide-emphasis-markers t) #+END_SRC *** Projectile #+BEGIN_SRC emacs-lisp :tangle config.el (setq projectile-project-search-path '("~/Projects/" "~/.config/")) #+END_SRC *** Prettier Formatter #+BEGIN_SRC emacs-lisp :tangle config.el (add-hook! 'web-mode-hook 'prettier-js-mode) #+END_SRC *** File Extension Mode Association #+BEGIN_SRC emacs-lisp :tangle config.el (add-to-list 'auto-mode-alist '("\\.m\\'" . octave-mode)) #+END_SRC ** packages.el To install a package with Doom you must declare them here and run =doom sync= on the command line, then restart Emacs for the changes to take effect -- or use =M-x doom/reload=. To install SOME-PACKAGE from MELPA, ELPA or emacsmirror: #+BEGIN_EXAMPLE (package! some-package) #+END_EXAMPLE To install a package directly from a remote git repo, you must specify a =:recipe=. You'll find documentation on what =:recipe= accepts here: https://github.com/raxod502/straight.el#the-recipe-format #+BEGIN_EXAMPLE (package! another-package :recipe (:host github :repo "username/repo")) #+END_EXAMPLE If the package you are trying to install does not contain a PACKAGENAME.el file, or is located in a subdirectory of the repo, you'll need to specify =:files= in the =:recipe=: #+BEGIN_EXAMPLE (package! this-package :recipe (:host github :repo "username/repo" :files ("some-file.el" "src/lisp/*.el"))) #+END_EXAMPLE If you'd like to disable a package included with Doom, you can do so here with the =:disable= property: #+BEGIN_EXAMPLE (package! builtin-package :disable t) #+END_EXAMPLE You can override the recipe of a built in package without having to specify all the properties for =:recipe=. These will inherit the rest of its recipe from Doom or MELPA/ELPA/Emacsmirror: #+BEGIN_EXAMPLE (package! builtin-package :recipe (:nonrecursive t)) (package! builtin-package-2 :recipe (:repo "myfork/package")) #+END_EXAMPLE Specify a =:branch= to install a package from a particular branch or tag. This is required for some packages whose default branch isn't =master= (which our package manager can't deal with; see raxod502/straight.el#279) #+BEGIN_EXAMPLE (package! builtin-package :recipe (:branch "develop")) #+END_EXAMPLE Use =:pin= to specify a particular commit to install. #+BEGIN_EXAMPLE (package! builtin-package :pin "1a2b3c4d5e") #+END_EXAMPLE Doom's packages are pinned to a specific commit and updated from release to release. The =unpin!= macro allows you to unpin single packages... #+BEGIN_EXAMPLE (unpin! pinned-package) #+END_EXAMPLE ...or multiple packages #+BEGIN_EXAMPLE ;(unpin! pinned-package another-pinned-package) #+END_EXAMPLE ...Or *all* packages (NOT RECOMMENDED; will likely break things) #+BEGIN_EXAMPLE ;(unpin! t) #+END_EXAMPLE #+BEGIN_SRC emacs-lisp :tangle packages.el ;; -*- no-byte-compile: t; -*- ;;; $DOOMDIR/packages.el #+END_SRC *** Packages #+BEGIN_SRC emacs-lisp :tangle packages.el (package! org-auto-tangle) (package! fish-mode) (package! gitattributes-mode) (package! gitconfig-mode) (package! gitignore-mode) (package! vimrc-mode) (package! prettier-js) #+END_SRC