Skip to content
This repository was archived by the owner on Sep 16, 2021. It is now read-only.

Commit a5901ad

Browse files
JosipTrbuscicantonmedv
authored andcommitted
Escape markdown in headings (#126)
Headings that contain two underscores were displayed in cursive on https://deployer.org/docs/configuration.html. This closes #1830
1 parent bcfde31 commit a5901ad

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

configuration.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ task('deploy', function () {
1111
~~~
1212

1313
Each parameter can be overridden for each host:
14-
14+
1515
~~~php
1616
host(...)
1717
->set('param', 'new value');
@@ -61,7 +61,7 @@ dep config:hosts
6161

6262
Below is a list of common variables.
6363

64-
### deploy_path
64+
### deploy\_path
6565

6666
Where to deploy application on remote host. You should define this variable for all of your hosts.
6767
For example, if you want to deploy your app to home directory:
@@ -86,7 +86,7 @@ set('user', function () {
8686
~~~
8787

8888
You can override it in _deploy.php_ for example to use env var:
89-
89+
9090
~~~php
9191
set('user', function () {
9292
return getenv('DEP_USER');
@@ -99,7 +99,7 @@ set('user', function () {
9999
set('slack_text', '{{user}} deploying {{branch}} to {{hostname}}');
100100
~~~
101101

102-
### release_path
102+
### release\_path
103103

104104
Full path to the current release directory. Current dir path in non-deploy contexts.
105105
Use it as working path for your build:
@@ -116,7 +116,7 @@ task('build', function () {
116116
> task('build', 'webpack -p');
117117
> ~~~
118118
119-
### previous_release
119+
### previous\_release
120120
121121
Points to previous release if it exists. Otherwise variable doesn't exist.
122122
@@ -130,15 +130,15 @@ task('npm', function () {
130130
});
131131
~~~
132132
133-
### ssh_multiplexing
133+
### ssh\_multiplexing
134134

135135
Use [ssh multiplexing](https://en.wikibooks.org/wiki/OpenSSH/Cookbook/Multiplexing) to speedup the native ssh client.
136136

137137
~~~php
138138
set('ssh_multiplexing', true);
139139
~~~
140140

141-
### default_stage
141+
### default\_stage
142142

143143
If the hosts declaration has stages, this option allows you to select the default stage to deploy with `dep deploy`.
144144

@@ -189,7 +189,7 @@ set('default_stage', function() {
189189

190190
The result is that only \MyVendor\getDefaultStage() is run.
191191

192-
### keep_releases
192+
### keep\_releases
193193

194194
Number of releases to keep. `-1` for unlimited releases. Default to `5`.
195195

@@ -203,15 +203,15 @@ as a Deploy Key (a.k.a. Access Key). This key allows your host to pull out the c
203203
Note that the first time a host connects, it can ask to add host in `known_hosts` file. The easiest way to do this is
204204
by running `git clone <repo>` on your host and saying `yes` when prompted.
205205

206-
### git_tty
206+
### git\_tty
207207

208208
Allocate TTY for `git clone` command. `false` by default. This allow you to enter a passphrase for keys or add host to `known_hosts`.
209209

210210
~~~php
211211
set('git_tty', true);
212212
~~~
213213

214-
### git_recursive
214+
### git\_recursive
215215

216216
Set the `--recursive` flag for git clone. `true` by default. Setting this to `false` will prevent submodules from being cloned as well.
217217

@@ -232,7 +232,7 @@ dep deploy --revision="5daefb59edbaa75"
232232

233233
Note that `tag` has higher priority than `branch` and lower than `revision`.
234234

235-
### shared_dirs
235+
### shared\_dirs
236236

237237
List of shared dirs.
238238

@@ -244,19 +244,19 @@ set('shared_dirs', [
244244
]);
245245
~~~
246246

247-
### shared_files
247+
### shared\_files
248248

249249
List of shared files.
250250

251-
### copy_dirs
251+
### copy\_dirs
252252

253253
List of files to copy between release.
254254

255-
### writable_dirs
255+
### writable\_dirs
256256

257257
List of dirs which must be writable for web server.
258258

259-
### writable_mode
259+
### writable\_mode
260260

261261
Writable mode
262262

@@ -265,51 +265,51 @@ Writable mode
265265
* `chown` use unix `chown` command,
266266
* `chgrp` use unix `chgrp` command,
267267

268-
### writable_use_sudo
268+
### writable\_use\_sudo
269269

270270
Whether to use `sudo` with writable command. Default to `false`.
271271

272-
### writable_chmod_mode
272+
### writable\_chmod\_mode
273273

274274
Mode for setting `writable_mode` in `chmod`. Default: `0755`.
275275

276-
### writable_chmod_recursive
276+
### writable\_chmod\_recursive
277277

278278
Whether to set `chmod` on dirs recursively or not. Default: `true`.
279279

280-
### http_user
280+
### http\_user
281281

282282
User the web server runs as. If this parameter is not configured, deployer try to detect it from the process list.
283283

284-
### clear_paths
284+
### clear\_paths
285285

286286
List of paths which need to be deleted in release after updating code.
287287

288-
### clear_use_sudo
288+
### clear\_use\_sudo
289289

290-
Use or not `sudo` with clear_paths. Default to `false`.
290+
Use or not `sudo` with clear\_paths. Default to `false`.
291291

292-
### cleanup_use_sudo
292+
### cleanup\_use\_sudo
293293

294294
Whether to use `sudo` with `cleanup` task. Default to `false`.
295295

296-
### use_relative_symlink
296+
### use\_relative\_symlink
297297

298298
Whether to use relative symlinks. By default deployer will detect if the system supports relative symlinks and use them.
299299

300300
> Relative symlink used by default, if your system supports it.
301301
302-
### use_atomic_symlink
302+
### use\_atomic\_symlink
303303

304304
Whether to use atomic symlinks. By default deployer will detect if system supports atomic symlinks and use them.
305305

306306
> Atomic symlinking is used by default, if your system supports it.
307307
308-
### composer_action
308+
### composer\_action
309309

310310
Composer action. Default is `install`.
311311

312-
### composer_options
312+
### composer\_options
313313

314314
Options for Composer.
315315

0 commit comments

Comments
 (0)