doc: regen with current docvim
authorGreg Hurrell <greg@hurrell.net>
Tue, 25 Dec 2018 19:45:48 +0000 (20:45 +0100)
committerGreg Hurrell <greg@hurrell.net>
Tue, 25 Dec 2018 19:45:48 +0000 (20:45 +0100)
README.md

index 7f060b65d1da4833d8694916fe6a66a52911ec62..f023e0065c54616e100511c7009eb0e448782b03 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,17 +1,20 @@
+
 # 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".
+docvim (the tool, not this plug-in) is a documentation generator that processes those embedded comments and produces documentation in Markdown and Vim &quot;help&quot; formats. To avoid confusion, this document refers to the Vim plug-in as &quot;vim-docvim&quot; and the separate generation tool as &quot;docvim&quot;.
+
 
 ## Installation<a name="docvim-installation" href="#user-content-docvim-installation"></a>
 
 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:
+If you don't have a &quot;plug-in management system of choice&quot;, 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
@@ -30,8 +33,10 @@ To generate help tags under Pathogen, you can do so from inside Vim with:
 :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:
@@ -48,6 +53,7 @@ Mirrors exist 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:
@@ -64,22 +70,26 @@ Official releases are listed 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
 
-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:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the &quot;Software&quot;), 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.
+THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, 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:
@@ -113,12 +123,15 @@ git archive -o vim-docvim-$VERSION.zip HEAD -- .
 
 - 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>.
+vim-docvim is written and maintained by Greg Hurrell &lt;greg@hurrell.net&gt;.
+
 
 ## 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.