diff --git a/doc/git-messenger.txt b/doc/git-messenger.txt index 6ce1632..18f978e 100644 --- a/doc/git-messenger.txt +++ b/doc/git-messenger.txt @@ -70,11 +70,11 @@ Please ensure the following requirement before installing this plugin. If you use any package manager, please follow its instruction. With vim-plug: -> +>vim Plug 'rhysd/git-messenger.vim' < With dein.vim: -> +>vim call dein#add('rhysd/git-messenger.vim', { \ 'lazy' : 1, \ 'on_cmd' : 'GitMessenger', @@ -82,7 +82,7 @@ With dein.vim: \ }) < With minpac: -> +>vim call minpac#add('rhysd/git-messenger.vim') < If you're using Vim's builtin packager, please follow instruction at |pack-add|. @@ -268,7 +268,7 @@ limit. String value to format dates in popup window. Please see |strftime()| to know the details of the format. -> +>vim " Example: '2019 May 26 03:27:43' let g:git_messenger_date_format = "%Y %b %d %X" < @@ -284,7 +284,7 @@ Note: Word diff is enabled by typing "r" in a popup window. Options passed to |nvim_open_win| on opening a popup window. This is useful when you want to override some window options. The following example will add single border line to the window. -> +>vim let g:git_messenger_floating_win_opts = { 'border': 'single' } < *g:git_messenger_popup_content_margins* (Default: |v:true|) @@ -307,7 +307,7 @@ Highlights for diff are common with normal |diff| filetype syntax highlighting. If the groups don't fit, please rearrange the highlight with |:hi-link|. For example: -> +>vim " Normal color in popup window with 'CursorLine' hi link gitmessengerPopupNormal CursorLine @@ -325,7 +325,7 @@ For example: < For another example, if you want to define colors directly, defining the colors with |:hi| works fine as follows. -> +>vim hi gitmessengerPopupNormal term=None guifg=#eeeeee guibg=#333333 ctermfg=255 ctermbg=234 hi gitmessengerHeader term=None guifg=#88b8f6 ctermfg=111 hi gitmessengerHash term=None guifg=#f0eaaa ctermfg=229 @@ -350,7 +350,7 @@ Filetype *gitmessengerpopup* is set in the popup window. Please hook |FileType| event to do some local setup within a popup window. For example: -> +>vim function! s:setup_gitmessengerpopup() abort " For example, set go back/forward history to / nmap o @@ -365,12 +365,12 @@ HEALTH CHECK *git-messenger-health-check* |git-messenger.vim| supports a health checker on Neovim. When you see some error, please run `:checkhealth` to check your environment is ready for use of this plugin. -> +>vim :checkhealth < On Vim, please install vim-healthcheck and run `:CheckHealth`. It's a plugin to run `:checkhealth` on Vim. -> +>vim :CheckHealth < https://github.com/rhysd/vim-healthcheck