Skip to content

Commit b4fcfa1

Browse files
authored
Standardize Markdown Code Block Syntax (#2479)
1 parent d857021 commit b4fcfa1

File tree

6 files changed

+44
-46
lines changed

6 files changed

+44
-46
lines changed

contrib/npm.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,19 @@
44
55
Add to your _deploy.php_
66
7-
~~~php
7+
```php
88
require 'contrib/npm.php';
9-
~~~
9+
```
1010
1111
## Configuration
1212
1313
- `bin/npm` *(optional)*: set npm binary, automatically detected otherwise.
1414
1515
## Usage
1616
17-
~~~php
17+
```php
1818
after('deploy:update_code', 'npm:install');
19-
~~~
19+
```
2020
2121
*/
2222
namespace Deployer;

docs/KNOWN_BUGS.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,21 @@
22

33
## Ubuntu 14.04, Coreutils 8.21
44

5-
There are known bug with relative symlinks `ln --relative`, which may fail rollback command.
5+
There are known bug with relative symlinks `ln --relative`, which may fail rollback command.
66

77
Add next line to _deploy.php_ file:
88

9-
~~~php
9+
```php
1010
set('use_relative_symlink', false);
11-
~~~
12-
11+
```
1312

1413
## OpenSSH_7.2p2
15-
14+
1615
ControlPersist causes stderr to be left open until the master connection times out.
1716

1817
* https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=714526
1918
* https://bugzilla.mindrot.org/show_bug.cgi?id=1988
2019

21-
2220
## cURL 7.29.0
2321

2422
Certificate verification fails with multiple https urls.

docs/cli.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
After [installation](installation.md) of Deployer you will have the ability to run the `dep` command from your terminal.
44

5-
To get list of all available tasks run the `dep` command. You can run it from any subdirectories of you project;
6-
Deployer will automatically find project root dir.
7-
8-
~~~bash
5+
To get list of all available tasks run the `dep` command. You can run it from any subdirectories of you project;
6+
Deployer will automatically find project root dir.
7+
8+
```bash
99
Deployer
1010

1111
Usage:
@@ -28,19 +28,19 @@ Available commands:
2828
run Run any arbitrary command on hosts
2929
self-update Updates deployer.phar to the latest version
3030
ssh Connect to host through ssh
31-
~~~
31+
```
3232

3333
The best way to configure your `deploy.php` is to automatically deploy to staging on this command:
34-
35-
~~~bash
34+
35+
```bash
3636
dep deploy
37-
~~~
37+
```
3838

3939
This is so somebody can't accidentally deploy to production (for production deployment, the `dep deploy production` command explicitly lists the required production stage).
4040

4141
You need info about available options and usage use the `help` command:
42-
43-
~~~bash
42+
43+
```bash
4444
$ dep help deploy
4545
Usage:
4646
deploy [options] [--] [<stage>]
@@ -67,62 +67,62 @@ Options:
6767
--revision[=REVISION] Revision to deploy
6868
--branch[=BRANCH] Branch to deploy
6969
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
70-
70+
7171
Help:
7272
Deploy your project
73-
~~~
73+
```
7474

7575
### Overriding configuration options
7676

7777
For example, if your _deploy.php_ file contains this configuration:
7878

79-
~~~php
79+
```php
8080
set('ssh_multiplexing', false);
81-
~~~
81+
```
8282

8383
And you want to enable [ssh multiplexing](https://en.wikibooks.org/wiki/OpenSSH/Cookbook/Multiplexing) without modifying the file, you can pass the `-o` option to the `dep` command:
8484

85-
~~~bash
85+
```bash
8686
dep deploy -o ssh_multiplexing=true
87-
~~~
87+
```
8888

8989
To override multiple config options, you can pass multiple `-o` args:
9090

91-
~~~bash
91+
```bash
9292
dep deploy -o ssh_multiplexing=true -o branch=master
93-
~~~
93+
```
9494

9595
### Running arbitrary commands
96-
96+
9797
Deployer comes with a command to run any valid command on you server without modifying _deploy.php_
98-
99-
~~~bash
98+
99+
```bash
100100
dep run 'ls -la'
101-
~~~
101+
```
102102

103103
To specify the hosts this command has the corresponding options:
104104

105-
~~~
105+
```
106106
--stage=STAGE Stage to deploy
107107
--roles=ROLES Roles to deploy
108108
--hosts=HOSTS Host to deploy, comma separated, supports ranges [:]
109-
~~~
109+
```
110110

111111
### Getting help
112112

113113
You can get more info about any commands by using the help command:
114114

115-
~~~
115+
```bash
116116
dep help [command]
117-
~~~
117+
```
118118

119119
### Autocomplete
120120

121121
Deployer comes with an autocomplete script for bash/zsh/fish, so you don't need to remember all the tasks and options.
122122
To install it run following command:
123123

124-
~~~bash
124+
```bash
125125
dep autocomplete
126-
~~~
126+
```
127127

128128
And follow instructions.

docs/contrib/npm.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,19 @@
1111

1212
Add to your _deploy.php_
1313

14-
~~~php
14+
```php
1515
require 'contrib/npm.php';
16-
~~~
16+
```
1717

1818
## Configuration
1919

2020
- `bin/npm` *(optional)*: set npm binary, automatically detected otherwise.
2121

2222
## Usage
2323

24-
~~~php
24+
```php
2525
after('deploy:update_code', 'npm:install');
26-
~~~
26+
```
2727

2828

2929

docs/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,9 +142,9 @@ after('deploy', 'reload:php-fpm');
142142

143143
If you need to connect to the host, Deployer has a shortcut for faster access:
144144

145-
~~~sh
145+
```sh
146146
dep ssh
147-
~~~
147+
```
148148

149149
This command will connect to selected hosts and cd to `current_path`.
150150

docs/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,9 @@ This will build the `deployer.phar` phar archive.
9191
Deployer comes with an autocomplete script for bash/zsh/fish, so you don't need to remember all tasks and options.
9292
To install, run the following command:
9393

94-
~~~bash
94+
```sh
9595
dep autocomplete
96-
~~~
96+
```
9797

9898
And follow the instructions.
9999

0 commit comments

Comments
 (0)