+
# docvim<a name="docvim-docvim" href="#user-content-docvim-docvim"></a>
<p align="right"><a name="vim-docvim" href="#user-content-vim-docvim"><code>vim-docvim</code></a></p>
+
## Intro<a name="docvim-intro" href="#user-content-docvim-intro"></a>
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<a name="docvim-installation" href="#user-content-docvim-installation"></a>
To install vim-docvim, use your plug-in management system of choice.
:call pathogen#helptags()
```
+
## Related<a name="docvim-related" href="#user-content-docvim-related"></a>
+
### Docvim<a name="docvim-docvim" href="#user-content-docvim-docvim"></a>
The Docvim tool itself is a Haskell module, available at:
- https://gitlab.com/wincent/docvim
- https://bitbucket.org/ghurrell/docvim
+
## Website<a name="docvim-website" href="#user-content-docvim-website"></a>
The official vim-docvim source code repo is at:
http://www.vim.org/scripts/script.php?script_id=[TODO]
+
## License<a name="docvim-license" href="#user-content-docvim-license"></a>
Copyright (c) 2015-present Greg Hurrell
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<a name="docvim-development" href="#user-content-docvim-development"></a>
+
### Contributing patches<a name="docvim-contributing-patches" href="#user-content-docvim-contributing-patches"></a>
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<a name="docvim-cutting-a-new-release" href="#user-content-docvim-cutting-a-new-release"></a>
At the moment the release process is manual:
- Upload to http://www.vim.org/scripts/script.php?script_id=[TODO]
+
## Authors<a name="docvim-authors" href="#user-content-docvim-authors"></a>
vim-docvim is written and maintained by Greg Hurrell <greg@hurrell.net>.
+
## History<a name="docvim-history" href="#user-content-docvim-history"></a>
+
### 0.1 (not yet released)<a name="docvim-01-not-yet-released" href="#user-content-docvim-01-not-yet-released"></a>
- Initial release.