]> git.wincent.com - docvim.git/blob - tests/fixtures/integration/pinnacle/golden/markdown.golden
Add additional blank line above headings
[docvim.git] / tests / fixtures / integration / pinnacle / golden / markdown.golden
1
2 # Pinnacle<a name="pinnacle-pinnacle" href="#user-content-pinnacle-pinnacle"></a>
3
4
5 ## Intro<a name="pinnacle-intro" href="#user-content-pinnacle-intro"></a>
6
7 Pinnacle provides functions for manipulating <strong>`:highlight`</strong> groups.
8
9
10 ## Installation<a name="pinnacle-installation" href="#user-content-pinnacle-installation"></a>
11
12 To install Pinnacle, use your plug-in management system of choice.
13
14 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:
15
16 ```
17 git clone https://github.com/wincent/pinnacle.git ~/.vim/bundle/pinnacle
18 ```
19
20 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:
21
22 ```
23 git submodule add https://github.com/wincent/pinnacle.git ~/vim/bundle/pinnacle
24 git submodule init
25 ```
26
27 To generate help tags under Pathogen, you can do so from inside Vim with:
28
29 ```
30 :call pathogen#helptags()
31 ```
32
33
34 ## Website<a name="pinnacle-website" href="#user-content-pinnacle-website"></a>
35
36 The official Pinnacle source code repo is at:
37
38 http://git.wincent.com/pinnacle.git
39
40 Mirrors exist at:
41
42 - https://github.com/wincent/pinnacle
43 - https://gitlab.com/wincent/pinnacle
44 - https://bitbucket.org/ghurrell/pinnacle
45
46 Official releases are listed at:
47
48 http://www.vim.org/scripts/script.php?script_id=5360
49
50
51 ## License<a name="pinnacle-license" href="#user-content-pinnacle-license"></a>
52
53 Copyright (c) 2016-present Greg Hurrell
54
55 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:
56
57 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
58
59 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.
60
61
62 ## Development<a name="pinnacle-development" href="#user-content-pinnacle-development"></a>
63
64
65 ### Contributing patches<a name="pinnacle-contributing-patches" href="#user-content-pinnacle-contributing-patches"></a>
66
67 Patches can be sent via mail to greg@hurrell.net, or as GitHub pull requests at: https://github.com/wincent/pinnacle/pulls
68
69
70 ### Cutting a new release<a name="pinnacle-cutting-a-new-release" href="#user-content-pinnacle-cutting-a-new-release"></a>
71
72 At the moment the release process is manual:
73
74 - Perform final sanity checks and manual testing
75 - Update the <strong>[`pinnacle-history`](#user-content-pinnacle-history)</strong> section of the documentation
76 - Verify clean work tree:
77
78 ```
79 git status
80 ```
81
82 - Tag the release:
83
84 ```
85 git tag -s -m "$VERSION release" $VERSION
86 ```
87
88 - Publish the code:
89
90 ```
91 git push origin master --follow-tags
92 git push github master --follow-tags
93 ```
94
95 - Produce the release archive:
96
97 ```
98 git archive -o vim-docvim-$VERSION.zip HEAD -- .
99 ```
100
101 - Upload to http://www.vim.org/scripts/script.php?script_id=5360
102
103
104 ## Authors<a name="pinnacle-authors" href="#user-content-pinnacle-authors"></a>
105
106 Pinnacle is written and maintained by Greg Hurrell <greg@hurrell.net>.
107
108
109 ## History<a name="pinnacle-history" href="#user-content-pinnacle-history"></a>
110
111
112 ### 0.1 (30 March 2016)<a name="pinnacle-01-30-march-2016" href="#user-content-pinnacle-01-30-march-2016"></a>
113
114 - Initial release.