From 653ddc27c75ecaefad24a78986802ff887310324 Mon Sep 17 00:00:00 2001 From: Tuure Date: Wed, 24 Jul 2024 16:51:13 +0300 Subject: [PATCH 1/2] Add initial vim help doc --- doc/vivify.txt | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 doc/vivify.txt diff --git a/doc/vivify.txt b/doc/vivify.txt new file mode 100644 index 0000000..aae6de6 --- /dev/null +++ b/doc/vivify.txt @@ -0,0 +1,46 @@ +*vivify.txt* Markdown preview on the browser + + +INTRODUCTION *vivify* + +Connects (Neo)Vim to the Vivify Markdown preview tool. +View and live-sync Markdown files while editing. + + +USAGE *vivify-usage* + +Use the command :Vivify to open the current buffer in the browser. + +You may also want to map it to a keybind, for example: > + nnoremap v Vivify +< +Tip: to set a keybind for Markdown files only, add the mapping in your +ftplugin directory under markdown.vim as: > + nnoremap v Vivify +< + +CONFIGURATION *vivify-configuration* + +Refresh page contents on TextChanged and TextChangedI (default): > + let g:vivify_instant_refresh = 1 +< +Refresh page contents on CursorHold and CursorHoldI: > + let g:vivify_instant_refresh = 0 +< +To recognize other filetypes as markdown, use g:vivify_filetypes array, +for example: > + let g:vivify_filetypes = ['vimwiki'] +< + +CONTRIBUTING *vivify-contributing* + +Bug reports, feature requests and questions welcome! + +For this plugin: + https://github.com/jannis-baum/vivify.vim + +For Vivify: + https://github.com/jannis-baum/Vivify + + +vim:tw=78:sw=4:ts=8:ft=help:norl: From 85c7166887001050ade52099f2a9931f835752b9 Mon Sep 17 00:00:00 2001 From: Tuure Date: Wed, 24 Jul 2024 21:30:36 +0300 Subject: [PATCH 2/2] Add references to other help pages where needed From `:h help-writing`: When referring to an existing help tag and to create a hot-link, place the name between two bars ("|") eg. |help-writing|. Gives a helpful highlight and allows using on top of them --- doc/vivify.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/vivify.txt b/doc/vivify.txt index aae6de6..ac8ddc9 100644 --- a/doc/vivify.txt +++ b/doc/vivify.txt @@ -15,16 +15,16 @@ You may also want to map it to a keybind, for example: > nnoremap v Vivify < Tip: to set a keybind for Markdown files only, add the mapping in your -ftplugin directory under markdown.vim as: > +|ftplugin| directory under markdown.vim as: > nnoremap v Vivify < CONFIGURATION *vivify-configuration* -Refresh page contents on TextChanged and TextChangedI (default): > +Refresh page contents on |TextChanged| and |TextChangedI| (default): > let g:vivify_instant_refresh = 1 < -Refresh page contents on CursorHold and CursorHoldI: > +Refresh page contents on |CursorHold| and |CursorHoldI|: > let g:vivify_instant_refresh = 0 < To recognize other filetypes as markdown, use g:vivify_filetypes array,