Skip to content

Commit d2e9782

Browse files
committed
Update Markdown format in the docs
1 parent 52216be commit d2e9782

File tree

9 files changed

+49
-49
lines changed

9 files changed

+49
-49
lines changed

integrations/azure/jenkins/ReadMe.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
#### On the main page, you should be able to find the Public IP Address.
5454
* **Use that IP Address to SSH into the machine:**
5555

56-
```bash
56+
```zsh
5757
ssh USERNAME@IP_ADDRESS
5858
```
5959

@@ -65,63 +65,63 @@ ssh USERNAME@IP_ADDRESS
6565

6666
### Step 4. Clone the SeleniumBase repository from the root ("/") directory.
6767

68-
```bash
68+
```zsh
6969
cd /
7070
sudo git clone https://github.com/seleniumbase/SeleniumBase.git
7171
```
7272

7373
### Step 5. Enter the "linux" folder
7474

75-
```bash
75+
```zsh
7676
cd SeleniumBase/integrations/linux/
7777
```
7878

7979
### Step 6. Give the "jenkins" user sudo access (See [jenkins_permissions.sh](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/linux/jenkins_permissions.sh) for details)
8080

81-
```bash
81+
```zsh
8282
./jenkins_permissions.sh
8383
```
8484

8585
### Step 7. Become the "jenkins" user and enter a "bash" shell
8686

87-
```bash
87+
```zsh
8888
sudo su jenkins
8989
bash
9090
```
9191

9292
### Step 8. Install dependencies (See [Linuxfile.sh](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/linux/Linuxfile.sh) for details)
9393

94-
```bash
94+
```zsh
9595
./Linuxfile.sh
9696
```
9797

9898
### Step 9. Start up the headless browser display mechanism: Xvfb (See [Xvfb_launcher.sh](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/linux/Xvfb_launcher.sh) for details)
9999

100-
```bash
100+
```zsh
101101
./Xvfb_launcher.sh
102102
```
103103

104104
### Step 10. Go to the SeleniumBase directory
105105

106-
```bash
106+
```zsh
107107
cd /SeleniumBase
108108
```
109109

110110
### Step 11. Install the [requirements](https://github.com/seleniumbase/SeleniumBase/blob/master/requirements.txt) for SeleniumBase
111111

112-
```bash
112+
```zsh
113113
sudo pip install -r requirements.txt --upgrade
114114
```
115115

116116
### Step 12. Install SeleniumBase (Make sure you already installed the requirements above)
117117

118-
```bash
118+
```zsh
119119
sudo python setup.py develop
120120
```
121121

122122
### Step 13. Install chromedriver
123123

124-
```bash
124+
```zsh
125125
sudo seleniumbase install chromedriver
126126
```
127127

@@ -131,7 +131,7 @@ sudo seleniumbase install chromedriver
131131

132132
----------
133133

134-
```bash
134+
```zsh
135135
pytest examples/my_first_test.py --headless --browser=chrome
136136
```
137137

@@ -163,7 +163,7 @@ pytest examples/my_first_test.py --headless --browser=chrome
163163

164164
#### You'll need to get the password from the SSH terminal on the Linux machine to log in:
165165

166-
```bash
166+
```zsh
167167
sudo cat /var/lib/jenkins/secrets/initialAdminPassword
168168
```
169169

@@ -209,7 +209,7 @@ sudo cat /var/lib/jenkins/secrets/initialAdminPassword
209209
* **Select "Execute shell".**
210210
* **For the "Command", paste:**
211211

212-
```bash
212+
```zsh
213213
cd examples
214214
pytest my_first_test.py --headless
215215
```

integrations/behave/ReadMe.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
🐝 Behave examples with SeleniumBase: [SeleniumBase/examples/behave_bdd](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/behave_bdd)
66

7-
```bash
7+
```zsh
88
> cd examples/behave_bdd/
99
> behave features/realworld.feature -T -D dashboard -k
1010

@@ -38,7 +38,7 @@ Took 0m4.682s
3838

3939
🐝 Another example, which uses higher-level Behave steps to simplify the ``.feature`` file:
4040

41-
```bash
41+
```zsh
4242
> cd examples/behave_bdd/
4343
> behave features/calculator.feature:61 -T -D dashboard -k
4444

@@ -82,7 +82,7 @@ Took 0m1.672s
8282

8383
🐝 The ``*.feature`` files can use any step seen from:
8484

