]> git.wincent.com - vim-docvim.git/blob - doc/vim-docvim.txt
Add documentation generated by docvim
[vim-docvim.git] / doc / vim-docvim.txt
1 *docvim.txt*            Syntax highlighting for docvim comments           *docvim*
2
3 CONTENTS                                                       *docvim-contents*
4
5 1. Intro           |docvim-intro|
6 2. Installation    |docvim-installation|
7 3. Related         |docvim-related|
8 4. Website         |docvim-website|
9 5. License         |docvim-license|
10 6. Development     |docvim-development|
11 7. Authors         |docvim-authors|
12 8. History         |docvim-history|
13
14
15                                                                     *vim-docvim*
16 INTRO                                                             *docvim-intro*
17
18 vim-docvim provides additional syntax highlighting for Vim script files that
19 contain embedded docvim comments.
20
21 docvim (the tool, not this plug-in) is a documentation generator that
22 processes those embedded comments and produces documentation in Markdown and
23 Vim "help" formats. To avoid confusion, this document refers to the Vim
24 plug-in as "vim-docvim" and the separate generation tool as "docvim".
25
26 INSTALLATION                                               *docvim-installation*
27
28 To install vim-docvim, use your plug-in management system of choice.
29
30 If you don't have a "plug-in management system of choice", I recommend
31 Pathogen (https://github.com/tpope/vim-pathogen) due to its simplicity and
32 robustness. Assuming that you have Pathogen installed and configured, and
33 that you want to install vim-docvim into `~/.vim/bundle`, you can do so with:
34 >
35     git clone https://github.com/wincent/vim-docvim.git ~/.vim/bundle/vim-docvim
36 <
37 Alternatively, if you use a Git submodule for each Vim plug-in, you could do
38 the following after `cd`-ing into the top-level of your Git superproject:
39 >
40     git submodule add https://github.com/wincent/vim-docvim.git ~/vim/bundle/vim-docvim
41     git submodule init
42 <
43 To generate help tags under Pathogen, you can do so from inside Vim with:
44 >
45     :call pathogen#helptags()
46 <
47 RELATED                                                         *docvim-related*
48
49 Docvim ~
50
51 The Docvim tool itself is a Haskell module, available at:
52
53 http://hackage.haskell.org/package/docvim
54
55 The official source code repo is at:
56
57 http://git.wincent.com/docvim.git
58
59 Mirrors exist at:
60
61 - https://github.com/wincent/docvim
62 - https://gitlab.com/wincent/docvim
63 - https://bitbucket.org/ghurrell/docvim
64
65 WEBSITE                                                         *docvim-website*
66
67 The official vim-docvim source code repo is at:
68
69 http://git.wincent.com/vim-docvim.git
70
71 Mirrors exist at:
72
73 - https://github.com/wincent/vim-docvim
74 - https://gitlab.com/wincent/vim-docvim
75 - https://bitbucket.org/ghurrell/vim-docvim
76
77 Official releases are listed at:
78
79 http://www.vim.org/scripts/script.php?script_id=[TODO]
80
81 LICENSE                                                         *docvim-license*
82
83 Copyright (c) 2015-present Greg Hurrell
84
85 Permission is hereby granted, free of charge, to any person obtaining a copy
86 of this software and associated documentation files (the "Software"), to
87 deal in the Software without restriction, including without limitation the
88 rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
89 sell copies of the Software, and to permit persons to whom the Software is
90 furnished to do so, subject to the following conditions:
91
92 The above copyright notice and this permission notice shall be included in
93 all copies or substantial portions of the Software.
94
95 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
96 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
97 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
98 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
99 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
100 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
101 IN THE SOFTWARE.
102
103 DEVELOPMENT                                                 *docvim-development*
104
105 Contributing patches ~
106
107 Patches can be sent via mail to greg@hurrell.net, or as GitHub pull requests
108 at: https://github.com/wincent/vim-docvim/pulls
109
110 Cutting a new release ~
111
112 At the moment the release process is manual:
113
114 - Perform final sanity checks and manual testing
115 - Update the |docvim-history| section of the documentation
116 - Verify clean work tree:
117 >
118     git status
119 <
120 - Tag the release:
121 >
122     git tag -s -m "$VERSION release" $VERSION
123 <
124 - Publish the code:
125 >
126     git push origin master --follow-tags
127     git push github master --follow-tags
128 <
129 - Produce the release archive:
130 >
131     git archive -o vim-docvim-$VERSION.zip HEAD -- .
132 <
133 - Upload to http://www.vim.org/scripts/script.php?script_id=[TODO]
134
135 AUTHORS                                                         *docvim-authors*
136
137 vim-docvim is written and maintained by Greg Hurrell <greg@hurrell.net>.
138
139 HISTORY                                                         *docvim-history*
140
141 0.1 (not yet released) ~
142
143 - Initial release.