docs(:editor): update READMEs to new format
This commit is contained in:
parent
c27f005011
commit
9ada400805
13 changed files with 877 additions and 531 deletions
|
@ -1,55 +1,59 @@
|
|||
#+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
|
||||
← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::editor parinfer][Issues]] ↖ [[doom-module-source:editor/parinfer][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
||||
--------------------------------------------------------------------------------
|
||||
#+TITLE: :editor parinfer
|
||||
#+SUBTITLE: For lispers that like Python more (i.e. nobody)
|
||||
#+CREATED: February 27, 2021
|
||||
#+SINCE: 2.1
|
||||
|
||||
* Description :unfold:
|
||||
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 needs a maintainer.* [[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
||||
This module has no dedicated maintainers.
|
||||
** Module flags
|
||||
/This module has no flags./
|
||||
|
||||
** Module Flags
|
||||
** Packages
|
||||
- [[doom-package:][parinfer-rust-mode]]
|
||||
|
||||
This module provides no flags.
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
||||
** Plugins
|
||||
** TODO Changelog
|
||||
# This section will be machine generated. Don't edit it by hand.
|
||||
/This module does not have a changelog yet./
|
||||
|
||||
+ [[https://github.com/justinbarclay/parinfer-rust-mode][parinfer-rust-mode]]
|
||||
* Installation
|
||||
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
||||
|
||||
* Prerequisites
|
||||
This module requires [[https://github.com/justinbarclay/parinfer-rust-mode#parinfer-rust-library][parinfer-rust]].
|
||||
|
||||
This module has no prerequisites.
|
||||
|
||||
* Features
|
||||
* TODO Usage
|
||||
#+begin_quote
|
||||
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
** Keybindings
|
||||
| Binding | Description |
|
||||
|-----------------+-------------------------------------------|
|
||||
| [[kbd:][<localleader> p]] | Toggle between different inference modes. |
|
||||
| [[kbd:][<localleader> P]] | Temporarily disable parinfer. |
|
||||
|
||||
| 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.
|
||||
* TODO Configuration
|
||||
#+begin_quote
|
||||
🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
|
||||
#+end_quote
|
||||
|
||||
* Troubleshooting
|
||||
# Common issues and their solution, or places to look for help.
|
||||
/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