vim-docvim

Ⅰ. 插件描述

Syntax highlighting for Docvim comments

Ⅱ. 基本信息

创建日期：  2015-07-28
使用用户：  1
Github星：  9
插件作者：  Greg Hurrell

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加: 
Plugin 'wincent/vim-docvim'
… 然后在Vim中运行以下命令: 
:source %
:PluginInstall

对于Vundle版本 < 0.10.2，请用上面的Bundle替换Plugin。

使用NeoBundle管理器安装

在你的.vimrc下添加: 
NeoBundle 'wincent/vim-docvim'
… 然后在Vim中运行以下命令: 
:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加: 
Plug 'wincent/vim-docvim'
… 然后在Vim中运行以下命令: 
:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令: 
cd ~/.vim/bundle
git clone https://github.com/wincent/vim-docvim

Ⅳ. 文档说明

# docvim

<p align="right">vim-docvim</p>

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

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

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:

Website

The official vim-docvim source code repo is at:

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

Mirrors exist at:

Official releases are listed at:

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

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

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 -- .

Authors

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

History

1.0 (25 December 2018)

  • Initial release.

添加新评论