85-
```bash
85+
```zsh
8686
behave --steps-catalog
8787
```
8888

@@ -195,7 +195,7 @@ Feature: SeleniumBase scenarios for the RealWorld App
195195

196196
🐝 If there's a test failure, that's easy to spot:
197197

198-
```bash
198+
```zsh
199199
Feature: SeleniumBase scenarios for the Fail Page # features/fail_page.feature:1
200200

201201
Scenario: Fail test on purpose to see what happens # features/fail_page.feature:3
@@ -214,7 +214,7 @@ Feature: SeleniumBase scenarios for the Fail Page # features/fail_page.feature:1
214214
215215
🐝🎖️ To launch it, call ``sbase behave-gui`` or ``sbase gui-behave``:
216216
217-
```bash
217+
```zsh
218218
sbase behave-gui
219219
* Starting the SeleniumBase Behave Commander GUI App...
220220
```
@@ -223,7 +223,7 @@ sbase behave-gui
223223
224224
🐝🎖️ You can customize the tests that show up there:
225225
226-
```bash
226+
```zsh
227227
sbase behave-gui # all tests
228228
sbase behave-gui -i=calculator # tests with "calculator" in the name
229229
sbase behave-gui features/ # tests located in the "features/" folder

integrations/brython/ReadMe.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@
99

1010
### 0. Install ``brython``:
1111

12-
```bash
12+
```zsh
1313
pip install brython
1414
```
1515

1616
### 1. Get a web server up and running:
1717

1818
<i>Run from [SeleniumBase/integrations/brython](https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/brython)</i>:
1919

20-
```bash
20+
```zsh
2121
python -m http.server
2222
```
2323

integrations/google_cloud/ReadMe.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -28,77 +28,77 @@
2828

2929
#### Step 4. Clone the SeleniumBase repository from the root ("/") directory.
3030

31-
```bash
31+
```zsh
3232
cd /
3333
sudo git clone https://github.com/seleniumbase/SeleniumBase.git
3434
```
3535

3636
#### Step 5. Enter the "linux" folder
3737

38-
```bash
38+
```zsh
3939
cd SeleniumBase/integrations/linux/
4040
```
4141

4242
#### Step 6. Give Jenkins (aka "tomcat" user) sudo access (See [tomcat_permissions.sh](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/linux/tomcat_permissions.sh) for details)
4343

44-
```bash
44+
```zsh
4545
./tomcat_permissions.sh
4646
```
4747

4848
#### Step 7. Become "tomcat" (the Jenkins user) and enter a "bash" shell
4949

50-
```bash
50+
```zsh
5151
sudo su tomcat
5252
bash
5353
```
5454

5555
#### Step 8. Install dependencies (See [Linuxfile.sh](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/linux/Linuxfile.sh) for details)
5656

57-
```bash
57+
```zsh
5858
./Linuxfile.sh
5959
```
6060

6161
#### Step 9. Start up the headless browser display mechanism: Xvfb (See [Xvfb_launcher.sh](https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/linux/Xvfb_launcher.sh) for details)
6262

63-
```bash
63+
```zsh
6464
./Xvfb_launcher.sh
6565
```
6666

6767
#### Step 10. Go to the SeleniumBase directory
6868

69-
```bash
69+
```zsh
7070
cd /SeleniumBase
7171
```
7272

7373
#### Step 11. Install the [requirements](https://github.com/seleniumbase/SeleniumBase/blob/master/requirements.txt) for SeleniumBase
7474

75-
```bash
75+
```zsh
7676
sudo pip install -r requirements.txt --upgrade
7777
```
7878

7979
#### Step 12. Install SeleniumBase
8080

81-
```bash
81+
```zsh
8282
sudo python setup.py develop
8383
```
8484

8585
#### Step 13. Run an [example test](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py) on Chrome to verify installation (May take up to 10 seconds)
8686

8787
![](https://seleniumbase.github.io/cdn/img/gcp/gcp_bitnami.png "Linux SSH Terminal")
8888

89-
```bash
89+
```zsh
9090
pytest examples/my_first_test.py --headless
9191
```
9292

9393
#### Step 14. If you prefer using nosetests, that works too
9494

95-
```bash
95+
```zsh
9696
nosetests examples/my_first_test.py --headless
9797
```
9898

9999
#### Step 15. You can also verify that the example test runs on Firefox
100100

101-
```bash
101+
```zsh
102102
pytest examples/my_first_test.py --headless --browser=firefox
103103
```
104104

