From bc04a4d3424c33204b1caf2365cb12e469d2bca2 Mon Sep 17 00:00:00 2001
From: wsdjeg <wsdjeg@outlook.com>
Date: Mon, 4 Apr 2022 17:55:19 +0800
Subject: [PATCH] docs(runner): add `:h SpaceVim-plugins-runner`

---
 autoload/SpaceVim/plugins/runner.vim | 14 ++++++++++++++
 doc/SpaceVim.txt                     | 16 ++++++++++++++++
 2 files changed, 30 insertions(+)

diff --git a/autoload/SpaceVim/plugins/runner.vim b/autoload/SpaceVim/plugins/runner.vim
index f030ba5dd..9d06855e1 100644
--- a/autoload/SpaceVim/plugins/runner.vim
+++ b/autoload/SpaceVim/plugins/runner.vim
@@ -6,6 +6,20 @@
 " License: GPLv3
 "=============================================================================
 
+""
+" @section runner, plugins-runner
+" @parentsection plugins
+" The `code runner` plugin provides the ability to run code snippet or code
+" file for a variety of programming languages, as well as running custom commands. 
+" 
+" @subsection Key bindings
+" >
+"   Key binding     Description
+"   SPC s r         start default code runner
+"   q               close coder runner window
+"   i               insert text to background process
+" <
+
 let s:runners = {}
 
 let s:JOB = SpaceVim#api#import('job')
diff --git a/doc/SpaceVim.txt b/doc/SpaceVim.txt
index aee1a2e36..52e23e1fc 100644
--- a/doc/SpaceVim.txt
+++ b/doc/SpaceVim.txt
@@ -231,6 +231,7 @@ CONTENTS                                                   *SpaceVim-contents*
       8. windows-and-tabs....................|SpaceVim-usage-windows-and-tabs|
   8. Plugins................................................|SpaceVim-plugins|
       1. iedit........................................|SpaceVim-plugins-iedit|
+      2. runner......................................|SpaceVim-plugins-runner|
   9. API........................................................|SpaceVim-api|
       1. clock............................................|SpaceVim-api-clock|
       2. cmdlinemenu................................|SpaceVim-api-cmdlinemenu|
@@ -5513,6 +5514,21 @@ After starting iedit, the following key bindings can be used:
   Iedit-Normal    Ctrl-p      inactivate current match and move backward
 <
 
+==============================================================================
+RUNNER                                               *SpaceVim-plugins-runner*
+
+The `code runner` plugin provides the ability to run code snippet or code file
+for a variety of programming languages, as well as running custom commands.
+
+KEY BINDINGS
+
+>
+  Key binding     Description
+  SPC s r         start default code runner
+  q               close coder runner window
+  i               insert text to background process
+<
+
 ==============================================================================
 API                                                             *SpaceVim-api*