From ccb6f0de208d0b0e104653a9440841cc863ac6b7 Mon Sep 17 00:00:00 2001
From: wsdjeg <wsdjeg@outlook.com>
Date: Wed, 23 Mar 2022 18:57:21 +0800
Subject: [PATCH] docs(iedit): add `:h SpaceVim-plugins-iedit`

---
 autoload/SpaceVim.vim               |  2 +-
 autoload/SpaceVim/plugins.vim       |  7 ++++++
 autoload/SpaceVim/plugins/iedit.vim | 17 +++++++++++++++
 doc/SpaceVim.txt                    | 33 +++++++++++++++++++++++++----
 4 files changed, 54 insertions(+), 5 deletions(-)

diff --git a/autoload/SpaceVim.vim b/autoload/SpaceVim.vim
index 0f6efbcaa..ed3fd8c68 100644
--- a/autoload/SpaceVim.vim
+++ b/autoload/SpaceVim.vim
@@ -11,7 +11,7 @@ scriptencoding utf-8
 " @section Introduction, intro
 " @stylized spacevim
 " @library
-" @order intro options config functions layers usage api dev faq changelog
+" @order intro options config functions layers usage plugins api dev faq changelog
 " SpaceVim is a bundle of custom settings and plugins with a modular
 " configuration for Vim. It was inspired by Spacemacs.
 "
diff --git a/autoload/SpaceVim/plugins.vim b/autoload/SpaceVim/plugins.vim
index b8a5b0802..060e4e0a7 100644
--- a/autoload/SpaceVim/plugins.vim
+++ b/autoload/SpaceVim/plugins.vim
@@ -7,6 +7,13 @@
 "=============================================================================
 
 scriptencoding utf-8
+
+
+""
+" @section Plugins, plugins
+" This is a list of buildin plugins.
+
+
 function! SpaceVim#plugins#load() abort
   if SpaceVim#plugins#enable_plug()
     call SpaceVim#plugins#begin(g:spacevim_plugin_bundle_dir)
diff --git a/autoload/SpaceVim/plugins/iedit.vim b/autoload/SpaceVim/plugins/iedit.vim
index 0193f566a..8bf18a48c 100644
--- a/autoload/SpaceVim/plugins/iedit.vim
+++ b/autoload/SpaceVim/plugins/iedit.vim
@@ -6,6 +6,23 @@
 " License: GPLv3
 "=============================================================================
 
+""
+" @section iedit, plugins-iedit
+" @parentsection plugins
+" The `iedit` plugin provides multiple cursor support for SpaceVim.
+" 
+" @subsection Key bindings
+" >
+"   Key binding     Description
+"   SPC s e         string iedit mode
+" <
+"
+" After starting iedit, the following key bindings can be used:
+" >
+"   Mode       Key binding     Description
+"   Iedit-Normal    a           start iedit-insert mode after cursor
+" <
+
 let s:stack = []
 let s:index = -1
 let s:cursor_col = -1
diff --git a/doc/SpaceVim.txt b/doc/SpaceVim.txt
index 3674541a1..003867bda 100644
--- a/doc/SpaceVim.txt
+++ b/doc/SpaceVim.txt
@@ -227,7 +227,9 @@ CONTENTS                                                   *SpaceVim-contents*
       6. tasks..........................................|SpaceVim-usage-tasks|
       7. undo-tree...................................|SpaceVim-usage-undotree|
       8. windows-and-tabs....................|SpaceVim-usage-windows-and-tabs|
-  8. API........................................................|SpaceVim-api|
+  8. Plugins................................................|SpaceVim-plugins|
+      1. iedit........................................|SpaceVim-plugins-iedit|
+  9. API........................................................|SpaceVim-api|
       1. clock............................................|SpaceVim-api-clock|
       2. cmdlinemenu................................|SpaceVim-api-cmdlinemenu|
       3. data#dict....................................|SpaceVim-api-data-dict|
@@ -247,10 +249,10 @@ CONTENTS                                                   *SpaceVim-contents*
       17. vim#compatible.........................|SpaceVim-api-vim-compatible|
       18. vim#message...............................|SpaceVim-api-vim-message|
       19. vim#window.................................|SpaceVim-api-vim-window|
-  9. Development................................................|SpaceVim-dev|
+  10. Development...............................................|SpaceVim-dev|
       1. commit-style-guide..................|SpaceVim-dev-commit-style-guide|
-  10. FAQ.......................................................|SpaceVim-faq|
-  11. Changelog...........................................|SpaceVim-changelog|
+  11. FAQ.......................................................|SpaceVim-faq|
+  12. Changelog...........................................|SpaceVim-changelog|
 
 ==============================================================================
 INTRODUCTION                                                  *SpaceVim-intro*
@@ -5407,6 +5409,29 @@ The following key bindings can be used to manager vim windows and tabs.
     Shift-Tab    | Switch to alternate window (switch back and forth)
 <
 
+==============================================================================
+PLUGINS                                                     *SpaceVim-plugins*
+
+This is a list of buildin plugins.
+
+==============================================================================
+IEDIT                                                 *SpaceVim-plugins-iedit*
+
+The `iedit` plugin provides multiple cursor support for SpaceVim.
+
+KEY BINDINGS
+
+>
+  Key binding     Description
+  SPC s e         string iedit mode
+<
+
+After starting iedit, the following key bindings can be used:
+>
+  Mode       Key binding     Description
+  Iedit-Normal    a           start iedit-insert mode after cursor
+<
+
 ==============================================================================
 API                                                             *SpaceVim-api*