yeet

.config/emacs/modules/editor/parinfer/README.org

@@ -0,0 +1,55 @@
+#+TITLE:   editor/parinfer
+#+DATE:    June 9, 2018
+#+SINCE:   v2.1
+#+STARTUP: inlineimages nofold
+
+* Table of Contents :TOC_3:noexport:
+- [[#description][Description]]
+  - [[#maintainers][Maintainers]]
+  - [[#module-flags][Module Flags]]
+  - [[#plugins][Plugins]]
+- [[#prerequisites][Prerequisites]]
+- [[#features][Features]]
+  - [[#keybindings][Keybindings]]
+- [[#configuration][Configuration]]
+- [[#troubleshooting][Troubleshooting]]
+
+* Description
+
+Parinfer is a minor mode that aids the writing of Lisp code. It automatically
+infers parenthesis matching and indentation alignment, keeping your code
+balanced and beautiful.
+
+Note that the original =parinfer-mode= has been deprecated and superceded by
+=parinfer-rust-mode=, which has much better performance.
+
+** Maintainers
+
+This module has no dedicated maintainers.
+
+** Module Flags
+
+This module provides no flags.
+
+** Plugins
+
++ [[https://github.com/justinbarclay/parinfer-rust-mode][parinfer-rust-mode]]
+
+* Prerequisites
+
+This module has no prerequisites.
+
+* Features
+
+** Keybindings
+
+| Binding           | Description                               |
+|-------------------+-------------------------------------------|
+| ~<localleader> m p~ | Toggle between different inference modes. |
+| ~<localleader> m P~ | Temporarily disable parinfer.             |
+
+* Configuration
+# How to configure this module, including common problems and how to address them.
+
+* Troubleshooting
+# Common issues and their solution, or places to look for help.