"" " @plugin docvim Syntax highlighting for docvim comments " " *vim-docvim* " # Intro " " vim-docvim provides syntax highlighting for Vim script files that contain " embedded docvim comments. " " docvim (the tool, not this plug-in) is a documentation generator that " processes those embedded comments and produces documentation in Markdown and " Vim "help" formats. To avoid confusion, this document refers to the Vim " plug-in as "vim-docvim" and the separate generation tool as "docvim". " " " # Installation " " To install vim-docvim, use your plug-in management system of choice. " " If you don't have a "plug-in management system of choice", I recommend " Pathogen (https://github.com/tpope/vim-pathogen) due to its simplicity and " robustness. Assuming that you have Pathogen installed and configured, and that " you want to install vim-docvim into `~/.vim/bundle`, you can do so with: " " ``` " git clone https://github.com/wincent/vim-docvim.git ~/.vim/bundle/vim-docvim " ``` " " Alternatively, if you use a Git submodule for each Vim plug-in, you could do " the following after `cd`-ing into the top-level of your Git superproject: " " ``` " git submodule add https://github.com/wincent/vim-docvim.git ~/vim/bundle/vim-docvim " git submodule init " ``` " " To generate help tags under Pathogen, you can do so from inside Vim with: " " ``` " :call pathogen#helptags() " ``` " " " # Related " " The docvim tool itself is an NPM module, available at: " " https://www.npmjs.com/package/docvim " " The official source code repo is at: " " http://git.wincent.com/docvim.git " " A mirror exists at: " " https://github.com/wincent/docvim " " " # Website " " The official vim-docvim source code repo is at: " " http://git.wincent.com/vim-docvim.git " " A mirror exists at: " " https://github.com/wincent/vim-docvim " " Official releases are listed at: " " http://www.vim.org/scripts/script.php?script_id=[TODO] " " " # License " " Copyright 2015-present Greg Hurrell. All rights reserved. " " Redistribution and use in source and binary forms, with or without " modification, are permitted provided that the following conditions are met: " " 1. Redistributions of source code must retain the above copyright notice, " this list of conditions and the following disclaimer. " 2. Redistributions in binary form must reproduce the above copyright notice, " this list of conditions and the following disclaimer in the documentation " and/or other materials provided with the distribution. " " THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" " AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE " IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE " ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE " LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR " CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF " SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS " INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN " CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) " ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE " POSSIBILITY OF SUCH DAMAGE. " " " # Development " " ## Contributing patches " " Patches can be sent via mail to greg@hurrell.net, or as GitHub pull requests " at: https://github.com/wincent/vim-docvim/pulls " " ## Cutting a new release " " At the moment the release process is manual: " " - Perform final sanity checks and manual testing " - Update the |docvim-history| section of the documentation " - Verify clean work tree: " " ``` " git status " ``` " " - Tag the release: " " ``` " git tag -s -m "$VERSION release" $VERSION " ``` " " - Publish the code: " " ``` " git push origin master --follow-tags " git push github master --follow-tags " ``` " " - Produce the release archive: " " ``` " git archive -o vim-docvim-$VERSION.zip HEAD -- . " ``` " " - Upload to http://www.vim.org/scripts/script.php?script_id=[TODO] " " " # Authors " " vim-docvim is written and maintained by Greg Hurrell . " " " # History " " 0.1 (not yet released) " " - Initial release. syntax region docvimBlock start='\v^\s*""' end='\v^\zs\ze\s*($|[^ \t"])' containedin=vimFuncBody syntax region docvimPre start='\v^\s*"\s+\zs```\s*$' end='\v^\s*"\s+```\s*$' containedin=docvimBlock contained keepend syntax match docvimAnnotation '\v\@command( .+)?' containedin=docvimBlock contained syntax match docvimAnnotation '@dedent' containedin=docvimBlock contained syntax match docvimAnnotation '@footer' containedin=docvimBlock contained syntax match docvimAnnotation '\v\@function( .+)?' containedin=docvimBlock contained syntax match docvimAnnotation '@indent' containedin=docvimBlock contained syntax match docvimAnnotation '\v\@mapping( .+)?' containedin=docvimBlock contained syntax match docvimAnnotation '@mappings' containedin=docvimBlock contained syntax match docvimAnnotation '\v\@option( .+)?' containedin=docvimBlock contained syntax match docvimAnnotation '@param' containedin=docvimBlock contained syntax match docvimAnnotation '\v\@plugin( .+)?' containedin=docvimBlock contained syntax match docvimAnnotation '@private' containedin=docvimBlock contained syntax match docvimBackticks '\v`[^\s`]+`' containedin=docvimBlock contained syntax match docvimBlockquote '\v^\s*"\s+\zs\>\s+.+$' containedin=docvimBlock contained syntax match docvimCrossReference '\v\c\|:?[a-z0-9()<>\.:-]+\|' containedin=docvimBlock contained syntax match docvimHeading '\v^\s*"\s+\zs#\s+.+$' containedin=docvimBlock contained syntax match docvimPreComment '\v^\s*"' containedin=docvimPre contained syntax match docvimSetting "\v'[a-z]{2,}'" containedin=docvimBlock contained syntax match docvimSetting "\v't_..'" containedin=docvimBlock contained syntax match docvimSpecial '\v\' containedin=docvimBlock contained syntax match docvimSpecial '\v\<[-a-zA-Z0-9_]+\>' containedin=docvimBlock contained syntax match docvimSubheading '\v^\s*"\s+\zs##\s+.+$' containedin=docvimBlock contained syntax match docvimTarget '\v\c\*:?[a-z0-9()<>-]+\*' containedin=docvimBlock contained " Stolen from $VIMRUNTIME/syntax/help.vim: syntax match docvimURL `\v<(((https?|ftp|gopher)://|(mailto|file|news):)[^' <>"]+|(www|web|w3)[a-z0-9_-]*\.[a-z0-9._-]+\.[^' <>"]+)[a-zA-Z0-9/]` containedin=docvimBlock contained if has('conceal') syntax match docvimBacktick '\v`' containedin=docvimBackticks contained conceal syntax match docvimBar '\v\|' containedin=docvimCrossReference contained conceal syntax match docvimHeadingPrefix '\v# ' containedin=docvimHeading contained conceal syntax match docvimStar '\v\*' containedin=docvimTarget contained conceal syntax match docvimSubheadingPrefix '\v## ' containedin=docvimSubheading contained conceal else syntax match docvimBacktick '\v`' containedin=docvimBackticks contained syntax match docvimBar '\v\|' containedin=docvimCrossReference contained syntax match docvimHeadingPrefix '\v# ' containedin=docvimHeading contained syntax match docvimStar '\v\*' containedin=docvimTarget contained syntax match docvimSubheadingPrefix '\v## ' containedin=docvimSubheading contained endif highlight default link docvimAnnotation String highlight default link docvimBacktick Ignore highlight default link docvimBackticks Ignore highlight default link docvimBar Identifier highlight default link docvimBlock Normal highlight default link docvimBlockquote Comment highlight default link docvimComment Normal highlight default link docvimCrossReference Identifier highlight default link docvimHeading Identifier highlight default link docvimHeadingPrefix Identifier highlight default link docvimPre Ignore highlight default link docvimSetting Type highlight default link docvimSpecial Special highlight default link docvimStar String highlight default link docvimSubheading PreProc highlight default link docvimSubheadingPrefix PreProc highlight default link docvimTarget String highlight default link docvimURL String