Skip to content

Commit 32467e2

Browse files
committed
Update the docs
1 parent 2297a45 commit 32467e2

File tree

6 files changed

+30
-31
lines changed

6 files changed

+30
-31
lines changed

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,31 +21,30 @@
2121
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/features_list.md">🏰 Features</a> |
2222
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md">🎛️ Options</a> |
2323
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/ReadMe.md">📚 Examples</a> |
24-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/console_scripts/ReadMe.md">🌠 Scripts</a> |
24+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/console_scripts/ReadMe.md">🪄 Scripts</a> |
2525
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/mobile_testing.md">📱 Mobile</a>
2626
<br />
27-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md">📘 API</a> |
28-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/syntax_formats.md"> 🔠 Syntaxes</a> |
27+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md">📘 The API</a> |
28+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/syntax_formats.md"> 🔠 SyntaxFormats</a> |
2929
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/recorder_mode.md">🔴 Recorder</a> |
3030
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md">📊 Dashboard</a> |
31-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/locale_codes.md">🗾 Locale</a> |
32-
<a href="https://seleniumbase.io/devices/?url=seleniumbase.com">💻 Farm</a>
31+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/locale_codes.md">🗾 Locale</a>
3332
<br />
3433
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/commander.md">🎖️ GUI</a> |
3534
<a href="https://seleniumbase.io/demo_page">📰 TestPage</a> |
3635
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/uc_mode.md">👤 UC Mode</a> |
3736
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/cdp_mode/ReadMe.md">🐙 CDP Mode</a> |
38-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/chart_maker/ReadMe.md">📶 Charts</a> |
39-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md">🌐 Grid</a>
37+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/chart_maker/ReadMe.md">📶 Charts</a> |
38+
<a href="https://seleniumbase.io/devices/?url=seleniumbase.com">🖥️ Farm</a>
4039
<br />
4140
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/how_it_works.md">👁️ How</a> |
42-
<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/migration/raw_selenium">🚝 Migrate</a> |
43-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/cdp_mode/playwright/ReadMe.md">🎭 Stealthy Playwright Mode</a> |
44-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md">🛂 M-QA</a> |
41+
<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/migration/raw_selenium">🚝 Migration</a> |
42+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/cdp_mode/playwright/ReadMe.md">🎭 Stealthy Playwright</a> |
43+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md">🛂 MasterQA</a> |
4544
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md">🚎 Tours</a>
4645
<br />
4746
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/github/workflows/ReadMe.md">🤖 CI/CD</a> |
48-
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/js_package_manager.md">🕹️ JSMgr</a> |
47+
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/js_package_manager.md">️ JSMgr</a> |
4948
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/translations.md">🌏 Translator</a> |
5049
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/presenter/ReadMe.md">🎞️ Presenter</a> |
5150
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/visual_testing/ReadMe.md">🖼️ Visual</a> |

examples/cdp_mode/playwright/ReadMe.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!-- SeleniumBase Docs -->
22

3-
<h2><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32"></a> Stealthy Playwright 🎭</h2>
3+
<h2><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32"></a> Stealthy Playwright Mode 🎭</h2>
44

