docs: change link format
This commit is contained in:
TEC
Henrik Lissner
parent
58fb83c98e
commit
5ac2a5258b
160 changed files with 1161 additions and 1152 deletions
|
|
@ -17,24 +17,24 @@ This holy module brings the Vim editing model to Emacs.
|
|||
as a foundation.
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][evil]]
|
||||
- [[doom-package:][evil-args]]
|
||||
- [[doom-package:][evil-collection]] if [[doom-module:][+everywhere]]
|
||||
- [[doom-package:][evil-easymotion]]
|
||||
- [[doom-package:][evil-embrace]]
|
||||
- [[doom-package:][evil-escape]]
|
||||
- [[doom-package:][evil-exchange]]
|
||||
- [[doom-package:][evil-indent-plus]]
|
||||
- [[doom-package:][evil-lion]]
|
||||
- [[doom-package:][evil-nerd-commentary]]
|
||||
- [[doom-package:][evil-numbers]]
|
||||
- [[doom-package:][evil-quick-diff]]
|
||||
- [[doom-package:][evil-snipe]]
|
||||
- [[doom-package:][evil-surround]]
|
||||
- [[doom-package:][evil-textobj-anyblock]]
|
||||
- [[doom-package:][evil-vimish-fold]]
|
||||
- [[doom-package:][evil-visualstar]]
|
||||
- [[doom-package:][exato]]
|
||||
- [[doom-package:evil]]
|
||||
- [[doom-package:evil-args]]
|
||||
- [[doom-package:evil-collection]] if [[doom-module:+everywhere]]
|
||||
- [[doom-package:evil-easymotion]]
|
||||
- [[doom-package:evil-embrace]]
|
||||
- [[doom-package:evil-escape]]
|
||||
- [[doom-package:evil-exchange]]
|
||||
- [[doom-package:evil-indent-plus]]
|
||||
- [[doom-package:evil-lion]]
|
||||
- [[doom-package:evil-nerd-commentary]]
|
||||
- [[doom-package:evil-numbers]]
|
||||
- [[doom-package:evil-quick-diff]]
|
||||
- [[doom-package:evil-snipe]]
|
||||
- [[doom-package:evil-surround]]
|
||||
- [[doom-package:evil-textobj-anyblock]]
|
||||
- [[doom-package:evil-vimish-fold]]
|
||||
- [[doom-package:evil-visualstar]]
|
||||
- [[doom-package:exato]]
|
||||
|
||||
** Hacks
|
||||
- The o/O keys will respect and continue commented lines (can be disabled by
|
||||
|
|
@ -76,11 +76,11 @@ The following vim plugins have been ported to evil:
|
|||
This module has also ported vim-unimpaired keybinds to Emacs.
|
||||
|
||||
In other modules:
|
||||
- The [[doom-module:][:ui neotree]] & [[doom-module:][:ui treemacs]] modules provide a =NERDTree= equivalent.
|
||||
- The [[doom-module:][:editor multiple-cursors]] module contains functionality equal to the
|
||||
- The [[doom-module::ui neotree]] & [[doom-module::ui treemacs]] modules provide a =NERDTree= equivalent.
|
||||
- The [[doom-module::editor multiple-cursors]] module contains functionality equal to the
|
||||
following vim plugins:
|
||||
- [[doom-package:][evil-multiedit]] => [[github:hlissner/vim-multiedit][vim-multiedit]]
|
||||
- [[doom-package:][evil-mc]] => [[https://github.com/terryma/vim-multiple-cursors][vim-multiple-cursors]]
|
||||
- [[doom-package:evil-multiedit]] => [[github:hlissner/vim-multiedit][vim-multiedit]]
|
||||
- [[doom-package:evil-mc]] => [[https://github.com/terryma/vim-multiple-cursors][vim-multiple-cursors]]
|
||||
|
||||
** Custom Text Objects
|
||||
This module provides a couple extra text objects, along with the built-in ones.
|
||||
|
|
@ -157,13 +157,13 @@ To undo this, use:
|
|||
#+end_src
|
||||
|
||||
** The [[kbd:][s]]/[[kbd:][S]] keys behave differently from Vim
|
||||
Doom replaces the [[kbd:][s]] and [[kbd:][S]] keys with the [[doom-package:][evil-snipe]] package (a port of
|
||||
Doom replaces the [[kbd:][s]] and [[kbd:][S]] keys with the [[doom-package:evil-snipe]] package (a port of
|
||||
vim-seek/vim-sneak for 2-character versions of f/F/t/T).
|
||||
|
||||
To disable evil-snipe on s/S, you can either:
|
||||
1. Disable ~evil-snipe-mode~ by adding ~(remove-hook 'doom-first-input-hook
|
||||
#'evil-snipe-mode)~ to =$DOOMDIR/config.el=,
|
||||
2. Or disable [[doom-package:][evil-snipe]] completely with ~(package! evil-snipe :disable t)~
|
||||
2. Or disable [[doom-package:evil-snipe]] completely with ~(package! evil-snipe :disable t)~
|
||||
added to =$DOOMDIR/packages.el=, but this will also disable incremental
|
||||
highlighting for the f/F/t/T motions keys.
|
||||
3. Or use [[kbd:][cl]] and [[kbd:][cc]], respectively; they do the same thing.
|
||||
|
|
@ -198,7 +198,7 @@ If you prefer the old behavior, it can be reversed with:
|
|||
#+end_quote
|
||||
|
||||
Evil-specific configuration and keybindings (defined with ~map!~) will be
|
||||
ignored without [[doom-module:][:editor evil]] present (and omitted when byte-compiling).
|
||||
ignored without [[doom-module::editor evil]] present (and omitted when byte-compiling).
|
||||
|
||||
** Include underscores in evil word motions?
|
||||
A more in-depth answer and explanation for this can be found [[https://evil.readthedocs.io/en/latest/faq.html#underscore-is-not-a-word-character][in Evil's
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
#+since: 2.0.0
|
||||
|
||||
* Description :unfold:
|
||||
This module adds file templates for blank files, powered by [[doom-package:][yasnippet]].
|
||||
This module adds file templates for blank files, powered by [[doom-package:yasnippet]].
|
||||
|
||||
** Maintainers
|
||||
- [[doom-user:][@hlissner]]
|
||||
|
|
@ -18,7 +18,7 @@ This module adds file templates for blank files, powered by [[doom-package:][yas
|
|||
/This module doesn't install any packages./
|
||||
|
||||
** Hacks
|
||||
- [[doom-package:][yasnippet]]
|
||||
- [[doom-package:yasnippet]]
|
||||
|
||||
** TODO Changelog
|
||||
# This section will be machine generated. Don't edit it by hand.
|
||||
|
|
@ -60,13 +60,13 @@ A special command is available for inserting software licenses: ~M-x
|
|||
New file templates can be added to
|
||||
=$DOOMDIR/snippets/{major-mode}/{snippet-name}=. The yasnippet documentation
|
||||
covers [[https://joaotavora.github.io/yasnippet/snippet-development.html][how to write a snippet]]. You can map a snippet to a file path, major mode,
|
||||
or another arbitrary predicate using [[fn:][set-file-template!]].
|
||||
or another arbitrary predicate using [[fn:set-file-template!]].
|
||||
|
||||
Look into its documentation with [[kbd:][<help> f set-file-template\!]].
|
||||
|
||||
** Adding new OSS licenses
|
||||
Add snippet files to =$DOOMDIR/snippets/text-mode/= with the =__licenses-=
|
||||
prefix and [[fn:][+file-templates/insert-license]] will recognize them. E.g.
|
||||
prefix and [[fn:+file-templates/insert-license]] will recognize them. E.g.
|
||||
=$DOOMDIR/snippets/text-mode/__license-mit=.
|
||||
|
||||
* Troubleshooting
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ the purpose of the module and the features/technology(ies) it provides.
|
|||
Display X in a [[https://www.gnu.org/software/emacs/manual/html_node/elisp/Child-Frames.html][child frame]] rather than an overlay or tooltip. *Requires GUI
|
||||
Emacs.*
|
||||
- +lsp ::
|
||||
Enable LSP support for ~X-mode~. Requires [[doom-module:][:tools lsp]] and a
|
||||
Enable LSP support for ~X-mode~. Requires [[doom-module::tools lsp]] and a
|
||||
langserver (supports A, B, and C).
|
||||
|
||||
# If this module has no flags, then...
|
||||
|
|
@ -52,13 +52,13 @@ the purpose of the module and the features/technology(ies) it provides.
|
|||
#+end_quote
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][org]]
|
||||
- [[doom-package:][org-contrib]] if [[doom-module:][+contrib]]
|
||||
- [[doom-package:][org-bullets]] unless [[doom-module:][+bullets]]
|
||||
- if [[doom-module:][+present]]
|
||||
- [[doom-package:][centered-window]]
|
||||
- [[doom-package:][org-tree-slide]]
|
||||
- [[doom-package:][org-re-reveal]]
|
||||
- [[doom-package:org]]
|
||||
- [[doom-package:org-contrib]] if [[doom-module:+contrib]]
|
||||
- [[doom-package:org-bullets]] unless [[doom-module:+bullets]]
|
||||
- if [[doom-module:+present]]
|
||||
- [[doom-package:centered-window]]
|
||||
- [[doom-package:org-tree-slide]]
|
||||
- [[doom-package:org-re-reveal]]
|
||||
|
||||
# If this module installs no packages, then...
|
||||
/This module doesn't install any packages./
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
#+since: 21.12.0
|
||||
|
||||
* Description :unfold:
|
||||
This module marries [[doom-package:][hideshow]], [[doom-package:][vimish-fold]], and ~outline-minor-mode~ to bring you
|
||||
This module marries [[doom-package:hideshow]], [[doom-package:vimish-fold]], and ~outline-minor-mode~ to bring you
|
||||
marker, indent and syntax-based code folding for as many languages as possible.
|
||||
|
||||
** Maintainers
|
||||
|
|
@ -16,10 +16,10 @@ marker, indent and syntax-based code folding for as many languages as possible.
|
|||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][evil-vimish-fold]]
|
||||
- [[doom-package:][vimish-fold]]
|
||||
- if [[doom-module:][:tools tree-sitter]]
|
||||
- [[doom-package:][ts-fold]]
|
||||
- [[doom-package:evil-vimish-fold]]
|
||||
- [[doom-package:vimish-fold]]
|
||||
- if [[doom-module::tools tree-sitter]]
|
||||
- [[doom-package:ts-fold]]
|
||||
|
||||
** TODO Hacks
|
||||
#+begin_quote
|
||||
|
|
@ -40,7 +40,7 @@ marker, indent and syntax-based code folding for as many languages as possible.
|
|||
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
Emacs keybinds when [[doom-module:][:editor evil +everywhere]] is disabled:
|
||||
Emacs keybinds when [[doom-module::editor evil +everywhere]] is disabled:
|
||||
| Keybind | Description |
|
||||
|--------------------+---------------------------|
|
||||
| [[kbd:][C-c C-f C-f]] | Fold region |
|
||||
|
|
|
|||
|
|
@ -27,11 +27,11 @@ rustfmt, scalafmt, script shfmt, snakefmt, sqlformat, styler, swiftformat, tidy
|
|||
** Module flags
|
||||
- +onsave ::
|
||||
Enable reformatting of a buffer when it is saved. See
|
||||
[[var:][+format-on-save-enabled-modes]] to control what major modes to (or not to)
|
||||
[[var:+format-on-save-enabled-modes]] to control what major modes to (or not to)
|
||||
format on save.
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][format-all]]
|
||||
- [[doom-package:format-all]]
|
||||
|
||||
** Hacks
|
||||
- format-all has been heavily modified to suit Doom's goals for this module:
|
||||
|
|
@ -39,7 +39,7 @@ rustfmt, scalafmt, script shfmt, snakefmt, sqlformat, styler, swiftformat, tidy
|
|||
affect on cursor position.
|
||||
- Adds partial formatting, i.e. you can now reformat a subset of the buffer.
|
||||
- Adds the ability to use any arbitrary formatter on the current buffer if you
|
||||
pass the universal argument to [[fn:][+format/buffer]] or [[fn:][+format/region]] (i.e.
|
||||
pass the universal argument to [[fn:+format/buffer]] or [[fn:+format/region]] (i.e.
|
||||
removes the major-mode lock on formatters).
|
||||
|
||||
** TODO Changelog
|
||||
|
|
@ -51,7 +51,7 @@ rustfmt, scalafmt, script shfmt, snakefmt, sqlformat, styler, swiftformat, tidy
|
|||
|
||||
This module has no direct requirements, but each language will need one of their
|
||||
supported formatter programs in order for this to work. In their absence,
|
||||
[[doom-package:][format-all]] will fail silently.
|
||||
[[doom-package:format-all]] will fail silently.
|
||||
|
||||
Supported formatters:
|
||||
- Angular/Vue (prettier)
|
||||
|
|
@ -137,7 +137,7 @@ default value:
|
|||
|
||||
If you want to format code when you save a buffer, but want more granular
|
||||
control over which major modes this behavior is enabled in, there is an
|
||||
alternative. Make sure [[doom-module:][+onsave]] is disabled before you try this:
|
||||
alternative. Make sure [[doom-module:+onsave]] is disabled before you try this:
|
||||
#+begin_src emacs-lisp
|
||||
(add-hook 'python-mode-hook #'format-all-mode)
|
||||
(add-hook 'js2-mode-hook #'format-all-mode)
|
||||
|
|
@ -145,7 +145,7 @@ alternative. Make sure [[doom-module:][+onsave]] is disabled before you try this
|
|||
|
||||
** Disabling the LSP formatter
|
||||
If you are in a buffer with ~lsp-mode~ enabled and a server that supports
|
||||
=textDocument/formatting=, it will be used instead of [[doom-package:][format-all]]'s formatter.
|
||||
=textDocument/formatting=, it will be used instead of [[doom-package:format-all]]'s formatter.
|
||||
|
||||
+ To disable this behavior universally use: ~(setq +format-with-lsp nil)~
|
||||
+ To disable this behavior in one mode: ~(setq-hook! 'python-mode-hook
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
#+end_quote
|
||||
|
||||
* Description :unfold:
|
||||
Adds [[doom-package:][god-mode]] support to Doom Emacs, allowing for entering commands without
|
||||
Adds [[doom-package:god-mode]] support to Doom Emacs, allowing for entering commands without
|
||||
modifier keys, similar to Vim's modality, separating command mode and insert
|
||||
mode.
|
||||
|
||||
|
|
@ -19,7 +19,7 @@ mode.
|
|||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][god-mode]]
|
||||
- [[doom-package:god-mode]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
|||
|
|
@ -24,8 +24,8 @@ languages:
|
|||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][lispy]]
|
||||
- [[doom-package:][lispyville]] if [[doom-module:][:editor evil +everywhere]]
|
||||
- [[doom-package:lispy]]
|
||||
- [[doom-package:lispyville]] if [[doom-module::editor evil +everywhere]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
@ -44,8 +44,8 @@ languages:
|
|||
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
If [[doom-module:][:editor evil]] is enabled, [[doom-package:][lispyville]] would also be activated for every mode
|
||||
where [[doom-package:][lispy]] is active.
|
||||
If [[doom-module::editor evil]] is enabled, [[doom-package:lispyville]] would also be activated for every mode
|
||||
where [[doom-package:lispy]] is active.
|
||||
|
||||
* TODO Configuration
|
||||
#+begin_quote
|
||||
|
|
|
|||
|
|
@ -16,17 +16,17 @@ evil) that loosely take after multi-cursors in Atom or Sublime Text.
|
|||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- if [[doom-module:][:editor evil]]
|
||||
- [[doom-package:][evil-multiedit]]
|
||||
- [[doom-package:][evil-mc]]
|
||||
- if [[doom-module::editor evil]]
|
||||
- [[doom-package:evil-multiedit]]
|
||||
- [[doom-package:evil-mc]]
|
||||
- else
|
||||
- [[doom-package:][multiple-cursors]]
|
||||
- [[doom-package:multiple-cursors]]
|
||||
|
||||
** Hacks
|
||||
- Attempts to smooth over [[doom-package:][multiple-cursors]]' incompatibilities with [[doom-package:][evil]], which
|
||||
- Attempts to smooth over [[doom-package:multiple-cursors]]' incompatibilities with [[doom-package:evil]], which
|
||||
is used internally in some third party plugins.
|
||||
- Attempts to smooth over [[doom-package:][evil-mc]]'s incompatibilities with other packages, like
|
||||
[[doom-package:][lispy]].
|
||||
- Attempts to smooth over [[doom-package:evil-mc]]'s incompatibilities with other packages, like
|
||||
[[doom-package:lispy]].
|
||||
|
||||
** TODO Changelog
|
||||
# This section will be machine generated. Don't edit it by hand.
|
||||
|
|
@ -43,7 +43,7 @@ evil) that loosely take after multi-cursors in Atom or Sublime Text.
|
|||
#+end_quote
|
||||
|
||||
** evil-mc
|
||||
- The [[doom-package:][evil-mc]] keys are under the [[kbd:][gz]] prefix, e.g.
|
||||
- The [[doom-package:evil-mc]] keys are under the [[kbd:][gz]] prefix, e.g.
|
||||
- [[kbd:][gzz]] to toggle new (frozen) cursors at point.
|
||||
- [[kbd:][gzt]] to toggle mirroring on and off (or switch to insert mode to activate
|
||||
them).
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
#+since: 21.12.0
|
||||
|
||||
* Description :unfold:
|
||||
This modules adds [[doom-package:][objed]], a global minor-mode for navigating and manipulating
|
||||
This modules adds [[doom-package:objed]], a global minor-mode for navigating and manipulating
|
||||
text objects. It combines the ideas of ~versor-mode~ and other editors like Vim
|
||||
or Kakoune and tries to align them with regular Emacs conventions.
|
||||
|
||||
|
|
@ -15,11 +15,11 @@ or Kakoune and tries to align them with regular Emacs conventions.
|
|||
|
||||
** Module flags
|
||||
- +manual ::
|
||||
Don't activate [[doom-package:][objed]] at startup, automatically, leaving it to the user to call
|
||||
[[fn:][objed-activate]] (bound to [[kbd:][M-SPC]] if using [[doom-module:][:config default +bindings]]).
|
||||
Don't activate [[doom-package:objed]] at startup, automatically, leaving it to the user to call
|
||||
[[fn:objed-activate]] (bound to [[kbd:][M-SPC]] if using [[doom-module::config default +bindings]]).
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][objed]]
|
||||
- [[doom-package:objed]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
@ -34,7 +34,7 @@ or Kakoune and tries to align them with regular Emacs conventions.
|
|||
/This module has no external requirements./
|
||||
|
||||
#+begin_quote
|
||||
🚧 This module is incompatible with [[doom-module:][:editor evil]]. Do not enable them both at
|
||||
🚧 This module is incompatible with [[doom-module::editor evil]]. Do not enable them both at
|
||||
the same time or you will get errors.
|
||||
#+end_quote
|
||||
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ balanced and beautiful.
|
|||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][parinfer-rust-mode]]
|
||||
- [[doom-package:parinfer-rust-mode]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ keywords or text patterns at point, like ~true~ and ~false~, or ~public~,
|
|||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][rotate-text]]
|
||||
- [[doom-package:rotate-text]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
#+since: 2.0.0
|
||||
|
||||
* Description :unfold:
|
||||
This module adds snippet expansions to Emacs, powered by [[doom-package:][yasnippet]].
|
||||
This module adds snippet expansions to Emacs, powered by [[doom-package:yasnippet]].
|
||||
|
||||
** Maintainers
|
||||
- [[doom-user:][@hlissner]]
|
||||
|
|
@ -15,9 +15,9 @@ This module adds snippet expansions to Emacs, powered by [[doom-package:][yasnip
|
|||
/This module exposes no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][yasnippet]]
|
||||
- [[doom-package:][auto-yasnippet]]
|
||||
- [[doom-package:][doom-snippets]]
|
||||
- [[doom-package:yasnippet]]
|
||||
- [[doom-package:auto-yasnippet]]
|
||||
- [[doom-package:doom-snippets]]
|
||||
|
||||
** TODO Hacks
|
||||
#+begin_quote
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
#+since: 21.12.0 (#1709)
|
||||
|
||||
* Description :unfold:
|
||||
This module adds a minor-mode [[fn:][+word-wrap-mode]], which intelligently wraps long
|
||||
This module adds a minor-mode [[fn:+word-wrap-mode]], which intelligently wraps long
|
||||
lines in the buffer without modifying the buffer content.
|
||||
|
||||
** Maintainers
|
||||
|
|
@ -16,7 +16,7 @@ lines in the buffer without modifying the buffer content.
|
|||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][adaptive-wrap]]
|
||||
- [[doom-package:adaptive-wrap]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue