sponsor Vim development Vim logo Vim Book Ad

vim-docvim : Syntax highlighting for Docvim comments

 script karma  Rating 0/0, Downloaded by 388  Comments, bugs, improvements  Vim wiki

created by
Greg Hurrell
 
script type
syntax
 
description
*docvim.txt*            Syntax highlighting for docvim comments           *docvim*

CONTENTS                                                       *docvim-contents*

1. Intro           |docvim-intro|
2. Installation    |docvim-installation|
3. Related         |docvim-related|
4. Website         |docvim-website|
5. License         |docvim-license|
6. Development     |docvim-development|
7. Authors         |docvim-authors|
8. History         |docvim-history|


                                                                    *vim-docvim*
INTRO                                                             *docvim-intro*

vim-docvim provides additional 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                                               *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                                                         *docvim-related*

Docvim ~

The Docvim tool itself is a Haskell module, available at:

http://hackage.haskell.org/package/docvim

The official source code repo is at:

http://git.wincent.com/docvim.git

Mirrors exist at:

- https://github.com/wincent/docvim
- https://gitlab.com/wincent/docvim
- https://bitbucket.org/ghurrell/docvim

WEBSITE                                                         *docvim-website*

The official vim-docvim source code repo is at:

http://git.wincent.com/vim-docvim.git

Mirrors exist at:

- https://github.com/wincent/vim-docvim
- https://gitlab.com/wincent/vim-docvim
- https://bitbucket.org/ghurrell/vim-docvim

Official releases are listed at:

http://www.vim.org/scripts/script.php?script_id=5758

LICENSE                                                         *docvim-license*

Copyright (c) 2015-present Greg Hurrell

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.

DEVELOPMENT                                                 *docvim-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=5758

AUTHORS                                                         *docvim-authors*

vim-docvim is written and maintained by Greg Hurrell <greg@hurrell.net>.

 
install details
 

rate this script Life Changing Helpful Unfulfilling 
script versions (upload new version)

Click on the package to download.

package script version date Vim version user release notes
vim-docvim-1.0.zip 1.0 2018-12-26 7.0 Greg Hurrell Initial upload
ip used for rating: 18.210.12.229

If you have questions or remarks about this site, visit the vimonline development pages. Please use this site responsibly.
Questions about Vim should go to the maillist. Help Bram help Uganda.
   
OSDN