5-
🎭 <b translate="no">Stealthy Playwright Mode</b> is a special mode of <b translate="no">SeleniumBase</b> that launches <a href="https://github.com/microsoft/playwright-python">Playwright</a> from <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/cdp_mode/ReadMe.md" translate="no">SeleniumBase CDP Mode</a> in order to grant <b translate="no">Playwright</b> new stealth features, such as the ability to click CAPTCHA checkboxes successfully. <b translate="no">Playwright</b> uses <code>connect_over_cdp()</code> to attach itself onto an existing <b translate="no">SeleniumBase</b> session via the <code>remote-debugging-port</code>. From here, APIs of both frameworks can be used, giving you a hybrid approach that delivers the best experience of both worlds.
5+
🎭 <b translate="no">Stealthy Playwright Mode</b> is a subset of **[SeleniumBase CDP Mode](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/cdp_mode/ReadMe.md)** that launches **[Playwright](https://github.com/microsoft/playwright-python)** from an existing <b translate="no">SeleniumBase</b> browser to make <span translate="no">Playwright</span> stealthy (for bypassing bot-detection). <span translate="no">Playwright</span> uses <code><b>connect_over_cdp()</b></code> to attach itself onto an existing <span translate="no">SeleniumBase</span> session via the <code>remote-debugging-port</code>. From here, APIs of both frameworks can be used together.
66

77
--------
88

@@ -138,4 +138,4 @@ For more examples, see [examples/cdp_mode/playwright](https://github.com/seleniu
138138

139139
--------
140140

141-
<a href="https://github.com/seleniumbase/SeleniumBase"><img src="https://seleniumbase.github.io/img/logo6.png" alt="SeleniumBase" title="SeleniumBase" width="100" /></a><img src="https://seleniumbase.github.io/other/playwright_logo.png" alt="Playwright" title="SeleniumBase" height="100">
141+
<a href="https://github.com/seleniumbase/SeleniumBase"><img src="https://seleniumbase.github.io/img/logo6.png" alt="SeleniumBase" title="SeleniumBase" width="100" /></a><img src="https://seleniumbase.github.io/other/playwright_logo.png" alt="Playwright" title="Playwright" width="161">

help_docs/ReadMe.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<a href="https://seleniumbase.io/examples/ReadMe/">📚 Examples</a> |
1515
<a href="https://seleniumbase.io/help_docs/mobile_testing/">📱 Emulator</a>
1616
<br />
17-
<a href="https://seleniumbase.io/seleniumbase/console_scripts/ReadMe/">🌠 Console Scripts</a> |
17+
<a href="https://seleniumbase.io/seleniumbase/console_scripts/ReadMe/">🪄 Console Scripts</a> |
1818
<a href="https://seleniumbase.io/seleniumbase/utilities/selenium_grid/ReadMe/">🌐 Grid</a>
1919
<br />
2020
<a href="https://seleniumbase.io/help_docs/method_summary/">📘 Methods / APIs</a> |
@@ -26,14 +26,14 @@
2626
<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/boilerplates">♻️ Boilerplates</a> |
2727
<a href="https://seleniumbase.io/help_docs/locale_codes/">🗾 Locale Codes</a>
2828
<br />
29-
<a href="https://seleniumbase.io/help_docs/js_package_manager/">🕹️ JS Manager</a> |
29+
<a href="https://seleniumbase.io/help_docs/js_package_manager/">️ JS Manager</a> |
3030
<a href="https://seleniumbase.io/examples/visual_testing/ReadMe/">🖼️ Visual Testing</a>
3131
<br />
3232
<a href="https://seleniumbase.io/help_docs/translations/">🌏 Translator</a> |
3333
<a href="https://seleniumbase.io/examples/dialog_boxes/ReadMe/">🛂 Dialog Boxes</a>
3434
<br />
3535
<a href="https://seleniumbase.io/help_docs/recorder_mode/">🔴 Recorder</a> |
36-
<a href="https://seleniumbase.io/devices/?url=seleniumbase.io">💻 Device Farm</a>
36+
<a href="https://seleniumbase.io/devices/?url=seleniumbase.io">🖥️ Device Farm</a>
3737
<br />
3838
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/cdp_mode/playwright/ReadMe.md">🎭 Stealthy Playwright Mode</a>
3939
<br />

help_docs/js_package_manager.md

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

33
<h2><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32"> JS Package Manager and Code Generators</h2>
44

5-
<h3>🕹️ SeleniumBase lets you load JavaScript packages from any CDN link into any website via Python.</h3>
5+
<h3>️ SeleniumBase lets you load JavaScript packages from any CDN link into any website via Python.</h3>
66

77
<b>🎨 The following SeleniumBase solutions utilize this feature:</b>
88

@@ -29,7 +29,7 @@ cd examples/tour_examples
2929
pytest maps_introjs_tour.py --interval=1
3030
```
3131

32-
<p>🕹️ SeleniumBase includes powerful JS code generators for converting Python into JavaScript for using the supported JS packages. A few lines of Python in your tests might generate hundreds of lines of JavaScript.</p>
32+
<p>️ SeleniumBase includes powerful JS code generators for converting Python into JavaScript for using the supported JS packages. A few lines of Python in your tests might generate hundreds of lines of JavaScript.</p>
3333

3434
<p>🗺️ Here is some tour code in Python from <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/maps_introjs_tour.py">maps_introjs_tour.py</a> that expands into a lot of JavaScript.</p>
3535

@@ -44,21 +44,21 @@ self.export_tour(filename="maps_introjs_tour.js")
4444
self.play_tour()
4545
```
4646

47-
<p><div>🕹️ For existing features, SeleniumBase already takes care of loading all the necessary JS and CSS files into the web browser. To load other packages, here are a few useful methods that you should know about:</div></p>
47+
<p><div>️ For existing features, SeleniumBase already takes care of loading all the necessary JS and CSS files into the web browser. To load other packages, here are a few useful methods that you should know about:</div></p>
4848

4949
```python
5050
self.add_js_link(js_link)
5151
```
5252

53-
<p><div>🕹️ This example loads the <a href="https://introjs.com/">IntroJS</a> JavaScript library:</div></p>
53+
<p><div>️ This example loads the <a href="https://introjs.com/">IntroJS</a> JavaScript library:</div></p>
5454

5555
```python
5656
self.add_js_link("https://cdn.jsdelivr.net/npm/[email protected]/intro.min.js")
5757
```
5858

59-
<div>🕹️ You can load any JS package this way as long as you know the URL.</div>
59+
<div>️ You can load any JS package this way as long as you know the URL.</div>
6060

61-
<p>🕹️ If you're wondering how SeleniumBase does this, here's the full Python code from <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/fixtures/js_utils.py">js_utils.py</a>, which uses WebDriver's <code>execute_script()</code> method for making JS calls after escaping quotes with backslashes as needed:</p>
61+
<p>️ If you're wondering how SeleniumBase does this, here's the full Python code from <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/fixtures/js_utils.py">js_utils.py</a>, which uses WebDriver's <code>execute_script()</code> method for making JS calls after escaping quotes with backslashes as needed:</p>
6262

6363
```python
6464
def add_js_link(driver, js_link):
@@ -78,19 +78,19 @@ def add_js_link(driver, js_link):
7878
driver.execute_script(script_to_add_js % js_link)
7979
```
8080

81-
<p>🕹️ Now that you've loaded JavaScript into the browser, you may also want to load some CSS to go along with it:</p>
81+
<p>️ Now that you've loaded JavaScript into the browser, you may also want to load some CSS to go along with it:</p>
8282

8383
```python
8484
self.add_css_link(css_link)
8585
```
8686

87-
<p>🕹️ Here's code that loads the <a href="https://introjs.com/">IntroJS</a> CSS:</p>
87+
<p>️ Here's code that loads the <a href="https://introjs.com/">IntroJS</a> CSS:</p>
8888

8989
```python
9090
self.add_css_link("https://cdnjs.cloudflare.com/ajax/libs/intro.js/2.9.3/introjs.css")
9191
```
9292

93-
<p>🕹️ And here's the Python WebDriver code that makes this possible:</p>
93+
<p>️ And here's the Python WebDriver code that makes this possible:</p>
9494

9595
```python
9696
def add_css_link(driver, css_link):
@@ -109,7 +109,7 @@ def add_css_link(driver, css_link):
109109
driver.execute_script(script_to_add_css % css_link)
110110
```
111111

112-
<div>🕹️ Website tours are just one of the many uses of the JS Package Manager.</div>
112+
<div>️ Website tours are just one of the many uses of the JS Package Manager.</div>
113113
<p><div>🛂 The following example shows the <a href="https://github.com/craftpip/jquery-confirm">JqueryConfirm</a> package loaded into a website for creating fancy dialog boxes:</div></p>
114114

115115
<img src="https://seleniumbase.github.io/cdn/img/emoji_sports_dialog.png" alt="SeleniumBase" width="480" />
@@ -127,7 +127,7 @@ pytest test_dialog_boxes.py
127127

128128
<p><div>(Example from the <a href="https://seleniumbase.io/examples/dialog_boxes/ReadMe/">Dialog Boxes ReadMe</a>)</div></p>
129129

130-
<div>🕹️ Since packages are loaded directly from a CDN link, you won't need other package managers like NPM, Bower, or Yarn to get the packages that you need into the websites that you want.</div>
130+
<div>️ Since packages are loaded directly from a CDN link, you won't need other package managers like NPM, Bower, or Yarn to get the packages that you need into the websites that you want.</div>
131131

132132
--------
133133

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ nav:
9595
- 🏰 List of Features: help_docs/features_list.md
9696
- 📚 Running Example Tests: examples/ReadMe.md
9797
- 🎛️ Command Line Options: help_docs/customizing_test_runs.md
98-
- 🌠 Console Scripts: seleniumbase/console_scripts/ReadMe.md
98+
- 🪄 Console Scripts: seleniumbase/console_scripts/ReadMe.md
9999
- 📊 Dashboard / Reports: examples/example_logs/ReadMe.md
100100
- 🔡 Syntax Formats: help_docs/syntax_formats.md
101101
- 🎖️ GUI / Commander: help_docs/commander.md
@@ -108,7 +108,7 @@ nav:
108108
- 🏄 Install SeleniumBase: help_docs/install.md
109109
- 👁️ How it Works: help_docs/how_it_works.md
110110
- JS Manager / JS Tools:
111-
- 🕹️ Package Manager: help_docs/js_package_manager.md
111+
- ❇️ JS Package Manager: help_docs/js_package_manager.md
112112
- 🎦 Demo Mode: help_docs/demo_mode.md
113113
- 🚎 Tour Maker: examples/tour_examples/ReadMe.md
114114
- 🛂 Dialog Boxes: examples/dialog_boxes/ReadMe.md

seleniumbase/console_scripts/ReadMe.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- SeleniumBase Docs -->
22

3-
<h2><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32"></a> Console Scripts 🌠</h2>
3+
<h2><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32"></a> Console Scripts 🪄</h2>
44

55
🌟 SeleniumBase console scripts can do many things, such as downloading web drivers, creating test directories with config files, activating the SeleniumBase Recorder, launching the SeleniumBase Commander, translating tests into other languages, running a Selenium Grid, and more.
66

0 commit comments

Comments
 (0)