vim-haredoc

commit 1809c8d5c66b850c6752f933394698d98766a69e
parent 0cd736c4f45b8c8312836e8383ffa3f83964301f
Author: Byron Torres <b@torresjrjr.com>
Date:   Wed, 11 May 2022 14:12:22 +0100

add doc/haredoc.txt help file and tags

Diffstat:
M
README.md
 | 
5
+++++
A
doc/haredoc.txt
 | 
31
+++++++++++++++++++++++++++++++
A
doc/tags
 | 
5
+++++

3 files changed, 41 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -21,6 +21,11 @@ In your shell:
 		~/.vim/pack/plugins/start/vim-haredoc
 
 
+## Usage
+
+	:help haredoc
+
+
 ## Resources
 
 Send patches to <~torresjrjr/public-inbox@lists.sr.ht> ([archive][a]).
diff --git a/doc/haredoc.txt b/doc/haredoc.txt
@@ -0,0 +1,31 @@
+*haredoc.txt* *haredoc*                                           haredoc in vim
+
+This plugin integrates the haredoc command of the Hare programming language,
+which looks up and displays documentation for the Hare standard library and
+your own Hare modules. See haredoc(1).
+
+        https://docs.harelang.org/
+
+This plugin appropriately uses |popup-window| and |terminal-window| to display
+documentation. If either |+popupwin| or |+terminal| is not available, this
+plugin falls back to a normal window.
+
+
+MAPPINGS
+
+                                                        *K* *haredoc-K*
+K                       Show documentation in a |popup-window| for the
+                        symbol under the cursor
+
+
+COMMANDS
+
+                                                        *:Haredoc*
+
+:Haredoc {symbol}       Show documentation in a |terminal-window| for the
+                        symbol under the cursor.
+
+:Haredoc .              Same as the |K| command.
+
+
+ vim:tw=78:ts=8:noet:ft=help:norl:
diff --git a/doc/tags b/doc/tags
@@ -0,0 +1,5 @@
+:Haredoc	haredoc.txt	/*:Haredoc*
+K	haredoc.txt	/*K*
+haredoc	haredoc.txt	/*haredoc*
+haredoc-K	haredoc.txt	/*haredoc-K*
+haredoc.txt	haredoc.txt	/*haredoc.txt*