@@ -199,10 +199,10 @@ Doom's LSP support and install a supported LSP client.
199
199
This provides code completion, lookup {definition,references,documentation}
200
200
functionality, and syntax checking, all in one:
201
201
202
- 1. Enable Doom's [[doom-module:][ :tools lsp]] module. ([[id:01cffea4-3329-45e2-a892-95a384ab2338][How do I enable modules?]])
202
+ 1. Enable Doom's [[doom-module::tools lsp]] module. ([[id:01cffea4-3329-45e2-a892-95a384ab2338][How do I enable modules?]])
203
203
2. Enable the ~+lsp~ flag on the ~:lang~ module corresponding to the language
204
- you want LSP support for. E.g. For python, enable [[doom-module:][ :lang python +lsp]]. For
205
- rust, enable [[doom-module:][ :lang rust +lsp]]. ([[id:01cffea4-3329-45e2-a892-95a384ab2338][How do I enable module flags?]])
204
+ you want LSP support for. E.g. For python, enable [[doom-module::lang python +lsp]]. For
205
+ rust, enable [[doom-module::lang rust +lsp]]. ([[id:01cffea4-3329-45e2-a892-95a384ab2338][How do I enable module flags?]])
206
206
3. Install [[https://emacs-lsp.github.io/lsp-mode/page/languages/][a supported LSP client]] on your system using your OS package manager
207
207
OR from within Emacs using ~M-x lsp-install-server~ (warning: not all servers
208
208
can be installed this way).
@@ -215,7 +215,7 @@ functionality, and syntax checking, all in one:
215
215
*** Potential issues
216
216
1. Some language modules lack LSP support (either because it doesn't exist or
217
217
I'm not aware of it -- let me know!). If you're certain a language is
218
- supported by [[doom-package:][ lsp-mode]], simply adding [[fn:][ lsp!]] to that major mode's hook will be
218
+ supported by [[doom-package:lsp-mode]], simply adding [[fn:lsp!]] to that major mode's hook will be
219
219
enough to enable it:
220
220
221
221
#+begin_src elisp
@@ -238,15 +238,15 @@ documentation with [[kbd:][<help> d m]] (or ~M-x doom/help-modules~).
238
238
** Change my fonts
239
239
Doom exposes a couple variables for setting fonts. They are:
240
240
241
- - [[var:][ doom-font]]: the primary font for Emacs to use.
242
- - [[var:][ doom-variable-pitch-font]]: used for non-monospace fonts (e.g. when using
241
+ - [[var:doom-font]]: the primary font for Emacs to use.
242
+ - [[var:doom-variable-pitch-font]]: used for non-monospace fonts (e.g. when using
243
243
variable-pitch-mode or mixed-pitch-mode). Popular for text modes, like Org or
244
244
Markdown.
245
- - [[var:][ doom-unicode-font]]: used for rendering unicode glyphs. This is ~Symbola~ by
246
- default. It is ignored if the [[doom-module:][ :ui unicode]] module is enabled.
247
- - [[var:][ doom-serif-font]]: the sans-serif font to use wherever the [[face:][ fixed-pitch-serif]]
245
+ - [[var:doom-unicode-font]]: used for rendering unicode glyphs. This is ~Symbola~ by
246
+ default. It is ignored if the [[doom-module::ui unicode]] module is enabled.
247
+ - [[var:doom-serif-font]]: the sans-serif font to use wherever the [[face:fixed-pitch-serif]]
248
248
face is used.
249
- - [[var:][ doom-big-font]]: the large font to use when [[fn:][ doom-big-font-mode]] is active.
249
+ - [[var:doom-big-font]]: the large font to use when [[fn:doom-big-font-mode]] is active.
250
250
251
251
Each of these variables accept one of:
252
252
@@ -329,7 +329,7 @@ This is documented in more detail in our user manual:
329
329
- [[id:8e0d2c05-6028-4e68-a50d-b81851f3f258][How to bind aliases for your leader / localleader prefix]]
330
330
331
331
** Change the style of (or disable) line-numbers?
332
- Doom uses the [[doom-package:][ display-line-numbers]] package, which is included with Emacs 26+.
332
+ Doom uses the [[doom-package:display-line-numbers]] package, which is included with Emacs 26+.
333
333
334
334
*** To disable line numbers entirely
335
335
#+begin_src emacs-lisp
@@ -357,7 +357,7 @@ For example:
357
357
#+end_src
358
358
359
359
You'll find more precise documentation on the variable through [[kbd:][<help> v
360
- display-line-numbers-type]] ([[kbd:][<help>]] is [[kbd:][SPC h]] for [[doom-package:][ evil]] users, [[kbd:][C-h]] otherwise).
360
+ display-line-numbers-type]] ([[kbd:][<help>]] is [[kbd:][SPC h]] for [[doom-package:evil]] users, [[kbd:][C-h]] otherwise).
361
361
362
362
*** To cycle through different styles of line numbers
363
363
Use ~M-x doom/toggle-line-numbers~ (bound to [[kbd:][<leader> t l]] by default) to cycle
@@ -366,7 +366,7 @@ through the available line number styles in the current buffer.
366
366
E.g. ~normal -> relative -> visual -> disabled -> normal~
367
367
368
368
** Disable Evil (vim emulation)?
369
- By disabling the [[doom-module:][ :editor evil]] module ([[id:01cffea4-3329-45e2-a892-95a384ab2338][how to toggle modules]]).
369
+ By disabling the [[doom-module::editor evil]] module ([[id:01cffea4-3329-45e2-a892-95a384ab2338][how to toggle modules]]).
370
370
371
371
Read the "[[id:f3925da6-5f0b-4d11-aa08-7bb58bea1982][Removing evil-mode]]" section in the module's documentation for precise
372
372
instructions.
@@ -408,7 +408,7 @@ moved.
408
408
Delete =$EMACSDIR/.local/straight= and run ~$ doom sync~.
409
409
410
410
** Restore the s and S keys to their default vim behavior ([[doom-ref:][#1307]])
411
- [[kbd:][s]] and [[kbd:][S]] have been intentionally replaced with the [[doom-package:][ evil-snipe]] plugin, which
411
+ [[kbd:][s]] and [[kbd:][S]] have been intentionally replaced with the [[doom-package:evil-snipe]] plugin, which
412
412
provides 2-character versions of the f/F/t/T motion keys, ala [[https://github.com/goldfeld/vim-seek][vim-seek]] or
413
413
[[https://github.com/justinmk/vim-sneak][vim-sneak]].
414
414
@@ -456,7 +456,7 @@ The common explanations for this are:
456
456
the error can shed more light on it (and will be required if you ask the
457
457
community for help debugging it).
458
458
459
- - You have disabled the [[doom-module:][ :ui doom-dashboard]] module. Read about
459
+ - You have disabled the [[doom-module::ui doom-dashboard]] module. Read about
460
460
[[id:5e267107-81fa-45b4-8ff3-26d4b98e508e][what Doom modules are]] and [[id:01cffea4-3329-45e2-a892-95a384ab2338][how to
461
461
toggle them]].
462
462
@@ -521,7 +521,7 @@ Here are a few common causes for random crashes:
521
521
~doom-unicode-font~.
522
522
523
523
- Ligatures can cause Emacs to crash. Try a different [[doom-module::ui ligatures +fira][ligature font]] or disable
524
- the [[doom-module:][ :ui ligatures]] module altogether.
524
+ the [[doom-module::ui ligatures]] module altogether.
525
525
526
526
- On some systems (particularly MacOS), manipulating the fringes or window
527
527
margins can cause Emacs to crash. This is most prominent in Doom's Dashboard
@@ -540,7 +540,7 @@ Here are a few common causes for random crashes:
540
540
(setq org-startup-indented nil))
541
541
#+end_src
542
542
543
- Or disable the [[doom-module:][ :ui doom-dashboard]] and [[doom-module:][ :tools magit]] modules (see [[doom-ref:][#1170]]).
543
+ Or disable the [[doom-module::ui doom-dashboard]] and [[doom-module::tools magit]] modules (see [[doom-ref:][#1170]]).
544
544
545
545
If these don't help, check our troubleshooting guides for [[id:f88eaf35-97c4-48de-85ef-2d53f8615d4a][hard crashes]] or
546
546
[[id:0b744192-c648-452d-ba62-1b4c76dc3aee][freezes/hangs]].
@@ -575,10 +575,10 @@ There are a couple ways to address this:
575
575
#+end_src
576
576
577
577
3. Use [[https://editorconfig.org/][editorconfig]] to configure code style on a per-project basis. If you
578
- enable Doom's [[doom-module:][ :tools editorconfig]] module, Doom will recognize
578
+ enable Doom's [[doom-module::tools editorconfig]] module, Doom will recognize
579
579
=.editorconfigrc= files.
580
580
581
- 4. Or trust in [[doom-package:][ dtrt-indent]]; a plugin Doom uses to analyze and detect indentation
581
+ 4. Or trust in [[doom-package:dtrt-indent]]; a plugin Doom uses to analyze and detect indentation
582
582
when you open a file (that isn't in a project with an editorconfig file).
583
583
This isn't foolproof, and won't work for files that have no content in them,
584
584
but it can help in one-off scenarios.
@@ -886,7 +886,7 @@ All that said, I take no steps to disable or cripple =Customize= in Doom
886
886
to cause issues). If used sparingly, you may not even run into these issues.
887
887
888
888
** Why no =expand-region= for evil users (by default)?
889
- I believe [[doom-package:][ expand-region]] is redundant with and less precise than evil's text
889
+ I believe [[doom-package:expand-region]] is redundant with and less precise than evil's text
890
890
objects and motions.
891
891
892
892
- There's a text object for every "step" of expansion that expand-region
@@ -904,7 +904,7 @@ objects and motions.
904
904
the surrounding brackets/parentheses, etc. There is no reverse of this
905
905
however; you'd have to restart visual mode.
906
906
907
- The [[doom-package:][ expand-region]] way dictates you start at some point and expand/contract until
907
+ The [[doom-package:expand-region]] way dictates you start at some point and expand/contract until
908
908
you have what you want selected. The vim/evil way would rather you select
909
909
exactly what you want from the get go. In the rare event a text object fails
910
910
you, a combination of [[kbd:][o]] (swaps your cursor between the two ends of the region)
@@ -921,7 +921,7 @@ editing paradigm. Vimmers will feel right at home. To everyone else: mastering
921
921
them will have a far-reaching effect on your effectiveness in vim environments.
922
922
I highly recommend putting in the time to learn them.
923
923
924
- That said, if you aren't convinced, it is trivial to install [[doom-package:][ expand-region]] and
924
+ That said, if you aren't convinced, it is trivial to install [[doom-package:expand-region]] and
925
925
binds keys to it yourself:
926
926
#+begin_src emacs-lisp
927
927
;;; in $DOOMDIR/packages.el
@@ -939,25 +939,25 @@ variables. This affects macOS users (all =Emacs.app= bundles launch Emacs in an
939
939
isolated environment), Linux users who misconfigure their launchers to use the
940
940
wrong shell, or Windows users who may have no shell environment at all.
941
941
942
- [[doom-package:][ exec-path-from-shell]] was written to mitigate this, by polling the shell at
942
+ [[doom-package:exec-path-from-shell]] was written to mitigate this, by polling the shell at
943
943
startup for those environment variables. ~$ doom env~ was written as more
944
944
reliable (and slightly faster) substitute. Here's why it's better:
945
945
946
- 1. [[doom-package:][ exec-path-from-shell]] must spawn (at least) one process at startup to scrape
946
+ 1. [[doom-package:exec-path-from-shell]] must spawn (at least) one process at startup to scrape
947
947
your shell environment. This can be slow depending on the user's shell
948
948
configuration and may fail on non-standard shells (like =fish=). A single
949
949
program (like =pyenv= or =nvm=) or config framework (like =oh-my-zsh=) could
950
950
all our startup optimizations in one fell swoop.
951
951
952
- 2. [[doom-package:][ exec-path-from-shell]] takes a whitelist approach and captures only =$PATH= and
952
+ 2. [[doom-package:exec-path-from-shell]] takes a whitelist approach and captures only =$PATH= and
953
953
=$MANPATH= by default. You must be proactive in order to capture all the
954
954
envvars relevant to your development environment and tools.
955
955
956
956
~$ doom env~ takes the blacklist approach and captures all of your shell
957
957
environment. This front loads the debugging process, which is nicer than
958
958
dealing with it later, while you're getting work done.
959
959
960
- That said, if you still want [[var:][ exec-path-from-shell]], it is trivial to install
960
+ That said, if you still want [[var:exec-path-from-shell]], it is trivial to install
961
961
yourself:
962
962
#+begin_src emacs-lisp
963
963
;;; in $DOOMDIR/packages.el
@@ -970,12 +970,12 @@ yourself:
970
970
#+end_src
971
971
972
972
** Why =ws-butler= over =whitespace-cleanup= or =delete-trailing-whitespace=?
973
- I believe [[doom-package:][ ws-butler]] is less imposing on teammates/project maintainers; it only
973
+ I believe [[doom-package:ws-butler]] is less imposing on teammates/project maintainers; it only
974
974
cleans up whitespace on the lines you've touched.
975
975
976
976
You know the story: a PR with 99 whitespace adjustments around a one-line
977
- contribution. Why? Because they added [[fn:][ delete-trailing-whitespace]] (or
978
- [[fn:][ whitespace-cleanup]]) to [[var:][ before-save-hook]], which mutates entire buffers.
977
+ contribution. Why? Because they added [[fn:delete-trailing-whitespace]] (or
978
+ [[fn:whitespace-cleanup]]) to [[var:before-save-hook]], which mutates entire buffers.
979
979
980
980
Automated processes that mutate entire files (or worse, whole projects) should
981
981
be deliberately invoked, and by someone privvy to the consequences, rather than
0 commit comments