docs(:ui): update READMEs to new format
This commit is contained in:
parent
6da20e45bd
commit
b5a2aa48fe
25 changed files with 1533 additions and 922 deletions
|
@ -1,23 +1,58 @@
|
|||
#+TITLE: ui/ophints
|
||||
#+DATE: June 4, 2017
|
||||
#+SINCE: v2.0
|
||||
#+STARTUP: inlineimages
|
||||
← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::ui ophints][Issues]] ↖ [[doom-module-source:ui/ophints][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
||||
--------------------------------------------------------------------------------
|
||||
#+TITLE: :ui ophints
|
||||
#+SUBTITLE: An indicator for “what did I just do?”
|
||||
#+CREATED: June 04, 2017
|
||||
#+SINCE: 2.0.0
|
||||
|
||||
* Table of Contents :TOC_3:noexport:
|
||||
- [[#description][Description]]
|
||||
- [[#module-flags][Module Flags]]
|
||||
- [[#plugins][Plugins]]
|
||||
|
||||
* Description
|
||||
* Description :unfold:
|
||||
This module provides op-hints (operation hinting), i.e. visual feedback for
|
||||
certain operations. It highlights regions of text that the last operation (like
|
||||
yank) acted on.
|
||||
|
||||
Uses ~evil-goggles~ for evil users and ~volatile-highlights~ otherwise.
|
||||
Uses [[doom-package:][evil-goggles]] for evil users and [[doom-package:][volatile-highlights]] otherwise.
|
||||
|
||||
** Module Flags
|
||||
This module provides no flags.
|
||||
** Maintainers
|
||||
- [[doom-user:][@hlissner]]
|
||||
|
||||
** Plugins
|
||||
+ [[https://github.com/edkolev/evil-goggles/][evil-goggles]]*
|
||||
+ [[https://github.com/k-talo/volatile-highlights.el][volatile-highlights]]*
|
||||
[[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
||||
** Module flags
|
||||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][evil-goggles]] if [[doom-module:][:editor evil]]
|
||||
- [[doom-package:][volatile-highlights]] unless [[doom-module:][:editor evil]]
|
||||
|
||||
** 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:][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