Skip to content

Commit 1044a0d

Browse files
committed
Update the docs
1 parent a854d75 commit 1044a0d

File tree

4 files changed

+43
-8
lines changed

4 files changed

+43
-8
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
<meta property="og:site_name" content="SeleniumBase">
2-
<meta property="og:title" content="SeleniumBase - Test Automation Framework" />
1+
<meta property="og:site_name" content="SeleniumBase | Docs">
2+
<meta property="og:title" content="SeleniumBase | Reliable Test Automation" />
33
<meta property="og:description" content="Simple browser automation and testing with Python." />
44
<meta property="og:image" content="https://seleniumbase.io/img/sb_logo_7.png" />
55
<link rel="icon" href="https://seleniumbase.io/img/logo3a.png" />
6+
<!-- SeleniumBase Header -->
67
<p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/">
78
<img src="https://seleniumbase.io/img/sb_logo_7.png" alt="SeleniumBase" width="260" />
89
</a></p>
@@ -44,6 +45,7 @@
4445
</p>
4546
<p align="center"><div align="center"><img src="https://cdn2.hubspot.net/hubfs/100006/images/swag_labs_gif.gif" alt="SeleniumBase" title="SeleniumBase" /></div></p>
4647

48+
<!-- SeleniumBase Docs -->
4749
<a id="python_installation"></a>
4850
<h2><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="30" /> Get Started:</h2>
4951

docs/prepare.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,19 @@ def main(*args, **kwargs):
102102
r'✅%20💛%20View%20Code-on%20GitHub%20🌎%20🚀'
103103
r'-02A79E.svg" alt="SeleniumBase.io Docs" />'
104104
r'</a></div></p>')
105+
if "<!-- SeleniumBase Header -->" in line:
106+
changed = True
107+
line = (
108+
'<section align="center"><div align="center">'
109+
'<h2>Reliable Test Automation</h2>'
110+
'</div></section>')
111+
if "<!-- SeleniumBase Docs -->" in line:
112+
changed = True
113+
line = (
114+
'<h2><img src="https://seleniumbase.io/img/sb_icon.png" '
115+
'title="SeleniumBase" width="20" /> SeleniumBase Docs '
116+
'<img src="https://seleniumbase.io/img/sb_icon.png" '
117+
'title="SeleniumBase" width="20" /></h2>')
105118
seleniumbase_lines.append(line)
106119
if changed:
107120
out_file = codecs.open(readme_file, "w+", encoding='utf-8')

examples/offline_examples/demo_page.html

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -417,7 +417,7 @@ <h4>iFrame%20Text<%2Fh4></body>"></iframe>
417417
href="https://seleniumbase.com">seleniumbase.com</a>
418418
</td>
419419
<td>
420-
Another Link:
420+
Link with Text:
421421
</td>
422422

423423
<td>
@@ -426,6 +426,25 @@ <h4>iFrame%20Text<%2Fh4></body>"></iframe>
426426
SeleniumBase on GitHub</a>
427427
</td>
428428
</tr>
429+
<tr>
430+
<td>
431+
SeleniumBase Docs:
432+
</td>
433+
434+
<td>
435+
<a id="myLink3" name="linkName3" class="linkClass"
436+
href="https://seleniumbase.io">seleniumbase.io</a>
437+
</td>
438+
<td>
439+
The Demo Page:
440+
</td>
441+
442+
<td>
443+
<a id="myLink4" name="linkName4" class="linkClass"
444+
href="https://seleniumbase.io/demo_page.html">
445+
SeleniumBase Demo Page</a>
446+
</td>
447+
</tr>
429448
</tbody>
430449
</table>
431450
</form>

mkdocs.yml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Project information
2-
site_name: SeleniumBase
2+
site_name: SeleniumBase | Docs
33
site_url: https://seleniumbase.io
44
site_author: Michael Mintz
55
site_description: Reliable Browser Automation & Testing
@@ -53,7 +53,7 @@ plugins:
5353
on_pre_build: docs.prepare:main
5454
# Page tree
5555
nav:
56-
- SeleniumBase: README.md
56+
- SeleniumBase | Docs: README.md
5757
- Features: help_docs/features_list.md
5858
- CMD Options: help_docs/customizing_test_runs.md
5959
- Python Setup:
@@ -63,20 +63,20 @@ nav:
6363
- Install SeleniumBase: help_docs/install.md
6464
- WebDriver Installation: help_docs/webdriver_installation.md
6565
- Verifying WebDriver: help_docs/verify_webdriver.md
66-
- How it Works: help_docs/how_it_works.md
66+
- How it Works: help_docs/how_it_works.md
6767
- Examples: examples/ReadMe.md
6868
- Translations: help_docs/translations.md
6969
- API Reference: help_docs/method_summary.md
7070
- Mobile Testing: help_docs/mobile_testing.md
7171
- Console Scripts: seleniumbase/console_scripts/ReadMe.md
7272
- Site Tours: examples/tour_examples/ReadMe.md
73-
- MasterQA: examples/master_qa/ReadMe.md
7473
- Visual Testing: examples/visual_testing/ReadMe.md
7574
- Integrations:
7675
- Logging and Reports: examples/example_logs/ReadMe.md
7776
- GitHub CI: integrations/github/workflows/ReadMe.md
7877
- Selenium Grid: seleniumbase/utilities/selenium_grid/ReadMe.md
79-
- Katalon Integration: integrations/katalon/ReadMe.md
78+
- Katalon Recorder: integrations/katalon/ReadMe.md
79+
- MasterQA: examples/master_qa/ReadMe.md
8080
- MySQL Help: help_docs/mysql_installation.md
8181
- Jenkins on Azure: integrations/azure/jenkins/ReadMe.md
8282
- Jenkins on Google Cloud: integrations/google_cloud/ReadMe.md
@@ -90,6 +90,7 @@ nav:
9090
- Using Safari Driver: help_docs/using_safari_driver.md
9191
- macOS Hidden Files: help_docs/hidden_files_info.md
9292
- Case Studies: help_docs/happy_customers.md
93+
- Demo Page for Tests: https://seleniumbase.io/demo_page
9394
- Thank You: help_docs/thank_you.md
9495
# Google Analytics
9596
google_analytics: ['UA-167313767-1', 'seleniumbase.io']

0 commit comments

Comments
 (0)