emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs: change link format

Browse source
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
Download patch file Download diff file Expand all files Collapse all files

10
modules/tools/ansible/README.org
View file

@ -13,11 +13,11 @@
/This module has no flags./
** Packages
- [[doom-package:][ansible]]
- [[doom-package:][ansible-doc]]
- [[doom-package:][company-ansible]] if [[doom-module:][:completion company]]
- [[doom-package:][jinja2-mode]]
- [[doom-package:][yaml-mode]]
- [[doom-package:ansible]]
- [[doom-package:ansible-doc]]
- [[doom-package:company-ansible]] if [[doom-module::completion company]]
- [[doom-package:jinja2-mode]]
- [[doom-package:yaml-mode]]
** Hacks
/No hacks documented for this module./

35
modules/tools/biblio/README.org
View file

@ -19,12 +19,12 @@ selected so it should be possible to use without modifications.
/This module has no flags./
** Packages
- [[doom-package:][bibtex-completion]] if [[doom-module:][:completion ivy]] or [[doom-module:][:completion helm]]
- [[doom-package:][parsebib]] if [[doom-module:][:completion ivy]] or [[doom-module:][:completion helm]] or [[doom-module:][:completion vertico]]
- [[doom-package:][citar]] if [[doom-module:][:completion vertico]]
- [[doom-package:][citar-embark]] if [[doom-module:][:completion vertico]]
- [[doom-package:][helm-bibtex]] if [[doom-module:][:completion helm]]
- [[doom-package:][ivy-bibtex]] if [[doom-module:][:completion ivy]]
- [[doom-package:bibtex-completion]] if [[doom-module::completion ivy]] or [[doom-module::completion helm]]
- [[doom-package:parsebib]] if [[doom-module::completion ivy]] or [[doom-module::completion helm]] or [[doom-module::completion vertico]]
- [[doom-package:citar]] if [[doom-module::completion vertico]]
- [[doom-package:citar-embark]] if [[doom-module::completion vertico]]
- [[doom-package:helm-bibtex]] if [[doom-module::completion helm]]
- [[doom-package:ivy-bibtex]] if [[doom-module::completion ivy]]
** Hacks
/No hacks documented for this module./
@ -37,19 +37,18 @@ selected so it should be possible to use without modifications.
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
There are no hard dependencies for this module, but this module can benefit from
having a PDF reader and one of Doom's [[doom-module:][:completion]] modules.
having a PDF reader and one of Doom's [[doom-module::completion]] modules.
** PDF viewing
An application for opening PDF files is required. By default =DocView= is used
though [[doom-module:][:tools pdf]] is highly recommended so PDFs can be viewed within Emacs.
though [[doom-module::tools pdf]] is highly recommended so PDFs can be viewed within Emacs.
** Bibtex completion
For vertico, helm, or ivy bibtex completion you should enable [[doom-module:][:completion
vertico]], [[doom-module:][:completion helm]], or [[doom-module:][:completion ivy]] respectively.
For vertico, helm, or ivy bibtex completion you should enable [[doom-module::completion vertico]], [[doom-module::completion helm]], or [[doom-module::completion ivy]] respectively.
* Usage
Both [[doom-package:][helm-bibtex]] (includes [[doom-package:][helm-bibtex]], [[doom-package:][ivy-bibtex]], and bibtex-completion code)
and [[doom-package:][citar]] provide an extensive range of features so it is best to check their
Both [[doom-package:helm-bibtex]] (includes [[doom-package:helm-bibtex]], [[doom-package:ivy-bibtex]], and bibtex-completion code)
and [[doom-package:citar]] provide an extensive range of features so it is best to check their
respective sites for a full list of features.
On a high-level you can expect:
@ -64,7 +63,7 @@ To understand the interaction between these packages this [[https://www.reddit.c
explain the unique features and the overlapping functionality, if any.
In addition, this module provides support for native Org-mode citations
([[doom-package:][org-cite]]).
([[doom-package:org-cite]]).
* Configuration
To override any defaults set by this module, do so in an ~(after! package ...)~
@ -72,7 +71,7 @@ block in =$DOOMDIR/config.el=.
** Org-cite
*** Processor configuration
[[doom-package:][org-cite]] provides rich features and flexible configuration options via its
[[doom-package:org-cite]] provides rich features and flexible configuration options via its
"processor" capabilities.
1. /insert/ provides =org-cite-insert= integration for inserting and editing
@ -83,7 +82,7 @@ block in =$DOOMDIR/config.el=.
This module makes the following processors available:
1. The core =oc-basic=, =oc-natbib=, =oc-biblatex=, and =oc-csl=.
2. [[doom-package:][citar]] for integration with [[doom-package:][vertico]] completion.
2. [[doom-package:citar]] for integration with [[doom-package:vertico]] completion.
The module configures these processors as follows for the different completion
modules:
@ -101,9 +100,9 @@ directory for your CSL styles:
#+end_src
** Path configuration
You must set the path variable for either [[doom-package:][citar]] (if using [[doom-module:][:completion vertico]])
or [[doom-package:][bibtex-completion]] (if using [[doom-module::completion ivy][ivy]] or [[doom-module::completion helm][helm]]); this module will in turn set the
[[var:][org-cite-global-bibliography]] variable to the same value:
You must set the path variable for either [[doom-package:citar]] (if using [[doom-module::completion vertico]])
or [[doom-package:bibtex-completion]] (if using [[doom-module::completion ivy][ivy]] or [[doom-module::completion helm][helm]]); this module will in turn set the
[[var:org-cite-global-bibliography]] variable to the same value:
#+begin_src emacs-lisp
(setq! bibtex-completion-bibliography '("/path/to/references.bib"))
#+end_src

14
modules/tools/debugger/README.org
View file

@ -4,9 +4,9 @@
#+since: 2.0.0
* Description :unfold:
Introduces a code debugger to Emacs, powered by [[doom-package:][realgud]] or [[doom-package:][dap-mode]] (LSP).
Introduces a code debugger to Emacs, powered by [[doom-package:realgud]] or [[doom-package:dap-mode]] (LSP).
This document will help you to configure [[doom-package:][dap-mode]] [[https://emacs-lsp.github.io/dap-mode/page/configuration/#native-debug-gdblldb][Native Debug(GDB/LLDB)]] as
This document will help you to configure [[doom-package:dap-mode]] [[https://emacs-lsp.github.io/dap-mode/page/configuration/#native-debug-gdblldb][Native Debug(GDB/LLDB)]] as
there is still not *enough* documentation for it.
** Maintainers
@ -17,11 +17,11 @@ there is still not *enough* documentation for it.
Enable support for [[https://microsoft.github.io/debug-adapter-protocol/][Debug Adapter Protocol]] (DAP) debuggers.
** Packages
- [[doom-package:][realgud]]
- [[doom-package:][realgud-trepan-ni]] if [[doom-module:][:lang javascript]]
- if [[doom-module:][+lsp]]
- [[doom-package:][dap-mode]]
- [[doom-package:][posframe]]
- [[doom-package:realgud]]
- [[doom-package:realgud-trepan-ni]] if [[doom-module::lang javascript]]
- if [[doom-module:+lsp]]
- [[doom-package:dap-mode]]
- [[doom-package:posframe]]
** TODO Hacks
#+begin_quote

4
modules/tools/direnv/README.org
View file

@ -27,7 +27,7 @@ This module integrates direnv into Emacs.
/This module has no flags./
** Packages
- [[doom-package:][envrc]]
- [[doom-package:envrc]]
** Hacks
- ~envrc-mode~ has been modified to fail gracefully if ~direnv~ isn't available.
@ -69,7 +69,7 @@ Or ~$ nix-env -i direnv~
#+end_quote
To make use of direnv you need a =.envrc= file in a directory. Any time you open
a file or buffer in said directory, the [[doom-package:][envrc]] Emacs package will kick in,
a file or buffer in said directory, the [[doom-package:envrc]] Emacs package will kick in,
activate the local env, and inject it into Emacs for the current buffer.
* TODO Configuration

8
modules/tools/docker/README.org
View file

@ -10,7 +10,7 @@ Emacs.
Provides a major ~dockerfile-mode~ to edit =Dockerfiles=. Additional convenience
functions allow images to be built easily.
[[doom-package:][docker-tramp]] offers [[https://www.gnu.org/software/tramp/][TRAMP]] support for Docker containers.
[[doom-package:docker-tramp]] offers [[https://www.gnu.org/software/tramp/][TRAMP]] support for Docker containers.
** Maintainers
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
@ -20,9 +20,9 @@ functions allow images to be built easily.
Enable integration for the Dockerfile Language Server.
** Packages
- [[doom-package:][docker]]
- [[doom-package:][docker-tramp]]
- [[doom-package:][dockerfile-mode]]
- [[doom-package:docker]]
- [[doom-package:docker-tramp]]
- [[doom-package:dockerfile-mode]]
** Hacks
/No hacks documented for this module./

6
modules/tools/editorconfig/README.org
View file

@ -17,7 +17,7 @@ specification]]).
/This module has no flags./
** Packages
- [[doom-package:][editorconfig-emacs]]
- [[doom-package:editorconfig-emacs]]
** Hacks
- Added logic to guess an extension-less file's type from its shebang line. For
@ -25,9 +25,9 @@ specification]]).
assuming its first line is ~#!/usr/bin/env python~. See
~+editorconfig-mode-alist~ for adding support for more languages.
- *Special integration for =dtrt-indent=:* If the local editorconfig file
specifies ~indent_style~ or ~indent_size~, the [[doom-package:][dtrt-indent]] (which tries to
specifies ~indent_style~ or ~indent_size~, the [[doom-package:dtrt-indent]] (which tries to
guess your indent settings by analyzing your text file) will bow out.
- *Special integration for =ws-butler=:* this module will use [[doom-package:][ws-butler]] to
- *Special integration for =ws-butler=:* this module will use [[doom-package:ws-butler]] to
enforce ~trim_trailing_whitespace~.
** TODO Changelog

2
modules/tools/ein/README.org
View file

@ -13,7 +13,7 @@ Adds [[https://jupyter.org/][Jupyter]] notebook integration into Emacs.
/This module has no flags./
** Packages
- [[doom-package:][ein]]
- [[doom-package:ein]]
** Hacks
/No hacks documented for this module./

4
modules/tools/eval/README.org
View file

@ -17,7 +17,7 @@ interface for opening and interacting with REPLs.
minibuffer will be used anyway.
** Packages
- [[doom-package:][quickrun]]
- [[doom-package:quickrun]]
** Hacks
- Quickrun has been modified to:
@ -36,7 +36,7 @@ This module has no direct prerequisites.
However, many languages will require that you install their interpreters, code
runners and/or repls to power the functionality of this module. Visit the
documentation of their respective [[doom-module:][:lang]] module for instructions.
documentation of their respective [[doom-module::lang]] module for instructions.
* TODO Usage
#+begin_quote

2
modules/tools/gist/README.org
View file

@ -19,7 +19,7 @@ Adds the ability to manage, pull from, or push to your [[https://gist.github.com
/This module has no flags./
** Packages
- [[doom-package:][gist]]
- [[doom-package:gist]]
** Hacks
/No hacks documented for this module./

42
modules/tools/lookup/README.org
View file

@ -26,26 +26,26 @@ or synonyms.
- +docsets ::
Enable integration with Dash.app docsets.
- +offline ::
Install and prefer offline dictionary/thesaurus (with [[doom-module:][+dictionary]]).
Install and prefer offline dictionary/thesaurus (with [[doom-module:+dictionary]]).
** Packages
- [[doom-package:][dumb-jump]]
- [[doom-package:][helm-xref]] if [[doom-module:][:completion helm]]
- [[doom-package:][ivy-xref]] if [[doom-module:][:completion ivy]]
- [[doom-package:][request]]
- if [[doom-module:][+docsets]]
- [[doom-package:][dash-docs]]
- [[doom-package:][counsel-dash]] if [[doom-module:][:completion ivy]]
- [[doom-package:][helm-dash]] if [[doom-module:][:completion helm]]
- if [[doom-module:][+dictionary]]
- [[doom-package:dumb-jump]]
- [[doom-package:helm-xref]] if [[doom-module::completion helm]]
- [[doom-package:ivy-xref]] if [[doom-module::completion ivy]]
- [[doom-package:request]]
- if [[doom-module:+docsets]]
- [[doom-package:dash-docs]]
- [[doom-package:counsel-dash]] if [[doom-module::completion ivy]]
- [[doom-package:helm-dash]] if [[doom-module::completion helm]]
- if [[doom-module:+dictionary]]
- if macOS
- [[doom-package:][osx-dictionary]]
- [[doom-package:osx-dictionary]]
- else
- [[doom-package:][define-word]]
- [[doom-package:][powerthesaurus]]
- if [[doom-module:][+offline]]
- [[doom-package:][wordnut]]
- [[doom-package:][synosaurus]]
- [[doom-package:define-word]]
- [[doom-package:powerthesaurus]]
- if [[doom-module:+offline]]
- [[doom-package:wordnut]]
- [[doom-package:synosaurus]]
** Hacks
/No hacks documented for this module./
@ -60,9 +60,9 @@ or synonyms.
This module has several optional dependencies:
- ~ripgrep~ as a last-resort fallback for jump-to-definition/find-references.
- ~sqlite3~ for Dash docset support (if you have [[doom-module:][+docsets]] enabled)
- ~sqlite3~ for Dash docset support (if you have [[doom-module:+docsets]] enabled)
- ~wordnet~ for offline dictionary and thesaurus support (if you have
[[doom-module:][+dictionary]] and [[doom-module:][+offline]] enabled).
[[doom-module:+dictionary]] and [[doom-module:+offline]] enabled).
** MacOS
#+begin_src sh
@ -102,7 +102,7 @@ following sources before giving up:
1. Whatever ~:definition~ function is registered for the current buffer with the
~:lookup~ setting (see "Configuration" section).
2. Any available xref backends.
3. [[doom-package:][dumb-jump]] (a text search with aides to reduce false positives).
3. [[doom-package:dumb-jump]] (a text search with aides to reduce false positives).
3. An ordinary project-wide text search with =ripgrep=.
5. If ~evil-mode~ is active, use ~evil-goto-definition~, which preforms a simple
text search within the current buffer.
@ -118,7 +118,7 @@ will try:
1. Whatever ~:references~ function is registered for the current buffer with the
~:lookup~ setting (see [[*Configuration][Configuration]]).
2. Any available [[doom-package:][xref]] backends.
2. Any available [[doom-package:xref]] backends.
3. An ordinary project-wide text search with ripgrep.
If there are multiple results, you will be prompted to select one.
@ -169,7 +169,7 @@ properties:
Run when looking up the file for a symbol/string. Typically a file path. Used
by ~+lookup/file~.
- ~:xref-backend FN~ ::
Defines an [[doom-package:][xref]] backend, which implicitly provides ~:definition~ and
Defines an [[doom-package:xref]] backend, which implicitly provides ~:definition~ and
~:references~ handlers. If you specify them anyway, they will take precedence
over the xref backend, however.

76
modules/tools/lsp/README.org
View file

@ -6,33 +6,33 @@
* Description :unfold:
This module integrates [[https://langserver.org/][language servers]] into Doom Emacs. They provide features
you'd expect from IDEs, like code completion, realtime linting, language-aware
[[doom-package:][imenu]]/[[doom-package:][xref]] integration, jump-to-definition/references support, and more.
[[doom-package:imenu]]/[[doom-package:xref]] integration, jump-to-definition/references support, and more.
As of this writing, this is the state of LSP support in Doom Emacs:
| Module | Major modes | Default language server |
|------------------+---------------------------------------------------------+---------------------------------------------------------------|
| [[doom-module:][:lang cc]] | c-mode, c++-mode, objc-mode | ccls, clangd |
| [[doom-module:][:lang clojure]] | clojure-mode | clojure-lsp |
| [[doom-module:][:lang csharp]] | csharp-mode | omnisharp |
| [[doom-module:][:lang elixir]] | elixir-mode | elixir-ls |
| [[doom-module:][:lang fsharp]] | fsharp-mode | Mono, .NET core |
| [[doom-module:][:lang go]] | go-mode | go-langserver |
| [[doom-module:][:lang haskell]] | haskell-mode | haskell-language-server |
| [[doom-module:][:lang java]] | java-mode | lsp-java |
| [[doom-module:][:lang javascript]] | js2-mode, rjsx-mode, typescript-mode | ts-ls, deno-ls |
| [[doom-module:][:lang julia]] | julia-mode | LanguageServer.jl |
| [[doom-module:][:lang ocaml]] | tuareg-mode | ocaml-language-server |
| [[doom-module:][:lang php]] | php-mode | php-language-server |
| [[doom-module:][:lang purescript]] | purescript-mode | purescript-language-server |
| [[doom-module:][:lang python]] | python-mode | lsp-python-ms |
| [[doom-module:][:lang ruby]] | ruby-mode | solargraph |
| [[doom-module:][:lang rust]] | rust-mode | rls |
| [[doom-module:][:lang scala]] | scala-mode | metals |
| [[doom-module:][:lang sh]] | sh-mode | bash-language-server |
| [[doom-module:][:lang swift]] | swift-mode | sourcekit |
| [[doom-module:][:lang web]] | web-mode, css-mode, scss-mode, sass-mode, less-css-mode | vscode-css-languageserver-bin, vscode-html-languageserver-bin |
| [[doom-module:][:lang zig]] | zig-mode | zls |
| [[doom-module::lang cc]] | c-mode, c++-mode, objc-mode | ccls, clangd |
| [[doom-module::lang clojure]] | clojure-mode | clojure-lsp |
| [[doom-module::lang csharp]] | csharp-mode | omnisharp |
| [[doom-module::lang elixir]] | elixir-mode | elixir-ls |
| [[doom-module::lang fsharp]] | fsharp-mode | Mono, .NET core |
| [[doom-module::lang go]] | go-mode | go-langserver |
| [[doom-module::lang haskell]] | haskell-mode | haskell-language-server |
| [[doom-module::lang java]] | java-mode | lsp-java |
| [[doom-module::lang javascript]] | js2-mode, rjsx-mode, typescript-mode | ts-ls, deno-ls |
| [[doom-module::lang julia]] | julia-mode | LanguageServer.jl |
| [[doom-module::lang ocaml]] | tuareg-mode | ocaml-language-server |
| [[doom-module::lang php]] | php-mode | php-language-server |
| [[doom-module::lang purescript]] | purescript-mode | purescript-language-server |
| [[doom-module::lang python]] | python-mode | lsp-python-ms |
| [[doom-module::lang ruby]] | ruby-mode | solargraph |
| [[doom-module::lang rust]] | rust-mode | rls |
| [[doom-module::lang scala]] | scala-mode | metals |
| [[doom-module::lang sh]] | sh-mode | bash-language-server |
| [[doom-module::lang swift]] | swift-mode | sourcekit |
| [[doom-module::lang web]] | web-mode, css-mode, scss-mode, sass-mode, less-css-mode | vscode-css-languageserver-bin, vscode-html-languageserver-bin |
| [[doom-module::lang zig]] | zig-mode | zls |
** Maintainers
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
@ -42,15 +42,15 @@ As of this writing, this is the state of LSP support in Doom Emacs:
Use [[https://elpa.gnu.org/packages/eglot.html][Eglot]] instead of [[https://github.com/emacs-lsp/lsp-mode][LSP-mode]] to implement the LSP client in Emacs.
- +peek ::
Use ~lsp-ui-peek~ when looking up definitions and references with
functionality from the [[doom-module:][:tools lookup]] module.
functionality from the [[doom-module::tools lookup]] module.
** Packages
- [[doom-package:][lsp-mode]]
- [[doom-package:][lsp-ui]]
- [[doom-package:][lsp-ivy]] ([[doom-module:][:completion ivy]])
- [[doom-package:][helm-lsp]] ([[doom-module:][:completion helm]])
- [[doom-package:][consult-lsp]] ([[doom-module:][:completion vertico]])
- [[doom-package:][eglot]]
- [[doom-package:lsp-mode]]
- [[doom-package:lsp-ui]]
- [[doom-package:lsp-ivy]] ([[doom-module::completion ivy]])
- [[doom-package:helm-lsp]] ([[doom-module::completion helm]])
- [[doom-package:consult-lsp]] ([[doom-module::completion vertico]])
- [[doom-package:eglot]]
** Hacks
/No hacks documented for this module./
@ -66,10 +66,10 @@ To get LSP working, you'll need to do three things:
1. Enable this module,
2. Install a language server appropriate for your targeted language(s).
3. Enable the [[doom-module:][+lsp]] flag on the [[doom-module:][:lang]] modules you want to enable LSP support for.
3. Enable the [[doom-module:+lsp]] flag on the [[doom-module::lang]] modules you want to enable LSP support for.
Different languages will need different language servers, some of which [[doom-package:][lsp-mode]]
will prompt you to auto-install, but [[doom-package:][eglot]] will not.
Different languages will need different language servers, some of which [[doom-package:lsp-mode]]
will prompt you to auto-install, but [[doom-package:eglot]] will not.
A table that lists available language servers and how to install them can be
found [[https://emacs-lsp.github.io/lsp-mode/page/languages/][on the lsp-mode project README]]. The documentation of the module for your
@ -84,8 +84,8 @@ including instructions to register your own.
#+end_quote
** LSP-powered project search
Without the [[doom-module:][+eglot]] flag, and when [[doom-module:][:completion ivy]], [[doom-module:][:completion helm]] or
[[doom-module:][:completion vertico]] is active, LSP is used to search a symbol indexed by the LSP
Without the [[doom-module:+eglot]] flag, and when [[doom-module::completion ivy]], [[doom-module::completion helm]] or
[[doom-module::completion vertico]] is active, LSP is used to search a symbol indexed by the LSP
server:
| Keybind | Description |
|---------+-------------------------------------|
@ -96,14 +96,14 @@ server:
The two projects are large and actively developed, so without writing a novel,
it can only be compared in (very) broad strokes:
- [[doom-package:][lsp-mode]] tends to be more featureful, beginner-friendly (e.g. offers to
- [[doom-package:lsp-mode]] tends to be more featureful, beginner-friendly (e.g. offers to
install servers for you and has more [[https://emacs-lsp.github.io/lsp-mode][helpful documentation]]), and has a user
experience that feels familiar to modern editors/IDEs, but at the cost of
performance (at baseline) and complexity (it has more moving parts and
reinvents a number of wheels to achieve a slicker UI, like ~lsp-ui-peek~,
~lsp-ui-sideline~, etc).
- [[doom-package:][eglot]] has fewer bells and whistles: it relies on built-in Emacs functionality
- [[doom-package:eglot]] has fewer bells and whistles: it relies on built-in Emacs functionality
more (eldoc, xref, capf, project.el, etc), offers less pre-configuration for
you, and is more performant than lsp-mode (again, at baseline). It also works
with TRAMP out-of-the-box (lsp-mode needs some extra configuration).
@ -115,7 +115,7 @@ it can only be compared in (very) broad strokes:
#+end_quote
All that said, it's easy to switch between the two implementations by swapping
in/out the [[doom-module:][+lsp]] or [[doom-module:][+eglot]] flag when [[id:01cffea4-3329-45e2-a892-95a384ab2338][enabling this module]].
in/out the [[doom-module:+lsp]] or [[doom-module:+eglot]] flag when [[id:01cffea4-3329-45e2-a892-95a384ab2338][enabling this module]].
* TODO Configuration
#+begin_quote
@ -135,7 +135,7 @@ Check the entry in the [[../../../docs/faq.org][FAQ]] about "Doom can't find my
the correct ~PATH~"
** LSP/Eglot is not started automatically in my buffer
Make sure that you have enabled the [[doom-module:][+lsp]] flag on the appropriate module(s) (in
Make sure that you have enabled the [[doom-module:+lsp]] flag on the appropriate module(s) (in
your ~doom!~ block in =$DOOMDIR/init.el=):
#+begin_src diff
:lang

24
modules/tools/magit/README.org
View file

@ -17,20 +17,20 @@ This module provides Magit, an interface to the Git version control system.
Emacs. Will take a while on first run to build =emacsql-sqlite=.
** Packages
- [[doom-package:][evil-magit]] if [[doom-module:][:editor evil +everywhere]]
- [[doom-package:][forge]] if [[doom-module:][+forge]]
- [[doom-package:][code-review]] if [[doom-module:][+forge]]
- [[doom-package:][magit]]
- [[doom-package:][magit-gitflow]]
- [[doom-package:][magit-todos]]
- [[doom-package:evil-magit]] if [[doom-module::editor evil +everywhere]]
- [[doom-package:forge]] if [[doom-module:+forge]]
- [[doom-package:code-review]] if [[doom-module:+forge]]
- [[doom-package:magit]]
- [[doom-package:magit-gitflow]]
- [[doom-package:magit-todos]]
** Hacks
- [[doom-package:][magit]] has been modified to recognize =$XDG_CACHE_HOME/git/credential/socket=.
- [[doom-package:][magit]] has been modified to invalidate the projectile cache when you check out
- [[doom-package:magit]] has been modified to recognize =$XDG_CACHE_HOME/git/credential/socket=.
- [[doom-package:magit]] has been modified to invalidate the projectile cache when you check out
a new branch or commit.
- [[doom-package:][magit]] has been modified to revert repo buffers (e.g. after changing branches)
- [[doom-package:magit]] has been modified to revert repo buffers (e.g. after changing branches)
when you later switch to them, rather than all at once.
- [[doom-package:][forge]] was modified to defer compilation of emacsql-sqlite until you try to use
- [[doom-package:forge]] was modified to defer compilation of emacsql-sqlite until you try to use
forge, rather than when magit first loads (which could be as soon as startup).
** TODO Changelog
@ -42,8 +42,8 @@ This module provides Magit, an interface to the Git version control system.
This module requires:
- [[https://git-scm.com/][Git]]
- [[doom-module:][+forge]] requires [[https://magit.vc/manual/forge/Token-Creation.html#Token-Creation][a Github API token]]
- [[doom-package:][code-review]] will also require a token setup (see [[https://github.com/wandersoncferreira/code-review#configuration][configuration]] for your particular forge)
- [[doom-module:+forge]] requires [[https://magit.vc/manual/forge/Token-Creation.html#Token-Creation][a Github API token]]
- [[doom-package:code-review]] will also require a token setup (see [[https://github.com/wandersoncferreira/code-review#configuration][configuration]] for your particular forge)
* TODO Usage
#+begin_quote

2
modules/tools/make/README.org
View file

@ -13,7 +13,7 @@ This module adds commands for executing Makefile targets.
/This module has no flags./
** Packages
- [[doom-package:][makefile-executor]]
- [[doom-package:makefile-executor]]
** Hacks
/No hacks documented for this module./

10
modules/tools/pass/README.org
View file

@ -14,11 +14,11 @@ This module provides an Emacs interface to [[https://www.passwordstore.org/][Pas
Allow Emacs to use pass for authentication (via ~auth-source-pass~).
** Packages
- [[doom-package:][helm-pass]] if [[doom-module:][:completion helm]]
- [[doom-package:][ivy-pass]] if [[doom-module:][:completion ivy]]
- [[doom-package:][pass]]
- [[doom-package:][password-store]]
- [[doom-package:][password-store-otp]]
- [[doom-package:helm-pass]] if [[doom-module::completion helm]]
- [[doom-package:ivy-pass]] if [[doom-module::completion ivy]]
- [[doom-package:pass]]
- [[doom-package:password-store]]
- [[doom-package:password-store-otp]]
** Hacks
/No hacks documented for this module./

10
modules/tools/pdf/README.org
View file

@ -7,12 +7,12 @@
This module improves support for reading and interacting with PDF files in
Emacs.
It uses [[doom-package:][pdf-tools]], which is a replacement for the built-in ~doc-view-mode~ for
It uses [[doom-package:pdf-tools]], which is a replacement for the built-in ~doc-view-mode~ for
PDF files. The key difference being pages are not pre-rendered, but instead
rendered on-demand and stored in memory; a much faster approach, especially for
larger PDFs.
Displaying PDF files is just one function of [[doom-package:][pdf-tools]]. See [[https://github.com/politza/pdf-tools][its project website]]
Displaying PDF files is just one function of [[doom-package:pdf-tools]]. See [[https://github.com/politza/pdf-tools][its project website]]
for details and videos.
** Maintainers
@ -22,8 +22,8 @@ for details and videos.
/This module has no flags./
** Packages
- [[doom-package:][pdf-tools]]
- [[doom-package:][saveplace-pdf-view]]
- [[doom-package:pdf-tools]]
- [[doom-package:saveplace-pdf-view]]
** TODO Hacks
#+begin_quote
@ -38,7 +38,7 @@ for details and videos.
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
This module requires the =epdfinfo= program. Unless you're on Windows, the
[[doom-package:][pdf-tools]] plugin will (re)build this program for you, if you issue the ~M-x
[[doom-package:pdf-tools]] plugin will (re)build this program for you, if you issue the ~M-x
pdf-tools-install~ command. See the next section for instructions on how to
build the =epdfinfo= program on Windows.

2
modules/tools/prodigy/README.org
View file

@ -14,7 +14,7 @@ Emacs.
/This module has no flags./
** Packages
- [[doom-package:][prodigy]]
- [[doom-package:prodigy]]
** Hacks
/No hacks documented for this module./

4
modules/tools/rgb/README.org
View file

@ -18,8 +18,8 @@ to easily modify color values or formats.
/This module has no flags./
** Packages
- [[doom-package:][kurecolor]]
- [[doom-package:][rainbow-mode]]
- [[doom-package:kurecolor]]
- [[doom-package:rainbow-mode]]
** Hacks
/No hacks documented for this module./

8
modules/tools/taskrunner/README.org
View file

@ -9,7 +9,7 @@
#+end_quote
* Description :unfold:
This module integrates [[doom-package:][taskrunner]] into Doom Emacs, which scraps runnable tasks
This module integrates [[doom-package:taskrunner]] into Doom Emacs, which scraps runnable tasks
from build systems like make, gradle, npm and the like.
** Maintainers
@ -19,9 +19,9 @@ from build systems like make, gradle, npm and the like.
/This module has no flags./
** Packages
- [[doom-package:][emacs-taskrunner]]
- [[doom-package:][helm-taskrunner]] if [[doom-module:][:completion helm]]
- [[doom-package:][ivy-taskrunner]] if [[doom-module:][:completion ivy]]
- [[doom-package:emacs-taskrunner]]
- [[doom-package:helm-taskrunner]] if [[doom-module::completion helm]]
- [[doom-package:ivy-taskrunner]] if [[doom-module::completion ivy]]
** Hacks
/No hacks documented for this module./

18
modules/tools/terraform/README.org
View file

@ -15,8 +15,8 @@ run Terraform commands directly from Emacs.
/This module has no flags./
** Packages
- [[doom-package:][company-terraform]] if [[doom-package:][:completion company]]
- [[doom-package:][terraform-mode]]
- [[doom-package:company-terraform]] if [[doom-package::completion company]]
- [[doom-package:terraform-mode]]
** Hacks
/No hacks documented for this module./
@ -36,25 +36,25 @@ This module requires the ~terraform~ executable to be installed and in your
Syntax highlighting is provided from ~terraform-mode~ and ~hcl-mode~.
** Code formatting
[[doom-module:][:tools terraform]] does not provide code formatting directly, but [[doom-module:][:editor format]]
[[doom-module::tools terraform]] does not provide code formatting directly, but [[doom-module::editor format]]
works with Terraform files.
** Code navigation
Code navigation is supported through [[doom-package:][imenu]] from [[doom-package:][terraform-mode]].
Code navigation is supported through [[doom-package:imenu]] from [[doom-package:terraform-mode]].
** Code completion
Code completion of Terraform builtins is provided from [[doom-package:][company-terraform]] and
Code completion of Terraform builtins is provided from [[doom-package:company-terraform]] and
generally works well despite being generated through a [[https://github.com/rafalcieslak/emacs-company-terraform/blob/master/company-terraform-data.el][static (outdated) file]].
[[doom-package:][company-terraform]] also provides code completion of resources within your
[[doom-package:company-terraform]] also provides code completion of resources within your
project.
** Documentation
Documentation is accessible through the normal [[doom-package:][company]] show documentation
functionality, thanks to [[doom-package:][company-terraform]].
Documentation is accessible through the normal [[doom-package:company]] show documentation
functionality, thanks to [[doom-package:company-terraform]].
** Executing Terraform commands
[[doom-module:][:tools terraform]] provides commands under [[kbd:][<localleader>]] to run the most common
[[doom-module::tools terraform]] provides commands under [[kbd:][<localleader>]] to run the most common
Terraform operations:
| key | description |
|-----------------+--------------------------|

6
modules/tools/tree-sitter/README.org
View file

@ -27,9 +27,9 @@ It includes:
/This module has no flags./
** Packages
- [[doom-package:][evil-textobj-tree-sitter]] if [[doom-module:][:editor evil +everywhere]]
- [[doom-package:][tree-sitter]]
- [[doom-package:][tree-sitter-langs]]
- [[doom-package:evil-textobj-tree-sitter]] if [[doom-module::editor evil +everywhere]]
- [[doom-package:tree-sitter]]
- [[doom-package:tree-sitter-langs]]
** Hacks
/No hacks documented for this module./

2
modules/tools/upload/README.org
View file

@ -22,7 +22,7 @@ The idea for this plug-in was to mimic the behavior of PhpStorm deployment funct
/This module has no flags./
** Packages
- [[doom-package:][ssh-deploy]]
- [[doom-package:ssh-deploy]]
** Hacks
/No hacks documented for this module./