docs(:config): update READMEs to new format
This commit is contained in:
parent
11793094ba
commit
c27f005011
3 changed files with 143 additions and 98 deletions
|
@ -1,44 +1,70 @@
|
|||
#+TITLE: :config default
|
||||
← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::config default][Issues]] ↖ [[doom-module-source:config/default][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
||||
--------------------------------------------------------------------------------
|
||||
#+TITLE: :config default
|
||||
#+SUBTITLE: Reasonable defaults for reasonable people
|
||||
#+CREATED: February 14, 2018
|
||||
#+SINCE: 2.0.9
|
||||
|
||||
* Description :unfold:
|
||||
This module provides a set of reasonable defaults, including:
|
||||
|
||||
+ A Spacemacs-esque keybinding scheme
|
||||
+ Extra Ex commands for evil-mode users
|
||||
+ A yasnippet snippets library tailored to Doom emacs
|
||||
+ A configuration for (almost) universally repeating searches with =;= and =,=
|
||||
- A Spacemacs-inspired keybinding scheme
|
||||
- A configuration for (almost) universally repeating searches with [[kbd:][;]] and [[kbd:][,]]
|
||||
- A [[doom-package:][smartparens]] configuration for smart completion of certain delimiters, like
|
||||
~/* */~ command blocks in C-languages, ~<?php ?>~ tags in PHP, or ~def end~ in
|
||||
Ruby/Crystal/etc.
|
||||
|
||||
** Maintainers
|
||||
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
||||
** Module flags
|
||||
- +bindings :: ...
|
||||
- +smartparens :: ...
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][avy]]
|
||||
- [[doom-package:][drag-stuff]]
|
||||
- [[doom-package:][link-hint]]
|
||||
- [[doom-package:][expand-region]] unless [[doom-module:][:editor evil]]
|
||||
|
||||
** Hacks
|
||||
- ~epa-pinentry-mode~ is set to ~'loopback~, forcing gpg-agent to use the Emacs
|
||||
minibuffer when prompting for your passphrase. *Only works with GPG 2.1+!*
|
||||
|
||||
** 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
|
||||
The defaults module is intended as a "reasonable-defaults" module, but also as a
|
||||
reference for your own private modules. You'll find [[https://github.com/hlissner/doom-emacs-private][my private module in a
|
||||
separate repo]].
|
||||
|
||||
Refer to the [[https://github.com/hlissner/doom-emacs/wiki/Customization][Customization page]] on the wiki for details on starting your own
|
||||
private module.
|
||||
🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
|
||||
#+end_quote
|
||||
|
||||
* Table of Contents :TOC:
|
||||
- [[#install][Install]]
|
||||
- [[#configuration][Configuration]]
|
||||
- [[#im-not-an-evil-user][I'm not an evil user...]]
|
||||
- [[#appendix][Appendix]]
|
||||
- [[#commands][Commands]]
|
||||
- [[#hacks][Hacks]]
|
||||
* TODO Configuration
|
||||
#+begin_quote
|
||||
🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
|
||||
#+end_quote
|
||||
|
||||
* Install
|
||||
This module has no external dependencies.
|
||||
* Troubleshooting
|
||||
/There are no known problems with this module./ [[doom-report:][Report one?]]
|
||||
|
||||
* Configuration
|
||||
** I'm not an evil user...
|
||||
That's fine. All evil configuration is ignored if =:editor evil= is disabled.
|
||||
* Frequently asked questions
|
||||
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
|
||||
|
||||
* TODO Appendix
|
||||
#+begin_quote
|
||||
🔨 /This module's appendix is incomplete./ [[doom-contrib-module:][Write more?]]
|
||||
#+end_quote
|
||||
|
||||
* Appendix
|
||||
** Commands
|
||||
+ ~+default/browse-project~
|
||||
+ ~+default/browse-templates~
|
||||
+ ~+default/find-in-templates~
|
||||
+ ~+default/browse-notes~
|
||||
+ ~+default/find-in-notes~
|
||||
+ ~+default/find-in-snippets~
|
||||
** Hacks
|
||||
+ ~epa-pinentry-mode~ is set to ~'loopback~, forcing gpg-agent to use the Emacs
|
||||
minibuffer when prompting for your passphrase. *Only works with GPG 2.1+!*
|
||||
- ~+default/browse-project~
|
||||
- ~+default/browse-templates~
|
||||
- ~+default/find-in-templates~
|
||||
- ~+default/browse-notes~
|
||||
- ~+default/find-in-notes~
|
||||
- ~+default/find-in-snippets~
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue