docs(:ui): update READMEs to new format

This commit is contained in:
Henrik Lissner 2021-10-16 01:29:57 +02:00 committed by Henrik Lissner
parent 6da20e45bd
commit b5a2aa48fe
25 changed files with 1533 additions and 922 deletions

View file

@ -1,39 +1,70 @@
#+TITLE: ui/doom-quit
#+DATE: February 19, 2017
#+SINCE: v2.0
#+STARTUP: inlineimages
← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::ui doom-quit][Issues]] ↖ [[doom-module-source:ui/doom-quit][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
--------------------------------------------------------------------------------
#+TITLE: :ui doom-quit
#+SUBTITLE: One does not simply quit Emacs
#+CREATED: February 19, 2017
#+SINCE: 2.0.0
* Table of Contents :TOC_3:noexport:
- [[#description][Description]]
- [[#module-flags][Module Flags]]
- [[#plugins][Plugins]]
- [[#prerequisites][Prerequisites]]
- [[#features][Features]]
- [[#configurations][Configurations]]
- [[#troubleshooting][Troubleshooting]]
* Description :unfold:
A silly module that throws cute confirmation prompts at you when you exit Emacs,
like DOOM (the game) did. Some quotes are from the classic games, others are
random, nerdy references that no decent human being has any business
recognizing.
** Maintainers
- [[doom-user:][@hlissner]]
[[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./
* Usage
Quit Emacs with [[kbd:][<leader> q q]] and watch it go. The prompt only happens if you
have (real) buffers open.
#+begin_quote
🚧 This module won't kick in when killing daemon frames (because that isn't
actually “quitting” Emacs).
#+end_quote
* Description
A silly module that prompts you with messages when you try to quit, like DOOM
did. Some quotes are from Doom's quit-message list. Others are random, nerdy
references that no decent human being has any business recognising.
** Module Flags
This module provides no flags
** Plugins
This module uses no Plugins
* Prerequisites
This module provides no prerequisite
* Features
This module only works when you run individual Emacs instances and not the
daemon.
* Configurations
you can configure the messages by adding to the variable ~+doom-quit-messages~
#+BEGIN_SRC emacs-lisp
(setq +doom-quit-messages '(;;from doom 2
"Don't go now, there's a dimensional shambler waiting at the dos prompt!"
"Get outta here and go back to your boring programs."
"If I were your boss, I'd deathmatch ya in a minute!"
"Look, bud. You leave now and you forfeit your body count!"
"You're lucky I don't smack you for thinking about leaving."))
#+END_SRC
The messages presented by this module can be customized by changing the
~+doom-quit-messages~ variable:
#+begin_src emacs-lisp
(setq +doom-quit-messages
'(;;from doom 2
"Don't go now, there's a dimensional shambler waiting at the dos prompt!"
"Get outta here and go back to your boring programs."
"If I were your boss, I'd deathmatch ya in a minute!"
"Look, bud. You leave now and you forfeit your body count!"
"You're lucky I don't smack you for thinking about leaving."))
#+end_src
* Troubleshooting
If you have any issues with this module do let me know
* Frequently asked questions
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
* Appendix
** Variables
- [[var:][+doom-quit-messages]]
** Functions
- [[fn:][+doom-quit-fn]]