Skip to content

Commit 5ac2a52

Browse files
tecosaurHenrik Lissner
authored and
Henrik Lissner
committed
docs: change link format
1 parent 58fb83c commit 5ac2a52

File tree

160 files changed

+1162
-1153
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

160 files changed

+1162
-1153
lines changed

docs/appendix.org

+2-2
Original file line numberDiff line numberDiff line change
@@ -184,8 +184,8 @@
184184
[[kbd:][C-x]] and [[kbd:][C-x C-k]] can be considered prefixes.
185185

186186
Prefix keys allow to store and move keybindings in groups. For example by
187-
default all [[doom-package:][lsp-mode]] commands are under ~SPC c l ...~, but if you want to
188-
change that prefix to ~SPC L ...~ for all [[doom-package:][lsp-mode]] commands, it is a one liner
187+
default all [[doom-package:lsp-mode]] commands are under ~SPC c l ...~, but if you want to
188+
change that prefix to ~SPC L ...~ for all [[doom-package:lsp-mode]] commands, it is a one liner
189189
in your configuration; you do _not_ have to rebind each command manually to
190190
its new ~SPC L ...~ variant.
191191

docs/examples.org

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ examples; where the former can also be useful to users who don't use Doom.
1414
Some of Doom's components will read this file to generate documentation for you,
1515
for example:
1616

17-
- Doom's [[doom-module:][:lang emacs-lisp]] module installs the [[doom-package:][elisp-demos]] package. This displays
18-
usage examples alongside documentation in [[doom-package:][help]] and [[doom-package:][helpful]] buffers (produced
17+
- Doom's [[doom-module:][:lang emacs-lisp]] module installs the [[doom-package:elisp-demos]] package. This displays
18+
usage examples alongside documentation in [[doom-package:help]] and [[doom-package:helpful]] buffers (produced
1919
by =describe-*= and =helpful-*= commands; e.g. [[kbd:][<help> h f]]). Doom has extended
2020
this package to search this file as well.
2121
- [[id:1b8b8fa9-6233-4ed8-95c7-f46f8e4e2592][Some Doom's CLI commands]] will emit documentation informed by Doom's org files,

docs/faq.org

+29-29
Original file line numberDiff line numberDiff line change
@@ -199,10 +199,10 @@ Doom's LSP support and install a supported LSP client.
199199
This provides code completion, lookup {definition,references,documentation}
200200
functionality, and syntax checking, all in one:
201201

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?]])
203203
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?]])
206206
3. Install [[https://emacs-lsp.github.io/lsp-mode/page/languages/][a supported LSP client]] on your system using your OS package manager
207207
OR from within Emacs using ~M-x lsp-install-server~ (warning: not all servers
208208
can be installed this way).
@@ -215,7 +215,7 @@ functionality, and syntax checking, all in one:
215215
*** Potential issues
216216
1. Some language modules lack LSP support (either because it doesn't exist or
217217
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
219219
enough to enable it:
220220

221221
#+begin_src elisp
@@ -238,15 +238,15 @@ documentation with [[kbd:][<help> d m]] (or ~M-x doom/help-modules~).
238238
** Change my fonts
239239
Doom exposes a couple variables for setting fonts. They are:
240240

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
243243
variable-pitch-mode or mixed-pitch-mode). Popular for text modes, like Org or
244244
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]]
248248
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.
250250

251251
Each of these variables accept one of:
252252

@@ -329,7 +329,7 @@ This is documented in more detail in our user manual:
329329
- [[id:8e0d2c05-6028-4e68-a50d-b81851f3f258][How to bind aliases for your leader / localleader prefix]]
330330

331331
** 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+.
333333

334334
*** To disable line numbers entirely
335335
#+begin_src emacs-lisp
@@ -357,7 +357,7 @@ For example:
357357
#+end_src
358358

359359
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).
361361

362362
*** To cycle through different styles of line numbers
363363
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.
366366
E.g. ~normal -> relative -> visual -> disabled -> normal~
367367

368368
** 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]]).
370370

