diff options
| -rw-r--r-- | README.md | 5 | ||||
| -rw-r--r-- | doc/haredoc.txt | 31 | ||||
| -rw-r--r-- | doc/tags | 5 |
3 files changed, 41 insertions, 0 deletions
@@ -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 new file mode 100644 index 0000000..a11b2a2 --- /dev/null +++ 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 new file mode 100644 index 0000000..bac0b1a --- /dev/null +++ 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* |