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
|
|
@ -5,7 +5,7 @@
|
|||
|
||||
* Description :unfold:
|
||||
This module provides code completion, powered by [[https://github.com/company-mode/company-mode][company-mode]]. Many of Doom's
|
||||
[[doom-module:][:lang]] modules require it for "intellisense" functionality.
|
||||
[[doom-module::lang]] modules require it for "intellisense" functionality.
|
||||
|
||||
https://assets.doomemacs.org/completion/company/overlay.png
|
||||
|
||||
|
|
@ -23,9 +23,9 @@ https://assets.doomemacs.org/completion/company/overlay.png
|
|||
[[kbd:][S-TAB]] will navigate the completion candidates.
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][company-box]] if [[doom-module:][+childframe]]
|
||||
- [[doom-package:][company-dict]]
|
||||
- [[doom-package:][company-mode]]
|
||||
- [[doom-package:company-box]] if [[doom-module:+childframe]]
|
||||
- [[doom-package:company-dict]]
|
||||
- [[doom-package:company-mode]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
|||
|
|
@ -18,21 +18,21 @@ as a unified interface for project search and replace, powered by [[https://gith
|
|||
Enable fuzzy completion for Helm searches.
|
||||
- +icons ::
|
||||
Display icons on completion results (where possible) using either
|
||||
[[doom-package:][all-the-icons]] or [[doom-package:][treemacs]] iconsets.
|
||||
[[doom-package:all-the-icons]] or [[doom-package:treemacs]] iconsets.
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][helm]]
|
||||
- [[doom-package:][helm-company]]
|
||||
- [[doom-package:][helm-c-yasnippet]]
|
||||
- [[doom-package:][helm-descbinds]]
|
||||
- [[doom-package:][helm-describe-modes]]
|
||||
- [[doom-package:][helm-flx]]* if [[doom-module:][+fuzzy]]
|
||||
- [[doom-package:][helm-icons]]* if [[doom-module:][+icons]]
|
||||
- [[doom-package:][helm-org]]* if [[doom-module:][:lang org]]
|
||||
- [[doom-package:][helm-posframe]]* if [[doom-module:][+childframe]]
|
||||
- [[doom-package:][helm-projectile]]
|
||||
- [[doom-package:][helm-rg]]
|
||||
- [[doom-package:][helm-swiper]]
|
||||
- [[doom-package:helm]]
|
||||
- [[doom-package:helm-company]]
|
||||
- [[doom-package:helm-c-yasnippet]]
|
||||
- [[doom-package:helm-descbinds]]
|
||||
- [[doom-package:helm-describe-modes]]
|
||||
- [[doom-package:helm-flx]]* if [[doom-module:+fuzzy]]
|
||||
- [[doom-package:helm-icons]]* if [[doom-module:+icons]]
|
||||
- [[doom-package:helm-org]]* if [[doom-module::lang org]]
|
||||
- [[doom-package:helm-posframe]]* if [[doom-module:+childframe]]
|
||||
- [[doom-package:helm-projectile]]
|
||||
- [[doom-package:helm-rg]]
|
||||
- [[doom-package:helm-swiper]]
|
||||
|
||||
** TODO Hacks
|
||||
#+begin_quote
|
||||
|
|
@ -59,13 +59,13 @@ Helm command or plugin.
|
|||
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
Much like [[doom-package:][ivy]] and [[doom-package:][vertico]], [[doom-package:][helm]] is a /large/ framework. Covering all its
|
||||
Much like [[doom-package:ivy]] and [[doom-package:vertico]], [[doom-package:helm]] is a /large/ framework. Covering all its
|
||||
features is not within the scope of this module's documentation, so only its
|
||||
highlights will be covered here.
|
||||
|
||||
** Jump-to navigation
|
||||
Similar to Ivy, this module provides an interface to navigate within a project
|
||||
using [[doom-package:][projectile]]:
|
||||
using [[doom-package:projectile]]:
|
||||
| Keybind | Description |
|
||||
|------------------+-------------------------------------|
|
||||
| [[kbd:][SPC p f]], [[kbd:][SPC SPC]] | Jump to file in project |
|
||||
|
|
@ -109,7 +109,7 @@ Changes to the resulting wgrep buffer (opened by [[kbd:][C-c C-e]]) can be commi
|
|||
[[kbd:][C-c C-c]] and aborted with [[kbd:][C-c C-k]] (alternatively [[kbd:][ZZ]] and [[kbd:][ZQ]], for evil users).
|
||||
|
||||
** In-buffer searching
|
||||
The [[doom-package:][swiper]] package provides an interactive buffer search powered by helm. It can
|
||||
The [[doom-package:swiper]] package provides an interactive buffer search powered by helm. It can
|
||||
be invoked with:
|
||||
- [[kbd:][SPC s s]] (~swiper-isearch~)
|
||||
- [[kbd:][SPC s S]] (~swiper-isearch-thing-at-point~)
|
||||
|
|
@ -156,8 +156,8 @@ Helm also has a number of overrides for built-in functionality:
|
|||
#+end_quote
|
||||
|
||||
** Icons
|
||||
Icon support is now included, through one of two providers: [[doom-package:][all-the-icons]] and
|
||||
[[doom-package:][treemacs]]. By default, to maintain consistency we use [[doom-package:][all-the-icons]]; however if
|
||||
Icon support is now included, through one of two providers: [[doom-package:all-the-icons]] and
|
||||
[[doom-package:treemacs]]. By default, to maintain consistency we use [[doom-package:all-the-icons]]; however if
|
||||
you wish to modify this you can do so using the below snippet:
|
||||
|
||||
#+begin_src emacs-lisp
|
||||
|
|
|
|||
|
|
@ -13,11 +13,11 @@ Interactive DO things. The completion engine that is /mostly/ built-into Emacs.
|
|||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][crm-custom]]
|
||||
- [[doom-package:][flx-ido]]
|
||||
- [[doom-package:][ido-completing-read+]]
|
||||
- [[doom-package:][ido-sort-mtime]]
|
||||
- [[doom-package:][ido-vertical-mode]]
|
||||
- [[doom-package:crm-custom]]
|
||||
- [[doom-package:flx-ido]]
|
||||
- [[doom-package:ido-completing-read+]]
|
||||
- [[doom-package:ido-sort-mtime]]
|
||||
- [[doom-package:ido-vertical-mode]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
|
|||
|
|
@ -27,18 +27,18 @@ lighter, simpler and faster in many cases.
|
|||
Enable prescient filtering and sorting for Ivy searches.
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][all-the-icons-ivy]]* if [[doom-module:][+icons]]
|
||||
- [[doom-package:][amx]]
|
||||
- [[doom-package:][counsel]]
|
||||
- [[doom-package:][counsel-projectile]]
|
||||
- [[doom-package:][flx]]* if [[doom-module:][+fuzzy]]
|
||||
- [[doom-package:][ivy]]
|
||||
- [[doom-package:][ivy-hydra]]
|
||||
- [[doom-package:][ivy-posframe]]* if [[doom-module:][+childframe]]
|
||||
- [[doom-package:][ivy-rich]]
|
||||
- [[doom-package:][prescient]]* if [[doom-module:][+prescient]]
|
||||
- [[doom-package:][swiper]]
|
||||
- [[doom-package:][wgrep]]
|
||||
- [[doom-package:all-the-icons-ivy]]* if [[doom-module:+icons]]
|
||||
- [[doom-package:amx]]
|
||||
- [[doom-package:counsel]]
|
||||
- [[doom-package:counsel-projectile]]
|
||||
- [[doom-package:flx]]* if [[doom-module:+fuzzy]]
|
||||
- [[doom-package:ivy]]
|
||||
- [[doom-package:ivy-hydra]]
|
||||
- [[doom-package:ivy-posframe]]* if [[doom-module:+childframe]]
|
||||
- [[doom-package:ivy-rich]]
|
||||
- [[doom-package:prescient]]* if [[doom-module:+prescient]]
|
||||
- [[doom-package:swiper]]
|
||||
- [[doom-package:wgrep]]
|
||||
|
||||
** Hacks
|
||||
- Functions with ivy/counsel equivalents have been globally remapped (like
|
||||
|
|
@ -67,14 +67,14 @@ use their associated Helm command or plugin.
|
|||
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
[[doom-package:][ivy]] is a /large/ framework for completing things. Covering all its features is
|
||||
[[doom-package:ivy]] is a /large/ framework for completing things. Covering all its features is
|
||||
not within the scope of this module's documentation, so only its highlights will
|
||||
be covered here.
|
||||
|
||||
** Jump-to navigation
|
||||
Inspired by Sublime Text's jump-to-anywhere, CtrlP/Unite in Vim, and Textmate's
|
||||
Command-T, this module provides similar functionality by bringing [[doom-package:][projectile]] and
|
||||
[[doom-package:][ivy]] together.
|
||||
Command-T, this module provides similar functionality by bringing [[doom-package:projectile]] and
|
||||
[[doom-package:ivy]] together.
|
||||
|
||||
https://assets.doomemacs.org/completion/ivy/projectile.png
|
||||
|
||||
|
|
@ -125,7 +125,7 @@ Changes to the resulting wgrep buffer (opened by [[kbd:][C-c C-e]]) can be commi
|
|||
https://assets.doomemacs.org/completion/ivy/search-replace.png
|
||||
|
||||
** In-buffer searching
|
||||
The [[doom-package:][swiper]] package provides an interactive buffer search powered by ivy. It
|
||||
The [[doom-package:swiper]] package provides an interactive buffer search powered by ivy. It
|
||||
can be invoked with:
|
||||
|
||||
- [[kbd:][SPC s s]] (~swiper-isearch~)
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ provides a united interface for project search and replace, powered by [[https:/
|
|||
|
||||
It does this with several modular packages focused on enhancing the built-in
|
||||
~completing-read~ interface, rather than replacing it with a parallel ecosystem
|
||||
like [[doom-package:][ivy]] and [[doom-package:][helm]] do. The primary packages are:
|
||||
like [[doom-package:ivy]] and [[doom-package:helm]] do. The primary packages are:
|
||||
|
||||
- Vertico, which provides the vertical completion user interface
|
||||
- Consult, which provides a suite of useful commands using ~completing-read~
|
||||
|
|
@ -31,16 +31,16 @@ like [[doom-package:][ivy]] and [[doom-package:][helm]] do. The primary packages
|
|||
Add icons to =file= and =buffer= category completion selections.
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][all-the-icons-completion]] if [[doom-module:][+icons]]
|
||||
- [[doom-package:][consult]]
|
||||
- [[doom-package:][consult-flycheck]] if [[doom-module:][:checkers syntax]]
|
||||
- [[doom-package:][embark]]
|
||||
- [[doom-package:][embark-consult]]
|
||||
- [[doom-package:][marginalia]]
|
||||
- [[doom-package:][orderless]]
|
||||
- [[doom-package:][vertico]]
|
||||
- [[doom-package:][vertico-posframe]] if [[doom-module:][+childframe]]
|
||||
- [[doom-package:][wgrep]]
|
||||
- [[doom-package:all-the-icons-completion]] if [[doom-module:+icons]]
|
||||
- [[doom-package:consult]]
|
||||
- [[doom-package:consult-flycheck]] if [[doom-module::checkers syntax]]
|
||||
- [[doom-package:embark]]
|
||||
- [[doom-package:embark-consult]]
|
||||
- [[doom-package:marginalia]]
|
||||
- [[doom-package:orderless]]
|
||||
- [[doom-package:vertico]]
|
||||
- [[doom-package:vertico-posframe]] if [[doom-module:+childframe]]
|
||||
- [[doom-package:wgrep]]
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
|
@ -95,7 +95,7 @@ due to Marginalia annotations.
|
|||
|
||||
** Jump-to navigation
|
||||
This module provides an interface to navigate within a project using
|
||||
[[doom-package:][projectile]]:
|
||||
[[doom-package:projectile]]:
|
||||
|
||||
https://assets.doomemacs.org/completion/vertico/projectile.png
|
||||
|
||||
|
|
@ -135,8 +135,8 @@ commands.
|
|||
On top of the usual Vertico keybindings, search commands also offer support for
|
||||
exporting the current candidate list to an editable buffer [[kbd:][C-c C-e]]. After
|
||||
editing the changes can be committed with [[kbd:][C-c C-c]] and aborted with [[kbd:][C-c C-k]]
|
||||
(alternatively [[kbd:][ZZ]] and [[kbd:][ZQ]], for evil users). It uses [[doom-package:][wgrep]] for grep searches,
|
||||
[[doom-package:][wdired]] for file searches, and =occur= for buffer searches.
|
||||
(alternatively [[kbd:][ZZ]] and [[kbd:][ZQ]], for evil users). It uses [[doom-package:wgrep]] for grep searches,
|
||||
[[doom-package:wdired]] for file searches, and =occur= for buffer searches.
|
||||
|
||||
https://assets.doomemacs.org/completion/vertico/search-replace.png
|
||||
|
||||
|
|
@ -213,7 +213,7 @@ Consult async commands (e.g. ~consult-ripgrep~) will have a preceding separator
|
|||
character (usually ~#~) before the search input. This is known as the =perl=
|
||||
splitting style. Input typed after the separator will be fed to the async
|
||||
command until you type a second seperator, afterwhich the candidate list will be
|
||||
filtered with Emacs instead (and can be filtered using [[doom-package:][orderless]], for example).
|
||||
filtered with Emacs instead (and can be filtered using [[doom-package:orderless]], for example).
|
||||
The specific seperator character can be changed by editing it, and might be
|
||||
different if the initial input already contains =#=.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue