diff options
Diffstat (limited to 'content/blog/2024-03-13-doom-emacs.org')
| -rw-r--r-- | content/blog/2024-03-13-doom-emacs.org | 205 |
1 files changed, 92 insertions, 113 deletions
diff --git a/content/blog/2024-03-13-doom-emacs.org b/content/blog/2024-03-13-doom-emacs.org index 96b22be..d4f0c19 100644 --- a/content/blog/2024-03-13-doom-emacs.org +++ b/content/blog/2024-03-13-doom-emacs.org @@ -5,9 +5,9 @@ ** Screenshots -These screenshots are showing a project opened with projectile, a -treemacs side pane open with the project contents, multiple buffers -tiled next to each other, and the help pane open at the bottomm. +These screenshots are showing a project opened with projectile, a treemacs side +pane open with the project contents, multiple buffers tiled next to each other, +and the help pane open at the bottomm. The themes are =doom-homage-white= and =doom-homage-black=. @@ -19,44 +19,35 @@ The themes are =doom-homage-white= and =doom-homage-black=. ** Getting Started -I have been switching back and forth between -[[https://en.wikipedia.org/wiki/Markdown][markdown]] and -[[https://en.wikipedia.org/wiki/Org-mode][org-mode]] recently for my -personal note taking, wiki, and even this blog. As a result, I have been -stumbling further into the world of Emacs and found myself at a point -where I now prefer to do most of my basic editing within Emacs. +I have been switching back and forth between [[https://en.wikipedia.org/wiki/Markdown][markdown]] and [[https://en.wikipedia.org/wiki/Org-mode][org-mode]] recently for +my personal note taking, wiki, and even this blog. As a result, I have been +stumbling further into the world of Emacs and found myself at a point where I +now prefer to do most of my basic editing within Emacs. I'll leave the markdown vs. org-mode debate for another post, but I love -org-mode's extensibility and interactive nature within Emacs, but it -becomes very unwieldy in any other client implementation of org-mode - -especially on iOS. On the flip side, markdown is limited in -functionality and fractured into different standards, but it's simple -and popular enough that there are a plethora of great clients to choose -from that will get the job done. +org-mode's extensibility and interactive nature within Emacs, but it becomes +very unwieldy in any other client implementation of org-mode - especially on +iOS. On the flip side, markdown is limited in functionality and fractured into +different standards, but it's simple and popular enough that there are a +plethora of great clients to choose from that will get the job done. -For now, I want to focus on how I have been using Emacs and some of the -things that would have helped me learn it faster had I known where to -start. +For now, I want to focus on how I have been using Emacs and some of the things +that would have helped me learn it faster had I known where to start. *** Installation -This post focuses on [[https://github.com/doomemacs/doomemacs][Doom -Emacs]], which is an Emacs framework that provides an alternative -experience to the vanilla [[https://www.gnu.org/software/emacs/][GNU -Emacs]]. +This post focuses on [[https://github.com/doomemacs/doomemacs][Doom Emacs]], which is an Emacs framework that provides an +alternative experience to the vanilla [[https://www.gnu.org/software/emacs/][GNU Emacs]]. -The -[[https://github.com/doomemacs/doomemacs/blob/master/docs/getting_started.org][Getting -Start Guide]] has an extremely detailed walkthrough of installation for -all systems, so please refer to that guide for up-to-date instructions. +The [[https://github.com/doomemacs/doomemacs/blob/master/docs/getting_started.org][Getting Start Guide]] has an extremely detailed walkthrough of installation +for all systems, so please refer to that guide for up-to-date instructions. I chose to install on macOS, using the Homebrew option with the =railwaycat/emacsmacport= version of Emacs. -Once the program is installed, you can run the program by typing =emacs= -in a terminal. If you installed a version of Emacs that supports both a -GUI and TUI, you will have to run =emacs -nw= to get the TUI instead of -the default GUI. +Once the program is installed, you can run the program by typing =emacs= in a +terminal. If you installed a version of Emacs that supports both a GUI and TUI, +you will have to run =emacs -nw= to get the TUI instead of the default GUI. *** Configuration @@ -65,13 +56,12 @@ Once installed, you can configure Doom by editing the files within the 1. =config.el= - Personal configuration file 2. =custom.el= - Custom set variables -3. =init.el= - Doom modules and load order, must run =doom sync= after - modifying -4. =packages.el= - Declare packages to install in this file, then run - =doom sync= to install +3. =init.el= - Doom modules and load order, must run =doom sync= after modifying +4. =packages.el= - Declare packages to install in this file, then run =doom + sync= to install -I only needed a few customizations for my configuration, so I'll list -them below. +I only needed a few customizations for my configuration, so I'll list them +below. #+begin_src lisp ;; ~/.doom.d/config.el @@ -145,30 +135,28 @@ them below. (default +bindings +smartparens)) #+end_src -If you're editing these files within Doom directly, remember to run -=SPC h r r= to reload the configuration. Also remember to run -=doom sync= for any changes to the =init.el= or =packages.el= files. +If you're editing these files within Doom directly, remember to run =SPC h r r= +to reload the configuration. Also remember to run =doom sync= for any changes to +the =init.el= or =packages.el= files. ** Basic Functionality -I kept a cheat sheet note open at first with all of the basic functions -typed out, copied as I went through the tutorial. After a little while, -I no longer needed it. I highly recommend writing down the most -applicable shortcuts for your preferred functionality and refer back to -it until you've memorized it. - -Memorizing the shortcuts will differ based on the type of Emacs -framework being used. Personally, migrating from vanilla Emacs to Doom -Emacs simplified everything by a large factor and instantly enabled me -to start working on my projects, eliminating most of the hurdles I was -running into. The vanilla emacs hotkeys became obnoxious and I actually -stopped using Emacs entirely for about a month before trying Doom. - -For me, the first logical step is to interact with the local filesystem. -To do this, I needed to know how to open directories, open files, save -files, discard changes, close files, and switch between open files. Here -are some example shortcuts I've written down in order to accomplish -file-based actions. +I kept a cheat sheet note open at first with all of the basic functions typed +out, copied as I went through the tutorial. After a little while, I no longer +needed it. I highly recommend writing down the most applicable shortcuts for +your preferred functionality and refer back to it until you've memorized it. + +Memorizing the shortcuts will differ based on the type of Emacs framework being +used. Personally, migrating from vanilla Emacs to Doom Emacs simplified +everything by a large factor and instantly enabled me to start working on my +projects, eliminating most of the hurdles I was running into. The vanilla emacs +hotkeys became obnoxious and I actually stopped using Emacs entirely for about a +month before trying Doom. + +For me, the first logical step is to interact with the local filesystem. To do +this, I needed to know how to open directories, open files, save files, discard +changes, close files, and switch between open files. Here are some example +shortcuts I've written down in order to accomplish file-based actions. | Doom Hotkey | Emacs Hotkey | Description | |-----------------+---------------+----------------------------------------| @@ -181,30 +169,28 @@ file-based actions. | =SPC b k= | =C-x k= | Kill current buffer | | =SPC w h/j/k/l= | =C-x o=[fn:2] | Move left/down/up/right to next buffer | -In general, when in Doom, you can press =SPC= and wait a second for the -help pane to appear with all available hotkey options. For example, you -can press =SPC=, wait for the help pane, and then select a key such as -=g= to enter the git help pane and explore further command options. +In general, when in Doom, you can press =SPC= and wait a second for the help +pane to appear with all available hotkey options. For example, you can press +=SPC=, wait for the help pane, and then select a key such as =g= to enter the +git help pane and explore further command options. ** Editing -Next in my process is to dive into editing for any languages I'm -currently using. In this post, I will just cover Markdown and Org-Mode -but I have also been slowly adoping some Python and general web dev -tools as well. +Next in my process is to dive into editing for any languages I'm currently +using. In this post, I will just cover Markdown and Org-Mode but I have also +been slowly adoping some Python and general web dev tools as well. *** Markdown #+caption: Markdown Preview [[https://img.cleberg.net/blog/20240314-doom-emacs/markdown.png]] -Markdown is fairly simple as the syntax is limited, so just make sure -the =~/.doom.d/init.el= includes the =markdown= declaration in the -=:lang= section. +Markdown is fairly simple as the syntax is limited, so just make sure the +=~/.doom.d/init.el= includes the =markdown= declaration in the =:lang= section. -This package includes the following hotkey menus. The insert and toggle -menu expands further, allowing you to insert various markdown elements -and toggle things like link hiding. +This package includes the following hotkey menus. The insert and toggle menu +expands further, allowing you to insert various markdown elements and toggle +things like link hiding. | Doom Hotkey | Function | |------------------------------+--------------------------| @@ -221,14 +207,12 @@ and toggle things like link hiding. #+caption: Org-Mode Preview [[https://img.cleberg.net/blog/20240314-doom-emacs/org.png]] -Similar to the markdown section above, ensure that the -=~/.doom.d/init.el= includes the =org= declaration in the =:lang= -section. +Similar to the markdown section above, ensure that the =~/.doom.d/init.el= +includes the =org= declaration in the =:lang= section. -There are a few hot keys, but a quick search with =SPC : org= shows that -there are 865 possible org-related functions you can run. I won't -possibly be able to list them all, so I will simply cover a few of the -basic commands I use myself. +There are a few hot keys, but a quick search with =SPC : org= shows that there +are 865 possible org-related functions you can run. I won't possibly be able to +list them all, so I will simply cover a few of the basic commands I use myself. | Doom Hotkey | Function | |----------------+---------------------------------------| @@ -246,32 +230,28 @@ basic commands I use myself. 1. Org-Publish - Org includes a - [[https://orgmode.org/manual/Publishing.html][publishing management - system]] by default that allows you to export org files to Org, - iCalendar, HTML, LaTex, Markdown, ODT, and Plain Text. Most of these - can be exported into another buffer and opened, or simply to an - external file. + Org includes a [[https://orgmode.org/manual/Publishing.html][publishing management system]] by default that allows you to + export org files to Org, iCalendar, HTML, LaTex, Markdown, ODT, and Plain + Text. Most of these can be exported into another buffer and opened, or simply + to an external file. - While inside an org file, simply run =SPC m e= or - =M-x org-export-dispatch= to open the export menu. This menu will - show all options and ask you to select an option. If you want to - export to HTML, simply press =h= and then =H= (As HTML buffer), =h= - (As HTML file), or =o= (As HTML file and open). + While inside an org file, simply run =SPC m e= or =M-x org-export-dispatch= + to open the export menu. This menu will show all options and ask you to + select an option. If you want to export to HTML, simply press =h= and then + =H= (As HTML buffer), =h= (As HTML file), or =o= (As HTML file and open). 2. Projects - Some publishing options are easier with a defined project in Emacs. - To create a project within Emacs, I use two methods: + Some publishing options are easier with a defined project in Emacs. To create + a project within Emacs, I use two methods: - 1. Add the project via the projectile command =SPC p a=. Does not - always work for me. + 1. Add the project via the projectile command =SPC p a=. Does not always work + for me. 2. Add an empty =.projectile= file in the project root. - Once a project has been created, you can create custom publishing - actions within your =~/.doom.d/config.el= file. For example, here's a - test project I created to try and convert this blog to org-mode - recently. + Once a project has been created, you can create custom publishing actions + within your =~/.doom.d/config.el= file. For example, here's a test project I + created to try and convert this blog to org-mode recently. #+begin_src lisp ;; org-publish @@ -342,19 +322,18 @@ basic commands I use myself. ** General Thoughts -I have enjoyed Doom Emacs (far more than GNU Emacs) and will likely -continue to use it as my main editor for the time being. Org-Mode is -certainly the largest factor here, as I far prefer it over Markdown due -to its inherent features and detailed markup options. However, working -with org-mode on iOS has been a pain and I will have to see if there's -an easier way to resolve those issues or if going back to separate -Markdown, Reminders, and Calendar apps is easier to work with than an -all-in-one org solution. - -[fn:1] Doom's evil-window functionality is a bit different from GNU - Emacs, but you can always switch to the "other" buffer with - =C-x o= or =C-x b= to get a list of buffers to select. - -[fn:2] Doom's evil-window functionality is a bit different from GNU - Emacs, but you can always switch to the "other" buffer with - =C-x o= or =C-x b= to get a list of buffers to select. +I have enjoyed Doom Emacs (far more than GNU Emacs) and will likely continue to +use it as my main editor for the time being. Org-Mode is certainly the largest +factor here, as I far prefer it over Markdown due to its inherent features and +detailed markup options. However, working with org-mode on iOS has been a pain +and I will have to see if there's an easier way to resolve those issues or if +going back to separate Markdown, Reminders, and Calendar apps is easier to work +with than an all-in-one org solution. + +[fn:1] Doom's evil-window functionality is a bit different from GNU Emacs, but + you can always switch to the "other" buffer with =C-x o= or =C-x b= to + get a list of buffers to select. + +[fn:2] Doom's evil-window functionality is a bit different from GNU Emacs, but + you can always switch to the "other" buffer with =C-x o= or =C-x b= to + get a list of buffers to select. |