docs(:input): update READMEs to new format

This commit is contained in:
Henrik Lissner 2021-10-16 01:27:36 +02:00 committed by Henrik Lissner
parent 2dcef764f1
commit ca7579a1e9
4 changed files with 206 additions and 159 deletions

View file

@ -1,43 +1,57 @@
#+TITLE: input/japanese
#+DATE: May 13, 2019
#+SINCE: 2.1
#+STARTUP: inlineimages
← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::input japanese][Issues]] ↖ [[doom-module-source:input/japanese][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
--------------------------------------------------------------------------------
#+TITLE: :input japanese
#+SUBTITLE: Ah, a man of culture
#+CREATED: May 13, 2019
#+SINCE: 2.1
* Table of Contents :TOC_3:noexport:
- [[#description][Description]]
- [[#module-flags][Module Flags]]
- [[#plugins][Plugins]]
- [[#hacks][Hacks]]
- [[#prerequisites][Prerequisites]]
- [[#features][Features]]
- [[#configuration][Configuration]]
- [[#troubleshooting][Troubleshooting]]
* Description
* Description :unfold:
This module adds support for Japanese script.
#+begin_quote
Because I am unable to personally test this module, help to improve this module
would be greatly appreciated! Especially where performance is concerned.
#+end_quote
** Maintainers
*This module needs a maintainer.* [[doom-contrib-maintainer:][Become a maintainer?]]
** Module Flags
This module provides no flags.
** Module flags
/This module has no flags./
** Plugins
+ [[https://github.com/emacs-jp/migemo][migemo]]
+ [[https://github.com/momomo5717/avy-migemo][avy-migemo]]
+ [[https://github.com/hsaito/ddskk][ddskk]]
+ [[https://github.com/coldnew/pangu-spacing][pangu-spacing]]
** Packages
- [[doom-package:][avy-migemo]]
- [[doom-package:][ddskk]]
- [[doom-package:][migemo]]
- [[doom-package:][pangu-spacing]]
** Hacks
+ ~org-html-paragraph~ has been modified to join consecutive Chinese lines into
- ~org-html-paragraph~ has been modified to join consecutive Chinese lines into
a single long line without wanted spaced (when exporting org-mode to html).
* TODO Prerequisites
+ For incremental search with Migemo, one of the following is required:
+ [[https://github.com/koron/cmigemo][cmigemo]], which is recommended, or
+ [[http://0xcc.net/migemo/][CVS Head Migemo]]
* TODO Features
** TODO Changelog
# This section will be machine generated. Don't edit it by hand.
/This module does not have a changelog yet./
* TODO Installation
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
- For incremental search with Migemo, one of the following is required:
- [[https://github.com/koron/cmigemo][cmigemo]] (recommended)
- or [[http://0xcc.net/migemo/][CVS Head Migemo]]
* TODO Usage
#+begin_quote
🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
#+end_quote
* TODO Configuration
* TODO Troubleshooting
#+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