Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add initial vim help doc #11

Merged
merged 2 commits into from
Jul 25, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions doc/vivify.txt
Original file line number Diff line number Diff line change
@@ -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 <leader>v <cmd>Vivify<cr>
<
Tip: to set a keybind for Markdown files only, add the mapping in your
|ftplugin| directory under markdown.vim as: >
nnoremap <buffer> <leader>v <cmd>Vivify<cr>
<

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: