docs: change link format

This commit is contained in:
TEC 2022-09-26 02:19:42 +08:00 committed by Henrik Lissner
parent 58fb83c98e
commit 5ac2a5258b
160 changed files with 1161 additions and 1152 deletions

View file

@ -15,7 +15,7 @@ quickly jot down thoughts and easily retrieve them later.
/This module has no flags./
** Packages
- [[doom-package:][deft]]
- [[doom-package:deft]]
** Hacks
/No hacks documented for this module./

View file

@ -62,7 +62,7 @@ If you have any issues with this module do let me know
* Appendix
** Variables
- [[var:][+doom-quit-messages]]
- [[var:+doom-quit-messages]]
** Functions
- [[fn:][+doom-quit-fn]]
- [[fn:+doom-quit-fn]]

View file

@ -5,11 +5,11 @@
* Description :unfold:
This module gives Doom its signature look: powered by the [[doom-package:doom-themes][doom-one]] theme
(loosely inspired by [[https://github.com/atom/one-dark-syntax][Atom's One Dark theme]]) and [[doom-package:][solaire-mode]]. Includes:
(loosely inspired by [[https://github.com/atom/one-dark-syntax][Atom's One Dark theme]]) and [[doom-package:solaire-mode]]. Includes:
- A custom folded-region indicator for [[doom-package:][hideshow]].
- "Thin bar" fringe bitmaps for [[doom-package:][git-gutter-fringe]].
- File-visiting buffers are slightly brighter (thanks to [[doom-package:][solaire-mode]]).
- A custom folded-region indicator for [[doom-package:hideshow]].
- "Thin bar" fringe bitmaps for [[doom-package:git-gutter-fringe]].
- File-visiting buffers are slightly brighter (thanks to [[doom-package:solaire-mode]]).
** Maintainers
- [[doom-user:][@hlissner]]
@ -20,8 +20,8 @@ This module gives Doom its signature look: powered by the [[doom-package:doom-th
/This module has no flags./
** Packages
- [[doom-package:][doom-themes]]
- [[doom-package:][solaire-mode]]
- [[doom-package:doom-themes]]
- [[doom-package:solaire-mode]]
** Hacks
/No hacks documented for this module./
@ -72,7 +72,7 @@ core/core-ui.el has four relevant variables:
- ~doom-variable-pitch-font~ :: the font to use when ~variable-pitch-mode~ is active
(or where the ~variable-pitch~ face is used).
- ~doom-unicode-font~ :: the font used to display unicode symbols. This is
ignored if the [[doom-module:][:ui unicode]] module is enabled.
ignored if the [[doom-module::ui unicode]] module is enabled.
#+begin_src emacs-lisp
(setq doom-font (font-spec :family "Fira Mono" :size 12)
@ -90,7 +90,7 @@ If you're seeing strange unicode symbols, this is likely because you don't have
all-the-icons-install-fonts~.
** Ugly background colors in tty Emacs for daemon users
[[doom-package:][solaire-mode]] is an aesthetic plugin that makes non-file-visiting buffers darker
[[doom-package:solaire-mode]] is an aesthetic plugin that makes non-file-visiting buffers darker
than the rest of the Emacs' frame (to visually differentiate temporary windows
or sidebars from editing windows). This looks great in GUI Emacs, but can look
questionable in the terminal.

View file

@ -20,7 +20,7 @@ style, or unicode styles), as well as convert certain text patterns (e.g.
Include unicode emojis like 🙂.
** Packages
- [[doom-package:][emojify]]
- [[doom-package:emojify]]
** Hacks
/No hacks documented for this module./

View file

@ -16,7 +16,7 @@ This module adds syntax highlighting for various tags in code comments, such as
/This module has no flags./
** Packages
- [[doom-package:][hl-todo]]
- [[doom-package:hl-todo]]
** Hacks
/No hacks documented for this module./

View file

@ -23,7 +23,7 @@ start with:
/This module has no flags./
** Packages
- [[doom-package:][hydra]]
- [[doom-package:hydra]]
** Hacks
/No hacks documented for this module./

View file

@ -13,7 +13,7 @@
/This module has no flags./
** Packages
- [[doom-package:][highlight-indent-guides]]
- [[doom-package:highlight-indent-guides]]
** Hacks
/No hacks documented for this module./

View file

@ -85,7 +85,7 @@ emacs, this is implemented in two different ways :
which haves the ligatures as separate unicode symbols, and using
prettify-symbols-mode, =->=-like combinations are manually listed and replaced
with the correct symbol. The mapping between =->=-like sequences and unicode
values in the font are font-specific ; therefore [[doom-module:][+fira]], [[doom-module:][+iosevka]]... files and
values in the font are font-specific ; therefore [[doom-module:+fira]], [[doom-module:+iosevka]]... files and
specific fonts are necessary for it to work.
- composition-function-table method :: regexps are used to match all the usual
sequences which are composed into ligatures. These regexps are passed to emacs
@ -225,8 +225,8 @@ if you don't like the symbols chosen you can change them by using:
This can usually be fixed by doing one of the following:
- Make sure Symbola (the font) is installed on your system.
- Otherwise, change [[var:][doom-unicode-font]] (set to Symbola by default).
- Disable the [[doom-module:][:ui unicode]] module. It not only overrides [[var:][doom-unicode-font]], but
- Otherwise, change [[var:doom-unicode-font]] (set to Symbola by default).
- Disable the [[doom-module::ui unicode]] module. It not only overrides [[var:doom-unicode-font]], but
should only be used as a last resort.
* Frequently asked questions

View file

@ -16,7 +16,7 @@ feature found in many other editors.
/This module has no flags./
** Packages
- [[doom-package:][minimap]]
- [[doom-package:minimap]]
** Hacks
/No hacks documented for this module./

View file

@ -5,7 +5,7 @@
* Description :unfold:
This module provides an Atom-inspired, minimalistic modeline for Doom Emacs,
powered by the [[doom-package:][doom-modeline]] package (where you can find screenshots).
powered by the [[doom-package:doom-modeline]] package (where you can find screenshots).
** Maintainers
- [[doom-user:][@hlissner]]
@ -15,12 +15,12 @@ powered by the [[doom-package:][doom-modeline]] package (where you can find scre
** Module flags
- +light ::
Enable a lighter, less featureful version of the modeline that does not depend
on [[doom-package:][doom-modeline]], which has performances issues in some cases.
on [[doom-package:doom-modeline]], which has performances issues in some cases.
** Packages
- [[doom-package:][anzu]]
- [[doom-package:][doom-modeline]] unless [[doom-module:][+light]]
- [[doom-package:][evil-anzu]] if [[doom-module:][:editor evil]]
- [[doom-package:anzu]]
- [[doom-package:doom-modeline]] unless [[doom-module:+light]]
- [[doom-package:evil-anzu]] if [[doom-module::editor evil]]
** Hacks
/No hacks documented for this module./

View file

@ -20,7 +20,7 @@ make it easy to follow after big operations.
/This module has no flags./
** Packages
- [[doom-package:][nav-flash]]
- [[doom-package:nav-flash]]
** Hacks
/No hacks documented for this module./
@ -35,16 +35,16 @@ make it easy to follow after big operations.
/This module has no external requirements./
* Usage
By default, [[doom-package:][nav-flash]] will be triggered whenever [[fn:][recenter]] is called or an entry
is added to the jump-list (managed by [[doom-package:][better-jumper]]).
By default, [[doom-package:nav-flash]] will be triggered whenever [[fn:recenter]] is called or an entry
is added to the jump-list (managed by [[doom-package:better-jumper]]).
[[fn:][recenter]] is called after many hooks and commands, such as:
- [[var:][better-jumper-post-jump-hook]]
- [[var:][rtags-after-find-file-hook]]
- [[var:][org-follow-link-hook]]
- [[var:][imenu-after-jump-hook]]
- [[var:][counsel-grep-post-action-hook]]
- [[var:][dumb-jump-after-jump-hook]]
[[fn:recenter]] is called after many hooks and commands, such as:
- [[var:better-jumper-post-jump-hook]]
- [[var:rtags-after-find-file-hook]]
- [[var:org-follow-link-hook]]
- [[var:imenu-after-jump-hook]]
- [[var:counsel-grep-post-action-hook]]
- [[var:dumb-jump-after-jump-hook]]
* TODO Configuration
#+begin_quote

View file

@ -8,7 +8,7 @@ This module brings a side panel for browsing project files, inspired by vim's
NERDTree.
#+begin_quote
💡 Sure, there's [[doom-package:][dired]] and [[doom-package:][projectile]], but sometimes I'd like a bird's eye view
💡 Sure, there's [[doom-package:dired]] and [[doom-package:projectile]], but sometimes I'd like a bird's eye view
of a project.
#+end_quote
@ -19,7 +19,7 @@ NERDTree.
/This module has no flags./
** Packages
- [[doom-package:][neotree]]
- [[doom-package:neotree]]
** TODO Hacks
#+begin_quote

View file

@ -8,7 +8,7 @@ This module provides op-hints (operation hinting), i.e. visual feedback for
certain operations. It highlights regions of text that the last operation (like
yank) acted on.
Uses [[doom-package:][evil-goggles]] for evil users and [[doom-package:][volatile-highlights]] otherwise.
Uses [[doom-package:evil-goggles]] for evil users and [[doom-package:volatile-highlights]] otherwise.
** Maintainers
- [[doom-user:][@hlissner]]
@ -19,8 +19,8 @@ Uses [[doom-package:][evil-goggles]] for evil users and [[doom-package:][volatil
/This module has no flags./
** Packages
- [[doom-package:][evil-goggles]] if [[doom-module:][:editor evil]]
- [[doom-package:][volatile-highlights]] unless [[doom-module:][:editor evil]]
- [[doom-package:evil-goggles]] if [[doom-module::editor evil]]
- [[doom-package:volatile-highlights]] unless [[doom-module::editor evil]]
** Hacks
/No hacks documented for this module./

View file

@ -31,20 +31,20 @@ clean up after itself and kill off buffers I mark as transient.
/This module doesn't install any packages./
** Hacks
- [[doom-package:][help-mode]] has been advised to follow file links in the buffer you were in
- [[doom-package:help-mode]] has been advised to follow file links in the buffer you were in
before entering the popup, rather than in a new window.
- [[doom-package:][wgrep]] buffers are advised to close themselves when aborting or committing
- [[doom-package:wgrep]] buffers are advised to close themselves when aborting or committing
changes.
- [[doom-package:][persp-mode]] is advised to restore popup windows when loading a session from
- [[doom-package:persp-mode]] is advised to restore popup windows when loading a session from
file.
- Interactive calls to ~windmove-*~ commands (used by ~evil-window-*~ commands)
will ignore the ~no-other-window~ window parameter, allowing you to switch to
popup windows as if they're ordinary windows.
- ~balance-windows~ has been advised to close popups while it does its business,
then restore them afterwards.
- [[doom-package:][neotree]] advises ~balance-windows~, which causes major slow-downs when paired
- [[doom-package:neotree]] advises ~balance-windows~, which causes major slow-downs when paired
with our ~balance-window~ advice, so we removes neotree's advice.
- [[doom-package:][org-mode]] is an ongoing (and huge) effort. It has a scorched-earth window
- [[doom-package:org-mode]] is an ongoing (and huge) effort. It has a scorched-earth window
management system I'm not fond of. ie. it kills all windows and monopolizes
the frame. On top of that, it /really/ likes to use ~switch-to-buffer~ for
most of its buffer management, which completely bypasses

View file

@ -13,7 +13,7 @@ This module adds an Atom-esque tab bar to the Emacs UI.
/This module has no flags./
** Packages
- [[doom-package:][centaur-tabs]]
- [[doom-package:centaur-tabs]]
** Hacks
/No hacks documented for this module./

View file

@ -10,9 +10,9 @@ system outlines of your projects in a simple tree layout allowing quick
navigation and exploration, while also possessing basic file management
utilities. It includes:
- Integration with Git (if [[doom-module:][:tools magit]] is enabled)
- Integration with Evil (if [[doom-module:][:editor evil +everywhere]] is enabled)
- Workspace awareness (if [[doom-module:][:ui workspaces]] is enabled)
- Integration with Git (if [[doom-module::tools magit]] is enabled)
- Integration with Evil (if [[doom-module::editor evil +everywhere]] is enabled)
- Workspace awareness (if [[doom-module::ui workspaces]] is enabled)
** Maintainers
- [[doom-user:][@hlissner]]
@ -24,12 +24,12 @@ utilities. It includes:
Enable ~lsp-treemacs~ integration and add shortcuts for common commands.
** Packages
- [[doom-package:][lsp-treemacs]] if [[doom-module:][+lsp]]
- [[doom-package:][treemacs]]
- [[doom-package:][treemacs-evil]] if [[doom-module:][:editor evil +everywhere]]
- [[doom-package:][treemacs-magit]] if [[doom-module:][:tools magit]]
- [[doom-package:][treemacs-persp]] if [[doom-module:][:ui workspaces]]
- [[doom-package:][treemacs-projectile]]
- [[doom-package:lsp-treemacs]] if [[doom-module:+lsp]]
- [[doom-package:treemacs]]
- [[doom-package:treemacs-evil]] if [[doom-module::editor evil +everywhere]]
- [[doom-package:treemacs-magit]] if [[doom-module::tools magit]]
- [[doom-package:treemacs-persp]] if [[doom-module::ui workspaces]]
- [[doom-package:treemacs-projectile]]
** Hacks
/No hacks documented for this module./
@ -41,7 +41,7 @@ utilities. It includes:
* Installation
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
If =python3= is present on your =$PATH=, [[doom-package:][treemacs]] will use it to display git
If =python3= is present on your =$PATH=, [[doom-package:treemacs]] will use it to display git
status for files.
* TODO Usage

View file

@ -29,7 +29,7 @@ When this module is enabled:
/This module has no flags./
** Packages
- [[doom-package:][unicode-fonts]]
- [[doom-package:unicode-fonts]]
** Hacks
/No hacks documented for this module./

View file

@ -14,8 +14,8 @@ Supports Git, Svn, Hg, and Bzr.
** Module flags
- +diff-hl ::
Use [[doom-package:][diff-hl]] instead of git-gutter to power the VC gutter. It is a little
faster, but is slightly more prone to visual glitching. [[doom-package:][diff-hl]] is intended to
Use [[doom-package:diff-hl]] instead of git-gutter to power the VC gutter. It is a little
faster, but is slightly more prone to visual glitching. [[doom-package:diff-hl]] is intended to
replace git-gutter at some point in the future.
- +pretty ::
Apply some stylistic defaults to the fringe, enabling thin bars in the fringe.
@ -26,20 +26,20 @@ Supports Git, Svn, Hg, and Bzr.
diff-hl's faces (like modus-themes does).
** Packages
- [[doom-package:][git-gutter-fringe]] unless [[doom-module:][+diff-hl]]
- [[doom-package:][diff-hl]] if [[doom-module:][+diff-hl]]
- [[doom-package:git-gutter-fringe]] unless [[doom-module:+diff-hl]]
- [[doom-package:diff-hl]] if [[doom-module:+diff-hl]]
** Hacks
- The VC gutter will be updated when pressing ESC, leaving insert mode (evil
users), or refocusing the frame or window where it is active.
- If [[doom-module:][+pretty]] is enabled
- If [[doom-module:+pretty]] is enabled
- The fringes that both git-gutter-fringe and diff-hl define will be replaced
with a set of thin bars. This achieves a slicker look closer to git-gutter's
appearance in VSCode or Sublime Text, but may look weird for themes that
swap their faces' :foreground and :background (like modus-themes).
- The fringes are moved to the outside of the margins (closest to the frame
edge), so they have some breathing space away from the buffer's contents.
- If [[doom-package:][+diff-hl]] is enabled:
- If [[doom-package:+diff-hl]] is enabled:
- ~diff-hl-revert-hunk~ displays a preview popup of the hunk being reverted.
It takes up ~50% of the frame, by default, whether you're reverting 2 lines
or 20. Since this isn't easily customized, it has been advised to shrink

View file

@ -15,7 +15,7 @@ Displays a tilde(~) in the left fringe to indicate an empty line, similar to Vi.
/This module has no flags./
** Packages
- [[doom-package:][vi-tilde-fringe]]
- [[doom-package:vi-tilde-fringe]]
** Hacks
/No hacks documented for this module./

View file

@ -7,11 +7,11 @@
This module provides several methods for selecting windows without the use of
the mouse or spatial navigation (e.g. [[kbd:][C-w {h,j,k,l}]]).
The command ~other-window~ is remapped to either [[doom-package:][switch-window]] or [[doom-package:][ace-window]],
The command ~other-window~ is remapped to either [[doom-package:switch-window]] or [[doom-package:ace-window]],
depending on which backend you've enabled. It is bound to [[kbd:][C-x o]] (and [[kbd:][C-w C-w]] for
evil users).
It also provides numbered windows and selection with the [[doom-package:][winum]] package, if
It also provides numbered windows and selection with the [[doom-package:winum]] package, if
desired. Evil users can jump to window N in [[kbd:][C-w <N>]] (where N is a number between
0 and 9). Non evil users have [[kbd:][C-x w <N>]] instead.
@ -20,14 +20,14 @@ desired. Evil users can jump to window N in [[kbd:][C-w <N>]] (where N is a numb
** Module flags
- +numbers ::
Enable numbered windows and window selection (using [[doom-package:][winum]]).
Enable numbered windows and window selection (using [[doom-package:winum]]).
- +switch-window ::
Use the [[doom-package:][switch-window]] package as the backend, instead of ace-window ([[doom-package:][avy]]).
Use the [[doom-package:switch-window]] package as the backend, instead of ace-window ([[doom-package:avy]]).
** Packages
- [[doom-package:][ace-window]] unless [[doom-module:][+switch-window]]
- [[doom-package:][switch-window]] if [[doom-module:][+switch-window]]
- [[doom-package:][winum]] if [[doom-module:][+numbers]]
- [[doom-package:ace-window]] unless [[doom-module:+switch-window]]
- [[doom-package:switch-window]] if [[doom-module:+switch-window]]
- [[doom-package:winum]] if [[doom-module:+numbers]]
** Hacks
/No hacks documented for this module./
@ -52,7 +52,7 @@ desired. Evil users can jump to window N in [[kbd:][C-w <N>]] (where N is a numb
#+end_quote
This module provides two backends, both providing the same functionality, but
with different visual cues. They are [[doom-package:][ace-window]] and [[doom-package:][switch-window]].
with different visual cues. They are [[doom-package:ace-window]] and [[doom-package:switch-window]].
** ace-window
The first character of the buffers changes to a highlighted, user-selectable

View file

@ -4,7 +4,7 @@
#+since: 2.0.0
* Description :unfold:
This module adds support for workspaces, powered by [[doom-package:][persp-mode]], as well as a API
This module adds support for workspaces, powered by [[doom-package:persp-mode]], as well as a API
for manipulating them.
#+begin_quote
@ -25,7 +25,7 @@ for manipulating them.
/This module has no flags./
** Packages
- [[doom-package:][persp-mode]]
- [[doom-package:persp-mode]]
** TODO Hacks
#+begin_quote

View file

@ -6,7 +6,7 @@
* Description :unfold:
This module provides two minor modes that make Emacs into a more comfortable
writing or coding environment. Folks familiar with "distraction-free" or "zen"
modes from other editors -- or [[doom-package:][olivetti]], [[doom-package:][sublimity]], and [[doom-package:][tabula-rasa]] (Emacs
modes from other editors -- or [[doom-package:olivetti]], [[doom-package:sublimity]], and [[doom-package:tabula-rasa]] (Emacs
plugins) -- will feel right at home.
These modes are:
@ -33,8 +33,8 @@ These modes are:
/This module has no flags./
** Packages
- [[doom-package:][mixed-pitch]]
- [[doom-package:][writeroom-mode]]
- [[doom-package:mixed-pitch]]
- [[doom-package:writeroom-mode]]
** Hacks
+ Doom has disabled all of writeroom-mode's "global" effects