]> git.wincent.com - docvim.git/blob - tests/fixtures/integration/scalpel/golden/markdown.golden
Add additional blank line above headings
[docvim.git] / tests / fixtures / integration / scalpel / golden / markdown.golden
1
2 # scalpel<a name="scalpel-scalpel" href="#user-content-scalpel-scalpel"></a>
3
4
5 ## Intro<a name="scalpel-intro" href="#user-content-scalpel-intro"></a>
6
7 Scalpel provides a streamlined shortcut for replacing all instances of the word currently under the cursor throughout a file.
8
9 In normal mode pressing `<Leader>e` (mnemonic: "edit") will display a prompt pre-populated with the current word and with the cursor placed so that you can start typing the desired replacement:
10
11 ```
12 :Scalpel/\v<foo>//
13 ```
14
15 Press `<Enter>` and Scalpel will prompt to confirm each substitution, starting at the current word (unlike a normal `:%s` command, which starts at the top of the file).
16
17 Scalpel works similarly in visual mode, except that it scopes itself to the current visual selection rather than operating over the entire file.
18
19 Note that `:Scalpel` just calls through to an underlying `scalpel#substitute` function that does the real work, ultimately calling Vim's own `:substitute`. As such, be aware that whatever changes you make to the command-line prior to pressing `<Enter>` must keep it a valid pattern, or bad things will happen.
20
21 The mapping can be suppressed by setting:
22
23 ```
24 let g:ScalpelMap=0
25 ```
26
27 Or overridden:
28
29 ```
30 " Use <Leader>s instead of default <Leader>e:
31 nmap <Leader>s <Plug>(Scalpel)
32 ```
33
34 In any case, Scalpel won't overwrite any pre-existing mapping that you might have defined for `<Leader>e`, nor will it create an unnecessary redundant mapping if you've already mapped something to `<Plug>(Scalpel)`.
35
36 The `:Scalpel` command name can be overridden if desired. For example, you could shorten it to `:S` with:
37
38 ```
39 let g:ScalpelCommand='S'
40 ```
41
42 Then your Scalpel prompt would look like:
43
44 ```
45 :S/\v<foo>//
46 ```
47
48 The command can be entirely suppressed by setting `g:ScalpelCommand` to an empty string:
49
50 ```
51 let g:ScalpelCommand=''
52 ```
53
54 Finally, all plug-in functionality can be deactivated by setting:
55
56 ```
57 let g:ScalpelLoaded=1
58 ```
59
60 in your `~/.vimrc`.
61
62
63 ## Installation<a name="scalpel-installation" href="#user-content-scalpel-installation"></a>
64
65 To install Scalpel, use your plug-in management system of choice.
66
67 If you don't have a "plug-in management system of choice" and your version of Vim has `packages` support (ie. `+packages` appears in the output of `:version`) then you can simply place the plugin at a location under your `'packpath'` (eg. `~/.vim/pack/bundle/start/scalpel` or similar).
68
69 For older versions of Vim, 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 Scalpel into `~/.vim/bundle`, you can do so with:
70
71 ```
72 git clone https://github.com/wincent/scalpel.git ~/.vim/bundle/scalpel
73 ```
74
75 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:
76
77 ```
78 git submodule add https://github.com/wincent/scalpel.git ~/vim/bundle/scalpel
79 git submodule init
80 ```
81
82 To generate help tags under Pathogen, you can do so from inside Vim with:
83
84 ```
85 :call pathogen#helptags()
86 ```
87
88
89 ## Website<a name="scalpel-website" href="#user-content-scalpel-website"></a>
90
91 The official Scalpel source code repo is at:
92
93 http://git.wincent.com/scalpel.git
94
95 Mirrors exist at:
96
97 - https://github.com/wincent/scalpel
98 - https://gitlab.com/wincent/scalpel
99 - https://bitbucket.org/ghurrell/scalpel
100
101 Official releases are listed at:
102
103 http://www.vim.org/scripts/script.php?script_id=5381
104
105
106 ## License<a name="scalpel-license" href="#user-content-scalpel-license"></a>
107
108 Copyright (c) 2016-present Greg Hurrell
109
110 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:
111
112 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
113
114 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.
115
116
117 ## Development<a name="scalpel-development" href="#user-content-scalpel-development"></a>
118
119
120 ### Contributing patches<a name="scalpel-contributing-patches" href="#user-content-scalpel-contributing-patches"></a>
121
122 Patches can be sent via mail to greg@hurrell.net, or as GitHub pull requests at: https://github.com/wincent/scalpel/pulls
123
124
125 ### Cutting a new release<a name="scalpel-cutting-a-new-release" href="#user-content-scalpel-cutting-a-new-release"></a>
126
127 At the moment the release process is manual:
128
129 - Perform final sanity checks and manual testing.
130 - Update the [scalpel-history](#user-content-scalpel-history) section of the documentation.
131 - Regenerate the documentation:
132
133 ```
134 docvim README.md doc/scalpel.txt
135 ```
136
137 - Verify clean work tree:
138
139 ```
140 git status
141 ```
142
143 - Tag the release:
144
145 ```
146 git tag -s -m "$VERSION release" $VERSION
147 ```
148
149 - Publish the code:
150
151 ```
152 git push origin master --follow-tags
153 git push github master --follow-tags
154 ```
155
156 - Produce the release archive:
157
158 ```
159 git archive -o scalpel-$VERSION.zip HEAD -- .
160 ```
161
162 - Upload to http://www.vim.org/scripts/script.php?script_id=5381
163
164
165 ## Authors<a name="scalpel-authors" href="#user-content-scalpel-authors"></a>
166
167 Scalpel is written and maintained by Greg Hurrell <greg@hurrell.net>.
168
169
170 ## History<a name="scalpel-history" href="#user-content-scalpel-history"></a>
171
172
173 ### 0.2 (not yet released)<a name="scalpel-02-not-yet-released" href="#user-content-scalpel-02-not-yet-released"></a>
174
175 - Support visual mode.
176
177
178 ### 0.1 (29 April 2016)<a name="scalpel-01-29-april-2016" href="#user-content-scalpel-01-29-april-2016"></a>
179
180 - Initial release.