@@ -122,7 +122,7 @@ pytest examples/my_first_test.py --headless --browser=firefox
122122
* Under "Build", click the "Add build step" dropdown and then select "Execute shell".
123123
* For the "Command", put:
124124

125-
```bash
125+
```zsh
126126
pytest examples/my_first_test.py --headless
127127
```
128128

@@ -183,7 +183,7 @@ If you have a web application that you want to test, you'll be able to create Se
183183

184184
* For the "Execute shell", use the following as your updated "Command":
185185

186-
```bash
186+
```zsh
187187
pytest examples/test_suite.py --headless --with-db_reporting
188188
```
189189

integrations/katalon/ReadMe.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Katalon Recorder (Selenium IDE) is a tool that allows you to record and playback
1616

1717
#### Step 3: Run ``seleniumbase convert`` on your exported Python file
1818

19-
```bash
19+
```zsh
2020
seleniumbase convert MY_TEST.py
2121
```
2222

integrations/node_js/ReadMe.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,21 @@ You can create a customized web app for running SeleniumBase tests by using Node
1515

1616
#### 2. Upgrade NodeJS (if using an older version)
1717

18-
```bash
18+
```zsh
1919
npm install -g npm@latest
2020
```
2121

2222
#### 3. Install the example Test Runner for SeleniumBase from [integrations/node_js](https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/node_js). (If dependencies were already installed, you can use `npm ci` for a speed improvement over `npm i` / `npm install` because `npm ci` uses `npm-shrinkwrap.json`, which is generated via ``npm shrinkwrap``.)
2323

24-
```bash
24+
```zsh
2525
npm install
2626
```
2727

2828
(You should see a `node_modules` folder appear in your `node_js` folder.)
2929

3030
#### 4. Run the NodeJS server for your SeleniumBase Test Runner web app
3131

32-
```bash
32+
```zsh
3333
node server.js
3434
```
3535

integrations/selenium_ide/ReadMe.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Katalon Recorder (Selenium IDE) is a tool that allows you to record and playback
1616

1717
#### Step 3: Run ``seleniumbase convert`` on your exported Python file
1818

19-
```bash
19+
```zsh
2020
seleniumbase convert MY_TEST.py
2121
```
2222

seleniumbase/utilities/selenium_grid/ReadMe.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ The following commands will work once you've installed seleniumbase.
1212

1313
<h4><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="28" /> Downloading the Selenium Server JAR file:</h4>
1414

15-
```bash
15+
```zsh
1616
seleniumbase download server
1717
```
1818

1919
* (Required for using your own Selenium Grid)
2020

2121
<h4><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="28" /> Grid Hub server controls:</h4>
2222

23-
```bash
23+
```zsh
2424
seleniumbase grid-hub {start|stop|restart} [OPTIONS]
2525
```
2626

@@ -32,7 +32,7 @@ seleniumbase grid-hub {start|stop|restart} [OPTIONS]
3232

3333
<h4><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="28" /> Grid node server controls:</h4>
3434

35-
```bash
35+
```zsh
3636
seleniumbase grid-node {start|stop|restart} --hub=[HUB_IP] [OPTIONS]
3737
```
3838

@@ -46,28 +46,28 @@ When the Grid Hub Console is up and running, you'll be able to find it here: [ht
4646

4747
Now you can run your tests on the Selenium Grid:
4848

49-
```bash
49+
```zsh
5050
pytest test_demo_site.py --server=IP_ADDRESS --port=4444
5151
```
5252

5353
You can also run your tests on someone else's Selenium Grid to avoid managing your own. Here are some Selenium Grids that you can use (and the run command format):
5454

5555
* [BrowserStack](https://www.browserstack.com/automate#) Selenium Grid:
5656

57-
```bash
57+
```zsh
5858
pytest test_demo_site.py --server=USERNAME:[email protected] --port=80
5959
```
6060

6161
* [Sauce Labs](https://saucelabs.com/products/platform-configurator) Selenium Grid:
6262

63-
```bash
63+
```zsh
6464
pytest test_demo_site.py --server=USERNAME:[email protected] --port=443 --protocol=https
6565
```
6666

6767
To use a server on the ``https`` protocol, add ``--protocol=https``:
6868
(<i>SeleniumBase 1.65.2 and newer uses ``https`` automatically for ``--port=443``.</i>)
6969

70-
```bash
70+
```zsh
7171
pytest test_demo_site.py --protocol=https --server=IP_ADDRESS --port=PORT
7272
```
7373

0 commit comments

Comments
 (0)