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

@ -6,9 +6,9 @@
What's an operating system without a terminal? The modules in this category
bring varying degrees of terminal emulation into Emacs.
If you can't decide which to choose, I recommend [[doom-package:][vterm]] or [[doom-package:][eshell]]. [[doom-module:][:term vterm]]
If you can't decide which to choose, I recommend [[doom-package:vterm]] or [[doom-package:eshell]]. [[doom-module::term vterm]]
offers that best terminal emulation available but requires a few extra steps to
get going. [[doom-module:][:term eshell]] works everywhere that Emacs runs, even Windows, and
get going. [[doom-module::term eshell]] works everywhere that Emacs runs, even Windows, and
provides a shell entirely implemented in Emacs Lisp.
* Frequently asked questions

View file

@ -6,7 +6,7 @@
* Description :unfold:
This module provides additional features for the built-in [[https://www.gnu.org/software/emacs/manual/html_mono/eshell.html][Emacs Shell]]
The Emacs Shell or [[doom-package:][eshell]] is a shell-like command interpreter implemented in
The Emacs Shell or [[doom-package:eshell]] is a shell-like command interpreter implemented in
Emacs Lisp. It is an alternative to traditional shells such as =bash=, =zsh=,
=fish=, etc. that is built into Emacs and entirely cross-platform.
@ -19,19 +19,19 @@ Emacs Lisp. It is an alternative to traditional shells such as =bash=, =zsh=,
/This module has no flags./
** Packages
- [[doom-package:][eshell-did-you-mean]]
- [[doom-package:][eshell-up]]
- [[doom-package:][eshell-z]]
- [[doom-package:][esh-help]]
- [[doom-package:][shrink-path]]
- if [[doom-module:][:completion company]]
- [[doom-package:][fish-completion]]
- [[doom-package:][bash-completion]]
- [[doom-package:eshell-did-you-mean]]
- [[doom-package:eshell-up]]
- [[doom-package:eshell-z]]
- [[doom-package:esh-help]]
- [[doom-package:shrink-path]]
- if [[doom-module::completion company]]
- [[doom-package:fish-completion]]
- [[doom-package:bash-completion]]
** Hacks
- Even with ~fish-completion-fallback-on-bash-p~ non-nil, fish must be installed
for bash completion to work. This has been circumvented.
- [[doom-package:][eshell-did-you-mean]] does not work on first invocation, so we manually invoke
- [[doom-package:eshell-did-you-mean]] does not work on first invocation, so we manually invoke
it once.
** TODO Changelog
@ -59,7 +59,7 @@ This module requires either [[https://fishshell.com/][Fish shell]] or [[https://
#+end_quote
** TERM name
By default, [[doom-package:][eshell]] sets the =$TERM= variable to ~"xterm-256color"~, which helps
By default, [[doom-package:eshell]] sets the =$TERM= variable to ~"xterm-256color"~, which helps
with rendering various colours. As eshell is /not/ a terminal emulator, these
will not always work 100%. Modifying ~eshell-term-name~ to your liking may help.

View file

@ -8,8 +8,8 @@ Provides a REPL for your shell.
#+begin_quote
💡 =shell= is more REPL than terminal emulator. You can edit your command line
like you would any ordinary text in Emacs -- something you can't do in [[doom-package:][term]]
(without ~term-line-mode~, which can be unstable) or [[doom-package:][vterm]].
like you would any ordinary text in Emacs -- something you can't do in [[doom-package:term]]
(without ~term-line-mode~, which can be unstable) or [[doom-package:vterm]].
Due to =shell='s simplicity, you're less likely to encounter edge cases
(e.g. against your shell config), but it's also the least capable. TUI

View file

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

View file

@ -8,7 +8,7 @@ This module provides a terminal emulator powered by libvterm. It is still in
alpha and requires a component be compiled (=vterm-module.so=).
#+begin_quote
💡 [[doom-package:][vterm]] is as good as terminal emulation gets in Emacs (at the time of
💡 [[doom-package:vterm]] is as good as terminal emulation gets in Emacs (at the time of
writing) and the most performant, as it is implemented in C. However, it
requires extra steps to set up:
@ -16,9 +16,9 @@ alpha and requires a component be compiled (=vterm-module.so=).
- and =vterm-module.so= must be compiled, which depends on =libvterm=,
=cmake=, and =libtool-bin=.
[[doom-package:][vterm]] will try to automatically build =vterm-module.so= when you first open
[[doom-package:vterm]] will try to automatically build =vterm-module.so= when you first open
it, but this will fail on Windows, NixOS and Guix out of the box. Install
instructions for nix/guix can be found in the [[doom-module:][:term vterm]] module's
instructions for nix/guix can be found in the [[doom-module::term vterm]] module's
documentation. There is no way to install vterm on Windows that I'm aware of
(but perhaps with WSL?).
#+end_quote
@ -32,7 +32,7 @@ alpha and requires a component be compiled (=vterm-module.so=).
/This module has no flags./
** Packages
- [[doom-package:][vterm]]
- [[doom-package:vterm]]
** Hacks
/No hacks documented for this module./