371371
Read the "[[id:f3925da6-5f0b-4d11-aa08-7bb58bea1982][Removing evil-mode]]" section in the module's documentation for precise
372372
instructions.
@@ -408,7 +408,7 @@ moved.
408408
Delete =$EMACSDIR/.local/straight= and run ~$ doom sync~.
409409

410410
** 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
412412
provides 2-character versions of the f/F/t/T motion keys, ala [[https://github.com/goldfeld/vim-seek][vim-seek]] or
413413
[[https://github.com/justinmk/vim-sneak][vim-sneak]].
414414

@@ -456,7 +456,7 @@ The common explanations for this are:
456456
the error can shed more light on it (and will be required if you ask the
457457
community for help debugging it).
458458

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
460460
[[id:5e267107-81fa-45b4-8ff3-26d4b98e508e][what Doom modules are]] and [[id:01cffea4-3329-45e2-a892-95a384ab2338][how to
461461
toggle them]].
462462

@@ -521,7 +521,7 @@ Here are a few common causes for random crashes:
521521
~doom-unicode-font~.
522522

523523
- 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.
525525

526526
- On some systems (particularly MacOS), manipulating the fringes or window
527527
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:
540540
(setq org-startup-indented nil))
541541
#+end_src
542542

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]]).
544544

545545
If these don't help, check our troubleshooting guides for [[id:f88eaf35-97c4-48de-85ef-2d53f8615d4a][hard crashes]] or
546546
[[id:0b744192-c648-452d-ba62-1b4c76dc3aee][freezes/hangs]].
@@ -575,10 +575,10 @@ There are a couple ways to address this:
575575
#+end_src
576576

577577
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
579579
=.editorconfigrc= files.
580580

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
582582
when you open a file (that isn't in a project with an editorconfig file).
583583
This isn't foolproof, and won't work for files that have no content in them,
584584
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
886886
to cause issues). If used sparingly, you may not even run into these issues.
887887

888888
** 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
890890
objects and motions.
891891

892892
- There's a text object for every "step" of expansion that expand-region
@@ -904,7 +904,7 @@ objects and motions.
904904
the surrounding brackets/parentheses, etc. There is no reverse of this
905905
however; you'd have to restart visual mode.
906906

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
908908
you have what you want selected. The vim/evil way would rather you select
909909
exactly what you want from the get go. In the rare event a text object fails
910910
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
921921
them will have a far-reaching effect on your effectiveness in vim environments.
922922
I highly recommend putting in the time to learn them.
923923

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
925925
binds keys to it yourself:
926926
#+begin_src emacs-lisp
927927
;;; in $DOOMDIR/packages.el
@@ -939,25 +939,25 @@ variables. This affects macOS users (all =Emacs.app= bundles launch Emacs in an
939939
isolated environment), Linux users who misconfigure their launchers to use the
940940
wrong shell, or Windows users who may have no shell environment at all.
941941

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
943943
startup for those environment variables. ~$ doom env~ was written as more
944944
reliable (and slightly faster) substitute. Here's why it's better:
945945

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
947947
your shell environment. This can be slow depending on the user's shell
948948
configuration and may fail on non-standard shells (like =fish=). A single
949949
program (like =pyenv= or =nvm=) or config framework (like =oh-my-zsh=) could
950950
all our startup optimizations in one fell swoop.
951951

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
953953
=$MANPATH= by default. You must be proactive in order to capture all the
954954
envvars relevant to your development environment and tools.
955955

956956
~$ doom env~ takes the blacklist approach and captures all of your shell
957957
environment. This front loads the debugging process, which is nicer than
958958
dealing with it later, while you're getting work done.
959959

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
961961
yourself:
962962
#+begin_src emacs-lisp
963963
;;; in $DOOMDIR/packages.el
@@ -970,12 +970,12 @@ yourself:
970970
#+end_src
971971

972972
** 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
974974
cleans up whitespace on the lines you've touched.
975975

976976
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.
979979

980980
Automated processes that mutate entire files (or worse, whole projects) should
981981
be deliberately invoked, and by someone privvy to the consequences, rather than

0 commit comments

Comments
 (0)