docs(:term): update READMEs to new format
This commit is contained in:
parent
f6335befb4
commit
a226655486
5 changed files with 282 additions and 113 deletions
62
modules/term/shell/README.org
Normal file
62
modules/term/shell/README.org
Normal file
|
@ -0,0 +1,62 @@
|
|||
← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::term shell][Issues]] ↖ [[doom-module-source:term/shell][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
||||
--------------------------------------------------------------------------------
|
||||
#+TITLE: :term shell
|
||||
#+SUBTITLE: A REPL for your shell
|
||||
#+CREATED: August 01, 2021
|
||||
#+SINCE: 21.12.0
|
||||
|
||||
* Description :unfold:
|
||||
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]].
|
||||
|
||||
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
|
||||
programs like =htop= or =vim= won't work in shell directly, but will be
|
||||
launched in a =term= buffer -- which handles them reasonably well.
|
||||
#+end_quote
|
||||
|
||||
** Maintainers
|
||||
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
||||
** Module flags
|
||||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
/This module doesn't install any packages./
|
||||
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
||||
** TODO Changelog
|
||||
# This section will be machine generated. Don't edit it by hand.
|
||||
/This module does not have a changelog yet./
|
||||
|
||||
* Installation
|
||||
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
||||
|
||||
/This module has no external requirements./
|
||||
|
||||
* TODO Usage
|
||||
#+begin_quote
|
||||
🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
|
||||
#+end_quote
|
||||
|
||||
* TODO Configuration
|
||||
#+begin_quote
|
||||
🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
|
||||
#+end_quote
|
||||
|
||||
* Troubleshooting
|
||||
/There are no known problems with this module./ [[doom-report-issue:][Report one?]]
|
||||
|
||||
* Frequently asked questions
|
||||
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
|
||||
|
||||
* TODO Appendix
|
||||
#+begin_quote
|
||||
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
|
||||
#+end_quote
|
Loading…
Add table
Add a link
Reference in a new issue