Updating Doom Emacs.

2026-08-10 01:51:15 +10:00 · 2020-06-19 22:43:40 -05:00
parent 0f664d532a
commit a5c86c514a
453 changed files with 13526 additions and 12454 deletions
@@ -18,8 +18,8 @@ It is integrated into Helpful, in Doom.
    - [[#disable-packages][disable-packages!]]
    - [[#doom][doom!]]
    - [[#file-exists-p][file-exists-p!]]
-    - [[#lambda][lambda!]]
-    - [[#lambda-1][lambda!!]]
+    - [[#cmd][cmd!]]
+    - [[#cmd-1][cmd!!]]
    - [[#letenv][letenv!]]
    - [[#load][load!]]
    - [[#map][map!]]
@@ -28,11 +28,12 @@ It is integrated into Helpful, in Doom.
    - [[#prependq][prependq!]]
    - [[#quiet][quiet!]]
    - [[#remove-hook][remove-hook!]]
+    - [[#setq][setq!]]
    - [[#setq-hook][setq-hook!]]
    - [[#unsetq-hook][unsetq-hook!]]
    - [[#use-package][use-package!]]
 - [[#interesting-snippets][Interesting snippets]]
-  - [[#persist-emacs-initial-frame-size-across-sessions][Persist Emacs' initial frame size across sessions]]
+  - [[#center-emacs-initial-frame-with-a-fixed-size][Center Emacs' initial frame with a fixed size]]
  - [[#persist-emacs-initial-frame-position-dimensions-andor-full-screen-state-across-sessions][Persist Emacs' initial frame position, dimensions and/or full-screen state across sessions]]
  - [[#update-cursor-shape-under-terminal-emacs][Update cursor shape under terminal Emacs]]

@@ -237,38 +238,30 @@ It is integrated into Helpful, in Doom.
 #+RESULTS:
 : /home/hlissner/.emacs.d/LICENSE

-*** lambda!
+*** cmd!
 #+BEGIN_SRC elisp :eval no
-(map! "C-j" (lambda! (newline) (indent-according-to-mode)))
-
-;; The `λ!' short-form alias exists. If you have the snippets module enabled and
-;; Doom's default snippets, the 'lam' snippet will expand into 'λ!'. Otherwise,
-;; you can use `lambda!'.
-(map! "C-j" (λ! (newline) (indent-according-to-mode)))
+(map! "C-j" (cmd! (newline) (indent-according-to-mode)))
 #+END_SRC
-*** lambda!!
+
+*** cmd!!
 When ~newline~ is passed a numerical prefix argument (=C-u 5 M-x newline=), it
-inserts N newlines. We can use ~lambda!!~ to easily create a keybinds that bakes
-in the prefix arg into the command call:
+inserts N newlines. We can use ~cmd!!~ to easily create a keybinds that bakes in
+the prefix arg into the command call:

 #+BEGIN_SRC elisp :eval no
-(map! "C-j" (lambda!! #'newline 5))
-
-;; The `λ!!' short-form alias exists. If you have the snippets module enabled
-;; and Doom's default snippets, a 'lam' snippet is available to expand into
-;; 'λ!'. Otherwise, you can use `lambda!!'.
-(map! "C-j" (λ!! #'newline 5))
+(map! "C-j" (cmd!! #'newline 5))
 #+END_SRC

 Or to create aliases for functions that behave differently:

 #+BEGIN_SRC elisp :eval no
-(fset 'insert-5-newlines (lambda!! #'newline 5))
+(fset 'insert-5-newlines (cmd!! #'newline 5))

 ;; The equivalent of C-u M-x org-global-cycle, which resets the org document to
 ;; its startup visibility settings.
-(fset 'org-reset-global-visibility (lambda!! #'org-global-cycle '(4))
+(fset 'org-reset-global-visibility (cmd!! #'org-global-cycle '(4))
 #+END_SRC
+
 *** letenv!
 #+BEGIN_SRC elisp
 (letenv! (("SHELL" "/bin/sh"))
@@ -387,7 +380,7 @@ These are side-by-side comparisons, showing how to bind keys with and without
 *** package!
 #+BEGIN_SRC elisp :eval no
 ;; To install a package that can be found on ELPA or any of the sources
-;; specified in `doom-core-package-sources':
+;; specified in `straight-recipe-repositories':
 (package! evil)
 (package! js2-mode)
 (package! rainbow-delimiters)
@@ -404,15 +397,12 @@ These are side-by-side comparisons, showing how to bind keys with and without
 ;; you can tell the package manager not to clone the repo recursively:
 (package! ansible :recipe (:nonrecursive t))

-;; To install a particular branch, commit or tag:
-(package! evil
-  ;; if :host and :fetcher aren't specified, the package manager will fall back
-  ;; to evil's default source provided by their (M)ELPA recipes:
-  :recipe (:commit "e7bc39de2f961505e8e112da8c1b315ae8afce52"))
-
+;; To pin a package to a specific commit:
+(package! evil :pin "e7bc39de2f9")
+;; ...or branch:
 (package! evil :recipe (:branch "stable"))
-
-(package! evil :recipe (:tag "1.2.9"))
+;; To unpin a pinned package:
+(package! evil :pin nil)

 ;; If you share your config between two computers, and don't want bin/doom
 ;; refresh to delete packages used only on one system, use :ignore
@@ -473,6 +463,14 @@ These are side-by-side comparisons, showing how to bind keys with and without
 ;; Removing arbitrary forms (must be exactly the same as the definition)
 (remove-hook! (one-mode second-mode) (setq v 5) (setq a 2))
 #+END_SRC
+*** setq!
+#+BEGIN_SRC elisp
+;; Each of these have a setter associated with them, which must be triggered in
+;; order for their new values to have an effect.
+(setq! evil-want-Y-yank-to-eol nil
+       evil-want-C-u-scroll nil
+       evil-want-C-d-scroll nil)
+#+END_SRC
 *** setq-hook!
 #+BEGIN_SRC elisp :eval no
 ;; Set multiple variables after a hook
@@ -515,21 +513,21 @@ These are side-by-side comparisons, showing how to bind keys with and without
  :defer-incrementally t)
 #+END_SRC
 * Interesting snippets
-** Persist Emacs' initial frame size across sessions
+** Center Emacs' initial frame with a fixed size
 #+BEGIN_SRC elisp
 (let ((display-height   (display-pixel-height))
      (display-width    (display-pixel-width)))
-  (add-to-list 'initial-frame-alist
-               `((left . ,(/ new-frame-width 2))
-                 (top . ,(/ new-frame-height 2))
-                 (width . ,(/ display-width 2))
-                 (height . ,(/ display-height 2)))))
+  (pushnew! initial-frame-alist
+            `(left . ,(/ display-width 2))
+            `(top . ,(/ display-height 2))
+            `(width . ,display-width)
+            `(height . ,display-height)))
 #+END_SRC

 ** Persist Emacs' initial frame position, dimensions and/or full-screen state across sessions
 #+BEGIN_SRC elisp
 ;; add to ~/.doom.d/config.el
-(when-let (dims (doom-cache-get 'last-frame-size))
+(when-let (dims (doom-store-get 'last-frame-size))
  (cl-destructuring-bind ((left . top) width height fullscreen) dims
    (setq initial-frame-alist
          (append initial-frame-alist
@@ -540,7 +538,7 @@ These are side-by-side comparisons, showing how to bind keys with and without
                    (fullscreen . ,fullscreen))))))

 (defun save-frame-dimensions ()
-  (doom-cache-set 'last-frame-size
+  (doom-store-put 'last-frame-size
                  (list (frame-position)
                        (frame-width)
                        (frame-height)
@@ -567,3 +565,24 @@ than unwarranted characters.

 Alternatively, an updated version exists at
 [[https://github.com/amosbird/evil-terminal-cursor-changer][amosbird/evil-terminal-cursor-changer]], with support for urxvt and tmux.
+
+** Create a paste-transient-state to cycle through kill ring on paste
+Replaces the default evil-paste binding to paste then let you cycle through entries in your kill ring. Gives you more flexibility when copying to your clipboard, making edits, then deciding to paste after.
+
+You will need to enable the `hydra` module first.
+
+#+BEGIN_SRC elisp
+(defhydra hydra-paste (:color red
+                       :hint nil)
+  "\n[%s(length kill-ring-yank-pointer)/%s(length kill-ring)] \
+ [_C-j_/_C-k_] cycles through yanked text, [_p_/_P_] pastes the same text \
+ above or below. Anything else exits."
+  ("C-j" evil-paste-pop)
+  ("C-k" evil-paste-pop-next)
+  ("p" evil-paste-after)
+  ("P" evil-paste-before))
+
+(map! :nv "p" #'hydra-paste/evil-paste-after
+      :nv "P" #'hydra-paste/evil-paste-before)
+#+END_SRC
+
@@ -1,14 +1,14 @@
 #+TITLE: Contributing
 #+STARTUP: nofold

-I can't say Doom Emacs is a one man show anymore. It wouldn't have gotten this
-far without the help of folks like you! Still, I struggle to maintain it all;
-especially the modules I do not use. If Doom has been useful to you, consider
-pitching in and helping me out.
+Doom Emacs is an active and ongoing project, maintained mostly by a single
+person, but includes the efforts of 200 contributors and growing. There is no
+shortage of things that need doing; bugs that need stomping, features that need
+implementing, and documentation that needs documenting. If Doom's been useful to
+you, convert some caffiene into code; it'd be a huge help!

-Help can range from reporting bugs, proposing enhancements, submitting code and
-documentation, or just spreading the good word. To ensure no toes get stepped on
-or wires crossed, this guide was created to help you help us.
+You are welcome to [[https://discord.gg/qvGgnVx][join us on our Discord server]], otherwise read on to learn how
+to contribute to our fine corner of the interwebs.

 * Table of Contents :TOC_3:
 - [[#where-can-i-help][Where can I help?]]
@@ -32,19 +32,20 @@ or wires crossed, this guide was created to help you help us.
 - [[#contributing-documentation][Contributing documentation]]
  - [[#contributing-to-dooms-manual][Contributing to Doom's manual]]
  - [[#contributing-module-documentation][Contributing module documentation]]
+- [[#help-keep-packages-up-to-date][Help keep packages up-to-date!]]
 - [[#other-ways-to-support-doom-emacs][Other ways to support Doom Emacs]]
 - [[#special-thanks][Special thanks]]

 * Where can I help?
 + Our [[https://github.com/hlissner/doom-emacs/issues][issue tracker]] has many issues. If you find one that you have an answer to,
-  please don't hold back!
+  it would be a huge help!
 + Look for issues tagged [[https://github.com/hlissner/doom-emacs/labels/good%20first%20issue][good first issue]]. These were judged to have a low
  barrier of entry.
 + Look for issues tagged [[https://github.com/hlissner/doom-emacs/labels/help%20wanted][help wanted]]. These tend to be a little (or a lot)
  harder, and are issues outside my own expertise.
 + If you've encountered a bug, [[https://github.com/hlissner/doom-emacs/issues/new/choose][file a bug report]].
 + The [[https://github.com/hlissner/doom-emacs/projects/3][development roadmap board]] is a rough timeline of what is being worked on
-  and when. It will give you some idea of what will change and where you can
+  and when. It will give you an idea of what will change and where you can
  redirect your efforts.
 + The [[https://github.com/hlissner/doom-emacs/projects/2][plugins under review board]] lists third party plugins being considered (or
  rejected) for inclusion in Doom Emacs. Approved and unclaimed packages are
@@ -54,30 +55,21 @@ or wires crossed, this guide was created to help you help us.
  cause) perhaps you can address them at the source.

 * TODO Reporting issues
-So you've found a problem. Before you fire off that bug report, there are a few
-things you should try first:
+You've found a problem and you're ready to fire off that bug report. Hold up!
+Before you do that, [[file:getting_started.org::*Troubleshoot][have a look at our Troubleshooting guide]]. If none of these
+suggestions pan out, /then/ it is time to file a bug report.

-+ Make sure your configuration (or Doom Emacs) is *not* byte-compiled. Run ~doom
-  clean~ to ensure it isn't. *Byte-compilation interferes with debugging!*
-+ Run ~bin/doom refresh~ to ensure all plugins are installed and autoload files
-  generated.
-+ Run ~bin/doom doctor~ to diagnose common issues with your system.
-+ Check [[file:faq.org::*Common%20Issues][Common Issues]] in the FAQ to see if yours is a known issue.
-+ If you happen to know what module(s) are relevant to your issue, check their
-  documentation (press =<leader> h m= to jump to a module's documentation). Your
-  issue may be documented.
-+ If possible, check if the issue can be reproduced in vanilla Emacs (Emacs
-  without Doom) and/or vanilla Doom (Doom without your private config). To test
-  this, use ~M-x doom/sandbox~ (bound to =<leader> h E=). [[file:getting_started.org::*Use the sandbox][A guide for using the
-  sandbox can be found in the manual]].
-+ Make sure your issue hasn't already been reported by searching the [[https://github.com/hlissner/doom-emacs/issues][issue
-  tracker]].
-+ Make sure your issue hasn't been resolved on the =develop= branch of Doom.
+An effective bug report is informative. Please try to provide:

-If these suggestions haven't worked for you, it's time [[https://github.com/hlissner/doom-emacs/issues/new/choose][to write a bug report]].
-Please make sure of the following before you submit:
+ A backtrace of all mentioned errors.
+ A step-by-step reproduction of the issue.
+ Information about your Doom config and system environment.
+ Screenshots/casts of the issue (if possible).

-** TODO Collect backtraces of any error messages
+This section will show you how to collect this information.
+
+** Acquire a backtrace from errors
+See "[[file:getting_started.org::*How to extract a backtrace from an error][How to extract a backtrace from an error]]" in the [[file:getting_started.org][Getting Started]] guide.

 ** TODO Create a step-by-step reproduction guide

@@ -165,6 +157,11 @@ contact via our [[https://discord.gg/bcZ6P3y][Discord server]] or [[mailto:henri

 ** TODO Contributing module documentation

+* TODO Help keep packages up-to-date!
+Doom pins all its packages to reduce the likelihood of upstream breakage leaking
+into Doom Emacs. However, we may miss when a package releases hotfixes for
+critical issues. Let us know or PR a bump to our pinned packages.
+
 * TODO Other ways to support Doom Emacs

 * TODO Special thanks
@@ -1,16 +1,20 @@
 #+TITLE: Doom Emacs Documentation
 #+STARTUP: nofold

-Doom Emacs is a configuration for [[https://www.gnu.org/software/emacs/][GNU Emacs]] written by a stubborn,
-shell-dwelling, and melodramatic ex-vimmer. It is designed to be a foundation
-for your own Emacs configuration or a resource for enthusiasts to learn more
-about our favorite OS.
+Doom is a configuration framework for [[https://www.gnu.org/software/emacs/][GNU Emacs 26.3+]] tailored for Emacs
+bankruptcy veterans who want less framework in their frameworks and the
+performance of a hand rolled config (or better). It can be a foundation for your
+own config or a resource for Emacs enthusiasts to learn more about our favorite
+OS.
+
+Doom is an opinionated collection of reasonable (and optional) defaults with a
+focus on performance (both runtime and startup) and on abstraction-light,
+readable code design, so that there is less between you and Emacs.

 #+begin_quote
-Github fails to render org links to sub-sections, so it is recommended that you
-view the documentation from within Doom Emacs by pressing =<help> d h= (=<help>=
-is =SPC h= for evil users and =C-h= for vanilla users) or searching it with
-=<help> d /=.
+The documentation is designed to be viewed within Doom Emacs. Access it by
+pressing =SPC h d h= (or =C-h d h= for non-evil users), or search it with =SPC h
+d s= (or =C-h d s=).
 #+end_quote

 * Table of Contents :TOC:
@@ -20,53 +24,47 @@ is =SPC h= for evil users and =C-h= for vanilla users) or searching it with
  - [[#frequently-asked-questions][Frequently Asked Questions]]
  - [[#contributing][Contributing]]
  - [[#workflow-tips-tricks--tutorials][Workflow Tips, Tricks & Tutorials]]
+  - [[#module-appendix][Module Appendix]]
 - [[#community-resources][Community Resources]]
  - [[#asking-for-help][Asking for help]]
  - [[#project-roadmap][Project roadmap]]
  - [[#tutorials--guides][Tutorials & guides]]
- [[#module-list][Module list]]
-  - [[#app][:app]]
-  - [[#completion][:completion]]
-  - [[#config][:config]]
-  - [[#editor][:editor]]
-  - [[#emacs][:emacs]]
-  - [[#email][:email]]
-  - [[#input][:input]]
-  - [[#lang][:lang]]
-  - [[#term][:term]]
-  - [[#tools][:tools]]
-  - [[#ui][:ui]]
+  - [[#projects-that-supportcomplement-doom][Projects that support/complement Doom]]
+  - [[#similar-projects][Similar projects]]

 * TODO Release Notes

 * Documentation
 ** [[file:getting_started.org][Getting Started]]
- [[file:getting_started.org::*Install][Install]] - How to install Emacs, Doom and its plugins
- [[file:getting_started.org::*Update][Update]] - Keep Doom and its packages up-to-date
- [[file:getting_started.org::*Customize][Customize]] - A primer on customizing and reconfiguring Doom
- [[file:getting_started.org::*Troubleshoot][Troubleshoot]] - How to debug Emacs & Doom, find help or look up documentation
+- [[file:getting_started.org::*Install][Install]]
+- [[file:getting_started.org::*Update & Rollback][Update & Rollback]]
+- [[file:getting_started.org::*Configure][Configure]]
+- [[file:getting_started.org::*Migrate][Migrate]]
+- [[file:getting_started.org::*Troubleshoot][Troubleshoot]]

 ** [[file:faq.org][Frequently Asked Questions]]
 - [[file:faq.org::*General][General]]
 - [[file:faq.org::*Configuration][Configuration]]
+- [[file:faq.org::*Package Management][Package Management]]
 - [[file:faq.org::*Defaults][Defaults]]
 - [[file:faq.org::Common Issues][Common Issues]]
 - [[file:faq.org::Contributing][Contributing]]

 ** TODO [[file:contributing.org][Contributing]]
- [[file:contributing.org::*Where can I help?][Where to get help]]
- Writing an effective bug report
- Suggesting features, keybinds or enhancements
- Contributing code
- Contributing documentation
+- [[file:contributing.org::*Where can I help?][Where to get help?]]
+- Reporting issues
+- Suggesting features, keybinds and enhancements
+- Contributing code or documentation
 - Other ways to support Doom Emacs
 - Special thanks

 ** TODO [[file:workflow.org][Workflow Tips, Tricks & Tutorials]]

+** [[file:modules.org][Module Appendix]]
+
 * Community Resources
 ** Asking for help
- [[https://discord.gg/bcZ6P3y][Our Discord server]]
+- [[https://discord.gg/qvGgnVx][Our Discord server]]
 - [[https://github.com/hlissner/doom-emacs/issues][Our issue tracker]]

 ** Project roadmap
@@ -79,11 +77,12 @@ is =SPC h= for evil users and =C-h= for vanilla users) or searching it with

 ** Tutorials & guides
 + *Doom Emacs*
+  - (videos) [[https://www.youtube.com/playlist?list=PLyy8KUDC8P7X6YkegqrnEnymzMWCNB4bN][Doom Emacs Tutorials]] by [[https://www.youtube.com/channel/UCVls1GmFKf6WlTraIb_IaJg][DistroTube]]
+  - (videos) [[https://www.youtube.com/playlist?list=PLhXZp00uXBk4np17N39WvB80zgxlZfVwj][DoomCasts]] by @zaiste
  - [[https://noelwelsh.com/posts/2019-01-10-doom-emacs.html][Noel's crash course on Doom Emacs]]
  - [[https://medium.com/@aria_39488/getting-started-with-doom-emacs-a-great-transition-from-vim-to-emacs-9bab8e0d8458][Getting Started with Doom Emacs -- a great transition from Vim to Emacs]]
  - [[https://medium.com/@aria_39488/the-niceties-of-evil-in-doom-emacs-cabb46a9446b][The Niceties of evil in Doom Emacs]]
-  - [[https://www.youtube.com/playlist?list=PLhXZp00uXBk4np17N39WvB80zgxlZfVwj][DoomCasts (youtube series)]]
-  - [[https://www.youtube.com/watch?v=GK3fij-D1G8][Org-mode, literate programming in (Doom) Emacs]]
+  - (video) [[https://www.youtube.com/watch?v=GK3fij-D1G8][Org-mode, literate programming in (Doom) Emacs]]
 + *Emacs & Emacs Lisp*
  - [[https://www.gnu.org/software/emacs/manual/html_node/elisp/index.html][The Official Emacs manual]]
  - A variety of Emacs resources - https://github.com/ema2159/awesome-emacs
@@ -92,185 +91,16 @@ is =SPC h= for evil users and =C-h= for vanilla users) or searching it with
    - http://steve-yegge.blogspot.com/2008/01/emergency-elisp.html
  - Workflows for customizing Emacs and its packages (and its C/C++ modes):
    - https://david.rothlis.net/emacs/customize_c.html
-+ *Tools in Emacs*
-  - [[https://www.emacswiki.org/emacs/Calc_Tutorials_by_Andrew_Hyatt][How to use M-x calc]]
+  - *Tools in Emacs*
+    - [[https://www.emacswiki.org/emacs/Calc_Tutorials_by_Andrew_Hyatt][How to use M-x calc]]
 + *Vim & Evil*
  - [[https://gist.github.com/dmsul/8bb08c686b70d5a68da0e2cb81cd857f][A crash course on modal editing and Ex commands]]

-* Module list
-** :app
-Application modules are complex and opinionated modules that transform Emacs
-toward a specific purpose. They may have additional dependencies and should be
-loaded last, before =:config= modules.
+** Projects that support/complement Doom
+ [[https://github.com/plexus/chemacs][plexus/chemacs]]
+ [[https://github.com/r-darwish/topgrade][r-darwish/topgrade]]

-+ [[file:../modules/app/calendar/README.org][calendar]] - TODO
-+ [[file:../modules/app/irc/README.org][irc]] - how neckbeards socialize
-+ rss =+org= - an RSS client in Emacs
-+ [[file:../modules/app/twitter/README.org][twitter]] - A twitter client for Emacs
-+ [[file:../modules/app/write/README.org][write]] =+wordnut +langtool= - Transforms emacs into an IDE for writers, and for
-  writing fiction, notes, papers and so on.
-
-** :completion
-Modules that provide new interfaces or frameworks for completion, including code
-completion.
-
-+ [[file:../modules/completion/company/README.org][company]] =+childframe +tng= - The ultimate code completion backend
-+ helm =+fuzzy +childframe= - *Another* search engine for love and life
-+ ido - The /other/ *other* search engine for love and life
-+ [[file:../modules/completion/ivy/README.org][ivy]] =+fuzzy +prescient +childframe= - /The/ search engine for love and life
-
-** :config
-Modules that configure Emacs one way or another, or focus on making it easier
-for you to customize it yourself. It is best to load these last.
-
-+ literate - For users with literate configs. This will tangle+compile a
-  config.org in your ~doom-private-dir~ when it changes.
-+ [[file:../modules/config/default/README.org][default]] =+bindings +smartparens= - The default module sets reasonable defaults
-  for Emacs. It also provides a Spacemacs-inspired keybinding scheme and a
-  smartparens config. Use it as a reference for your own modules.
-
-** :editor
-Modules that affect and augment your ability to manipulate or insert text.
-
-+ [[file:../modules/editor/evil/README.org][evil]] =+everywhere= - transforms Emacs into Vim
-+ [[file:../modules/editor/file-templates/README.org][file-templates]] - Auto-inserted templates in blank new files
-+ [[file:../modules/editor/fold/README.org][fold]] - universal code folding
-+ format =+onsave= - TODO
-+ god - run Emacs commands without modifier keys
-+ [[file:../modules/editor/lispy/README.org][lispy]] - TODO
-+ multiple-cursors - TODO
-+ [[file:../modules/editor/objed/README.org][objed]] - TODO
-+ [[file:../modules/editor/parinfer/README.org][parinfer]] - TODO
-+ rotate-text - TODO
-+ [[file:../modules/editor/snippets/README.org][snippets]] - Snippet expansion for lazy typists
-+ [[file:../modules/editor/word-wrap/README.org][word-wrap]] - soft wrapping with language-aware indent
-
-** :emacs
-Modules that reconfigure or augment packages or features built into Emacs.
-
-+ [[file:../modules/emacs/dired/README.org][dired]] =+ranger +icons= - TODO
-+ electric - TODO
-+ [[file:../modules/emacs/ibuffer/README.org][ibuffer]] =+icons= - TODO
-+ vc - TODO
-
-** :email
-+ [[file:../modules/email/mu4e/README.org][mu4e]] =+gmail= - TODO
-+ notmuch - TODO
-+ wanderlust =+gmail= - TODO
-
-** :input
-+ [[file:../modules/input/chinese/README.org][chinese]] - TODO
-+ [[file:../modules/input/japanese/README.org][japanese]] - TODO
-
-** :lang
-Modules that bring support for a language or group of languages to Emacs.
-
-+ [[file:../modules/lang/agda/README.org][agda]] - TODO
-+ assembly - TODO
-+ [[file:../modules/lang/cc/README.org][cc]] =+lsp= - TODO
-+ clojure - TODO
-+ common-lisp - TODO
-+ [[file:../modules/lang/coq/README.org][coq]] - TODO
-+ crystal - TODO
-+ [[file:../modules/lang/csharp/README.org][csharp]] - TODO
-+ data - TODO
-+ [[file:../modules/lang/elixir/README.org][elixir]] =+lsp= - TODO
-+ elm - TODO
-+ emacs-lisp - TODO
-+ erlang - TODO
-+ [[file:../modules/lang/ess/README.org][ess]] - TODO
-+ [[file:../modules/lang/faust/README.org][faust]] - TODO
-+ [[file:../modules/lang/fsharp/README.org][fsharp]] - TODO
-+ [[file:../modules/lang/go/README.org][go]] =+lsp= - TODO
-+ [[file:../modules/lang/haskell/README.org][haskell]] =+dante +intero +lsp= - TODO
-+ hy - TODO
-+ [[file:../modules/lang/idris/README.org][idris]] - TODO
-+ java =+meghanada +lsp= - TODO
-+ [[file:../modules/lang/javascript/README.org][javascript]] =+lsp= - JavaScript, TypeScript, and CoffeeScript support
-+ julia - TODO
-+ kotlin =+lsp+= - TODO
-+ [[file:../modules/lang/latex/README.org][latex]] - TODO
-+ lean - TODO
-+ [[file:../modules/lang/ledger/README.org][ledger]] - TODO
-+ lua =+moonscript= - TODO
-+ [[file:../modules/lang/markdown/README.org][markdown]] =+grip= - TODO
-+ [[file:../modules/lang/nim/README.org][nim]] - TODO
-+ nix - TODO
-+ [[file:../modules/lang/ocaml/README.org][ocaml]] =+lsp= - TODO
-+ [[file:../modules/lang/org/README.org][org]] =+dragndrop +gnuplot +hugo +ipython +pandoc +pomodoro +present= - TODO
-+ [[file:../modules/lang/perl/README.org][perl]] - TODO
-+ [[file:../modules/lang/php/README.org][php]] =+lsp= - TODO
-+ plantuml - TODO
-+ purescript - TODO
-+ [[file:../modules/lang/python/README.org][python]] =+lsp +pyenv +conda= - TODO
-+ qt - TODO
-+ racket - TODO
-+ [[file:../modules/lang/rest/README.org][rest]] - TODO
-+ ruby =+lsp +rvm +rbenv= - TODO
-+ [[file:../modules/lang/rust/README.org][rust]] =+lsp= - TODO
-+ scala =+lsp= - TODO
-+ [[file:../modules/lang/scheme/README.org][scheme]] - TODO
-+ [[file:../modules/lang/sh/README.org][sh]] =+fish +lsp= - TODO
-+ [[file:../modules/lang/solidity/README.org][solidity]] - TODO
-+ swift =+lsp= - TODO
-+ terra - TODO
-+ web =+lsp= - HTML and CSS (SCSS/SASS/LESS/Stylus) support.
-
-** :term
-Modules that offer terminal emulation.
-
-+ eshell - TODO
-+ shell - TODO
-+ term - TODO
-+ [[file:../modules/term/vterm/README.org][vterm]] - TODO
-
-** :tools
-Small modules that give Emacs access to external tools & services.
-
-+ ansible - TODO
-+ debugger - A (nigh-)universal debugger in Emacs
-+ [[file:../modules/tools/direnv/README.org][direnv]] - TODO
-+ [[file:../modules/tools/docker/README.org][docker]] - TODO
-+ [[file:../modules/tools/editorconfig/README.org][editorconfig]] - TODO
-+ [[file:../modules/tools/ein/README.org][ein]] - TODO
-+ [[file:../modules/tools/eval/README.org][eval]] =+overlay= - REPL & code evaluation support for a variety of languages
-+ flycheck - Live error/warning highlights
-+ flyspell - Spell checking
-+ gist - TODO
-+ [[file:../modules/tools/lookup/README.org][lookup]] =+docsets= - Universal jump-to & documentation lookup backend
-+ [[file:../modules/tools/lsp/README.org][lsp]] - TODO
-+ macos - TODO
-+ magit - TODO
-+ make - TODO
-+ pass - TODO
-+ pdf - TODO
-+ prodigy - TODO
-+ rgb - TODO
-+ [[file:../modules/tools/terraform/README.org][terraform]]
-+ tmux - TODO
-+ upload - TODO
-
-** :ui
-Aesthetic modules that affect the Emacs interface or user experience.
-
-+ [[file:../modules/ui/deft/README.org][deft]] - TODO
-+ [[file:../modules/ui/doom/README.org][doom]] - TODO
-+ [[file:../modules/ui/doom-dashboard/README.org][doom-dashboard]] - TODO
-+ [[file:../modules/ui/doom-quit/README.org][doom-quit]] - TODO
-+ fill-column - TODO
-+ [[file:../modules/ui/hl-todo/README.org][hl-todo]] - TODO
-+ [[file:../modules/ui/hydra/README.org][hydra]] - TODO
-+ indent-guides - TODO
-+ [[file:../modules/ui/modeline/README.org][modeline]] - TODO
-+ [[file:../modules/ui/nav-flash/README.org][nav-flash]] - TODO
-+ [[file:../modules/ui/neotree/README.org][neotree]] - TODO
-+ [[file:../modules/ui/ophints/README.org][ophints]] - TODO
-+ [[file:../modules/ui/popup/README.org][popup]] =+all +defaults= - Makes temporary/disposable windows less intrusive
-+ pretty-code - TODO
-+ [[file:../modules/ui/tabs/README.org][tabs]] - TODO
-+ treemacs - TODO
-+ [[file:../modules/ui/unicode/README.org][unicode]] - TODO
-+ vc-gutter - TODO
-+ vi-tilde-fringe - TODO
-+ [[file:../modules/ui/window-select/README.org][window-select]] =+switch-window +numbers= - TODO
-+ [[file:../modules/ui/workspaces/README.org][workspaces]] - Isolated workspaces
+** Similar projects
+ [[https://github.com/purcell/emacs.d][purcell/emacs.d]]
+ [[https://github.com/seagle0128/.emacs.d][seagle0128/.emacs.d]]
+ [[https://github.com/syl20bnr/spacemacs][syl20bnr/spacemacs]]
@@ -1,7 +1,15 @@
-#+TITLE: Workflow tips, tricks & tutorials
+#+TITLE: Getting to know Doom Emacs
 #+STARTUP: nofold

-This page is a WIP.
+Once you've installed Doom and launched it, the next step of your masochistic
+journey is to master it. This guide will walk you through many Doom-centric
+workflows you'll commonly find in a text editor (and beyond). It isn't
+exhaustive because I don't have enough lives to make it so.
+
+#+begin_quote
+If you feel like we've missed something, don't hesitate to let us know! You're
+welcome to [[https://discord.gg/qvGgnVx][join us on our Discord server]].
+#+end_quote

 * Table of Contents :TOC:
 - [[#day-1-in-doom-emacs][Day 1 in Doom Emacs]]
@@ -14,6 +22,7 @@ This page is a WIP.
  - [[#pipe-text-through-ex-commands-and-programs][Pipe text through ex commands and programs]]
  - [[#transposingswapping-text][Transposing/swapping text]]
 - [[#managing-your-projects][Managing your projects]]
+  - [[#reconfiguring-emacs-on-a-per-project-basis][Reconfiguring Emacs on a per-project basis]]
 - [[#search--replace][Search & replace]]
  - [[#project-wide-text-search][Project-wide text search]]
  - [[#search--replace-1][Search & replace]]
@@ -32,6 +41,8 @@ This page is a WIP.
 - [[#using-emacs-for][Using Emacs for...]]
  - [[#writing-fiction][Writing fiction]]
  - [[#writing-papers][Writing papers]]
+  - [[#note-keeping][Note-keeping]]
+  - [[#a-personal-organizer][A Personal Organizer]]
  - [[#composing-music][Composing music]]
  - [[#game-development][Game development]]
  - [[#web-development][Web development]]
@@ -48,6 +59,9 @@ This page is a WIP.
 ** TODO Pipe text through ex commands and programs
 ** TODO Transposing/swapping text
 * TODO Managing your projects
+** TODO Reconfiguring Emacs on a per-project basis
+*** TODO .dir-locals.el
+*** TODO editorconfig
 * TODO Search & replace
 ** TODO Project-wide text search
 ** TODO Search & replace
@@ -66,6 +80,8 @@ This page is a WIP.
 * TODO Using Emacs for...
 ** TODO Writing fiction
 ** TODO Writing papers
+** TODO Note-keeping
+** TODO A Personal Organizer
 ** TODO Composing music
 ** TODO Game development
 ** TODO Web development