SeleniumBase/mkdocs.yml

# Project information
site_name: SeleniumBase Docs
site_url: https://seleniumbase.io
site_author: Michael Mintz
site_description: A complete framework for end-to-end testing with Python, pytest, behave-BDD, and WebDriver.
# Repository information
repo_name: seleniumbase/SeleniumBase
repo_url: https://github.com/seleniumbase/SeleniumBase
edit_uri: ""
site_dir: "site"
docs_dir: "mkdocs_build"
# Copyright
copyright: Copyright &copy; 2014 - 2022 Michael Mintz
# Extensions
markdown_extensions:
  - admonition
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.highlight:
      linenums: false
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.details
  - pymdownx.snippets
# Configuration
theme:
  name: material
  logo: img/green_logo.png
  favicon: img/green_logo3.png
  language: en
  include_homepage_in_sidebar: true
  sticky_navigation: true
  collapse_navigation: true
  # titles_only: false
  include_search_page: false
  search_index_only: true
  static_templates:
    - 404.html
  features:
    # - search.highlight
    - toc.integrate
    - navigation.indexes
    # - navigation.sections
    - navigation.expand
    # - navigation.tabs
    - navigation.top
    - navigation.tracking
    - navigation.instant
  palette:
    scheme: default
    primary: teal
    accent: indigo
  font:
    text: Roboto
    code: Roboto Mono
  icon:
    logo: img/sb_logo_10.png
# Plugins
plugins:
  - search:
      separator: '[\s]+'
      lang: en
  - exclude-search:
      exclude:
        - CODE_OF_CONDUCT.md
        - CONTRIBUTING.md
        - SECURITY.md
        - help_docs/chinese.md
        - integrations/katalon/ReadMe.md
        - seleniumbase/utilities/selenium_ide/ReadMe.md
        - seleniumbase/examples/chart_maker/ReadMe.md
  - minify:
      minify_html: true
  - mkdocs-simple-hooks:
      hooks:
        on_pre_build: mkdocs_build.prepare:main
# Page tree
nav:
  - SeleniumBase ReadMe: README.md
  - Features List: help_docs/features_list.md
  - Running Example Tests: examples/ReadMe.md
  - Command Line Options: help_docs/customizing_test_runs.md
  - Dashboard / Reports: examples/example_logs/ReadMe.md
  - GUI / Commander: help_docs/commander.md
  - Console Scripts: seleniumbase/console_scripts/ReadMe.md
  - Syntax Formats: help_docs/syntax_formats.md
  - Recorder Mode: help_docs/recorder_mode.md
  - API Reference: help_docs/method_summary.md
  - Case Plans: help_docs/case_plans.md
  - Setup / Install:
    - Install Python, pip, git: help_docs/install_python_pip_git.md
    - Virtualenv Instructions: help_docs/virtualenv_instructions.md
    - Install SeleniumBase: help_docs/install.md
    - WebDriver Installation: help_docs/webdriver_installation.md
    - Verifying WebDriver: help_docs/verify_webdriver.md
    - How it Works: help_docs/how_it_works.md
  - Behave-BDD Integration:
    - Behave-BDD ReadMe: examples/behave_bdd/ReadMe.md
    - Behave-BDD GUI App: help_docs/behave_gui.md
  - Languages:
    - Translations: help_docs/translations.md
    - Chinese Docs: help_docs/chinese.md
    - Locale Codes: help_docs/locale_codes.md
  - JS Generators:
    - Tour Maker: examples/tour_examples/ReadMe.md
    - Dialog Boxes: examples/dialog_boxes/ReadMe.md
    - Chart Maker: help_docs/chart_maker.md
    - Presentation Maker: examples/presenter/ReadMe.md
  - Integrations:
    - Mobile Testing: help_docs/mobile_testing.md
    - GitHub CI: integrations/github/workflows/ReadMe.md
    - Visual Testing: examples/visual_testing/ReadMe.md
    - Selenium Grid: seleniumbase/utilities/selenium_grid/ReadMe.md
    - HighCharts: examples/chart_maker/ReadMe.md
    - MasterQA: examples/master_qa/ReadMe.md
    - Azure Pipelines: integrations/azure/azure_pipelines/ReadMe.md
    - Jenkins on Azure: integrations/azure/jenkins/ReadMe.md
    - Jenkins on Google Cloud: integrations/google_cloud/ReadMe.md
    - NodeJS Test Runner: https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/node_js
    - Katalon Recorder Export: integrations/katalon/ReadMe.md
    - Selenium IDE Export: seleniumbase/utilities/selenium_ide/ReadMe.md
  - Help Docs:
    - Table of Contents: help_docs/ReadMe.md
    - JS Package Manager: help_docs/js_package_manager.md
    - Master QA Hybrid Mode: seleniumbase/masterqa/ReadMe.md
    - Decorators / Security: seleniumbase/common/ReadMe.md
    - Desired Capabilities: help_docs/desired_capabilities.md
    - Docker Start Guide: integrations/docker/ReadMe.md
    - Using Safari Driver: help_docs/using_safari_driver.md
    - Shadow DOM Support: help_docs/shadow_dom.md
    - The HTML Inspector: help_docs/html_inspector.md
    - macOS Hidden Files: help_docs/hidden_files_info.md
    - MySQL Instructions: help_docs/mysql_installation.md
    - Useful grep commands: help_docs/useful_grep_commands.md
  - Demo Pages:
    - Demo Page (Test Page): https://seleniumbase.io/demo_page
    - MFA Login (Test App): https://seleniumbase.io/realworld/login
    - TinyMCE (Test Page): https://seleniumbase.io/tinymce/
    - Calculator (Test App): https://seleniumbase.io/apps/calculator
    - Error Page (Test Page): https://seleniumbase.io/error_page/
    - Drag-&-Drop (Test Page): https://seleniumbase.io/other/drag_and_drop
    - Device Farm (Virtual): https://seleniumbase.io/devices/
    - SeleniumBase in iframe: https://seleniumbase.io/w3schools/sbase
    - Page with broken links: https://seleniumbase.io/other/broken_page
    - W3Schools Playground: https://seleniumbase.io/w3schools/
    - W3Schools iframes: https://seleniumbase.io/w3schools/iframes
    - W3Schools file upload: https://seleniumbase.io/w3schools/file_upload
    - W3Schools doubleclick: https://seleniumbase.io/w3schools/double_click
    - W3Schools drag & drop: https://seleniumbase.io/w3schools/drag_drop
    - W3Schools checkboxes: https://seleniumbase.io/w3schools/checkboxes
    - W3Schools radio buttons: https://seleniumbase.io/w3schools/radio_buttons
    - Canvas Test Page One: https://seleniumbase.io/canvas/
    - Canvas Test Page Two: https://seleniumbase.io/other/canvas
    - Shadow DOM/Root Page: https://seleniumbase.io/other/shadow_dom
  - Presentations:
    - Presenter Demo: https://seleniumbase.io/other/presenter.html
    - Core Presentation: https://seleniumbase.io/other/core_presentation.html
    - Chart Maker Demo: https://seleniumbase.io/other/chart_presentation.html
    - Python Virtual Envs: https://seleniumbase.io/other/py_virtual_envs.html
  - Other:
    - YouTube Link: https://www.youtube.com/playlist?list=PLp9uKicxkBc5UIlGi2BuE3aWC7JyXpD3m
    - Case Studies: help_docs/happy_customers.md
    - Thank You: help_docs/thank_you.md
# Google Analytics
extra:
  analytics:
    provider: google
    # property: G-P5KFWRNLRN
    property: UA-167313767-1
# google_analytics: ['UA-167313767-1', 'seleniumbase.io']
Update the docs 2020-05-16 01:15:37 +08:00			`# Project information`
Update mkdocs 2021-02-24 01:05:15 +08:00			`site_name: SeleniumBase Docs`
Update the docs 2020-05-16 04:31:04 +08:00			`site_url: https://seleniumbase.io`
Update the docs 2020-05-16 01:15:37 +08:00			`site_author: Michael Mintz`
Update documentation 2022-05-18 03:09:43 +08:00			`site_description: A complete framework for end-to-end testing with Python, pytest, behave-BDD, and WebDriver.`
Update the docs 2020-05-16 01:15:37 +08:00			`# Repository information`
			`repo_name: seleniumbase/SeleniumBase`
Update the docs 2020-05-16 04:31:04 +08:00			`repo_url: https://github.com/seleniumbase/SeleniumBase`
Add initial setup for mkdocs 2020-05-12 01:33:54 +08:00			`edit_uri: ""`
			`site_dir: "site"`
Refactor the docs 2021-10-22 02:35:34 +08:00			`docs_dir: "mkdocs_build"`
Update the docs 2020-05-16 01:15:37 +08:00			`# Copyright`
Update the docs 2022-03-02 15:35:47 +08:00			`copyright: Copyright © 2014 - 2022 Michael Mintz`
Update the docs 2020-05-16 01:15:37 +08:00			`# Extensions`
Add initial setup for mkdocs 2020-05-12 01:33:54 +08:00			`markdown_extensions:`
Update mkdocs 2021-02-04 08:30:05 +08:00			`- admonition`
			`- md_in_html`
			`- toc:`
Add initial setup for mkdocs 2020-05-12 01:33:54 +08:00			`permalink: true`
Update mkdocs 2021-02-04 08:30:05 +08:00			`- pymdownx.highlight:`
			`linenums: false`
			`- pymdownx.highlight`
			`- pymdownx.superfences`
			`- pymdownx.inlinehilite`
			`- pymdownx.details`
			`- pymdownx.snippets`
Update the docs 2020-05-16 01:15:37 +08:00			`# Configuration`
Add initial setup for mkdocs 2020-05-12 01:33:54 +08:00			`theme:`
			`name: material`
Update the docs 2021-10-31 13:57:45 +08:00			`logo: img/green_logo.png`
Update images 2021-10-22 02:21:08 +08:00			`favicon: img/green_logo3.png`
Update mkdocs 2021-02-04 08:30:05 +08:00			`language: en`
Update the docs 2020-05-16 12:13:17 +08:00			`include_homepage_in_sidebar: true`
			`sticky_navigation: true`
Update the docs 2021-10-03 12:21:01 +08:00			`collapse_navigation: true`
Update mkdocs 2021-02-04 08:30:05 +08:00			`# titles_only: false`
Update the docs 2020-05-20 02:40:44 +08:00			`include_search_page: false`
Update the docs 2021-02-27 07:53:19 +08:00			`search_index_only: true`
Update the docs 2021-01-23 04:33:35 +08:00			`static_templates:`
			`- 404.html`
Update the docs 2020-05-16 01:15:37 +08:00			`features:`
Update the docs 2021-09-27 03:07:03 +08:00			`# - search.highlight`
Update mkdocs 2021-02-24 01:05:15 +08:00			`- toc.integrate`
Update mkdocs 2021-02-04 08:30:05 +08:00			`- navigation.indexes`
			`# - navigation.sections`
Update the docs 2021-10-03 12:21:01 +08:00			`- navigation.expand`
Update the docs 2021-01-23 04:33:35 +08:00			`# - navigation.tabs`
Update the docs 2021-12-03 13:09:22 +08:00			`- navigation.top`
Update the docs 2021-10-03 12:21:01 +08:00			`- navigation.tracking`
			`- navigation.instant`
Update the docs 2020-05-18 06:25:35 +08:00			`palette:`
Update the docs 2020-05-20 02:40:44 +08:00			`scheme: default`
Update the docs 2021-10-31 13:57:45 +08:00			`primary: teal`
Update the docs 2020-05-18 06:25:35 +08:00			`accent: indigo`
Update the docs 2020-05-20 02:40:44 +08:00			`font:`
			`text: Roboto`
			`code: Roboto Mono`
			`icon:`
Update docs generation 2021-04-11 01:22:55 +08:00			`logo: img/sb_logo_10.png`
Update the docs 2020-05-16 01:15:37 +08:00			`# Plugins`
Add initial setup for mkdocs 2020-05-12 01:33:54 +08:00			`plugins:`
Update mkdocs 2021-02-04 08:30:05 +08:00			`- search:`
Update the docs 2021-02-27 07:53:19 +08:00			`separator: '[\s]+'`
Update mkdocs 2021-02-04 08:30:05 +08:00			`lang: en`
Update the docs 2021-02-27 07:53:19 +08:00			`- exclude-search:`
			`exclude:`
Exclude new policies from Docs site 2022-04-02 01:12:27 +08:00			`- CODE_OF_CONDUCT.md`
			`- CONTRIBUTING.md`
			`- SECURITY.md`
Exclude non-English search results from seleniumbase.io 2021-04-22 10:50:51 +08:00			`- help_docs/chinese.md`
Update the docs 2021-09-20 17:08:20 +08:00			`- integrations/katalon/ReadMe.md`
			`- seleniumbase/utilities/selenium_ide/ReadMe.md`
Update mkdocs 2022-08-19 04:28:13 +08:00			`- seleniumbase/examples/chart_maker/ReadMe.md`
Update the docs 2020-05-16 01:15:37 +08:00			`- minify:`
Update the docs 2021-01-23 04:33:35 +08:00			`minify_html: true`
Add initial setup for mkdocs 2020-05-12 01:33:54 +08:00			`- mkdocs-simple-hooks:`
			`hooks:`
Refactor the docs 2021-10-22 02:35:34 +08:00			`on_pre_build: mkdocs_build.prepare:main`
Update the docs 2020-05-16 01:15:37 +08:00			`# Page tree`
Add initial setup for mkdocs 2020-05-12 01:33:54 +08:00			`nav:`
Update mkdocs 2022-05-24 03:14:34 +08:00			`- SeleniumBase ReadMe: README.md`
Update mkdocs 2020-09-22 02:49:13 +08:00			`- Features List: help_docs/features_list.md`
			`- Running Example Tests: examples/ReadMe.md`
			`- Command Line Options: help_docs/customizing_test_runs.md`
Update the docs 2020-12-25 01:39:07 +08:00			`- Dashboard / Reports: examples/example_logs/ReadMe.md`
Update documentation 2022-05-18 03:09:43 +08:00			`- GUI / Commander: help_docs/commander.md`
Update mkdocs 2020-09-22 02:49:13 +08:00			`- Console Scripts: seleniumbase/console_scripts/ReadMe.md`
Update the docs 2020-12-27 10:03:17 +08:00			`- Syntax Formats: help_docs/syntax_formats.md`
Update the docs 2021-09-20 15:22:58 +08:00			`- Recorder Mode: help_docs/recorder_mode.md`
Update mkdocs 2020-09-22 02:49:13 +08:00			`- API Reference: help_docs/method_summary.md`
Update mkdocs 2022-08-19 04:28:13 +08:00			`- Case Plans: help_docs/case_plans.md`
Update mkdocs 2020-09-22 02:49:13 +08:00			`- Setup / Install:`
Update the docs 2020-05-16 01:15:37 +08:00			`- Install Python, pip, git: help_docs/install_python_pip_git.md`
			`- Virtualenv Instructions: help_docs/virtualenv_instructions.md`
			`- Install SeleniumBase: help_docs/install.md`
			`- WebDriver Installation: help_docs/webdriver_installation.md`
			`- Verifying WebDriver: help_docs/verify_webdriver.md`
Update the docs 2020-05-23 13:11:53 +08:00			`- How it Works: help_docs/how_it_works.md`
Update documentation 2022-05-18 03:09:43 +08:00			`- Behave-BDD Integration:`
			`- Behave-BDD ReadMe: examples/behave_bdd/ReadMe.md`
			`- Behave-BDD GUI App: help_docs/behave_gui.md`
Update mkdocs 2020-09-22 02:49:13 +08:00			`- Languages:`
Update the docs 2020-06-08 01:41:56 +08:00			`- Translations: help_docs/translations.md`
Update mkdocs 2021-02-01 04:26:23 +08:00			`- Chinese Docs: help_docs/chinese.md`
Update mkdocs 2020-09-13 23:58:32 +08:00			`- Locale Codes: help_docs/locale_codes.md`
Update mkdocs 2020-09-22 02:49:13 +08:00			`- JS Generators:`
Update mkdocs for seleniumbase.io 2020-09-18 02:16:50 +08:00			`- Tour Maker: examples/tour_examples/ReadMe.md`
Update the docs 2021-08-24 12:21:20 +08:00			`- Dialog Boxes: examples/dialog_boxes/ReadMe.md`
Update mkdocs for seleniumbase.io 2020-09-18 02:16:50 +08:00			`- Chart Maker: help_docs/chart_maker.md`
Update the docs 2021-08-24 12:21:20 +08:00			`- Presentation Maker: examples/presenter/ReadMe.md`
Update the docs 2020-05-16 01:15:37 +08:00			`- Integrations:`
Update mkdocs 2020-09-22 02:49:13 +08:00			`- Mobile Testing: help_docs/mobile_testing.md`
Update the docs 2020-05-16 01:15:37 +08:00			`- GitHub CI: integrations/github/workflows/ReadMe.md`
Update the docs 2021-09-20 15:22:58 +08:00			`- Visual Testing: examples/visual_testing/ReadMe.md`
Update the docs 2020-05-16 01:15:37 +08:00			`- Selenium Grid: seleniumbase/utilities/selenium_grid/ReadMe.md`
Update the docs 2021-09-20 15:22:58 +08:00			`- HighCharts: examples/chart_maker/ReadMe.md`
Update the docs 2020-05-23 13:11:53 +08:00			`- MasterQA: examples/master_qa/ReadMe.md`
Update the documentation 2022-06-09 07:48:55 +08:00			`- Azure Pipelines: integrations/azure/azure_pipelines/ReadMe.md`
Update the docs 2020-05-16 01:15:37 +08:00			`- Jenkins on Azure: integrations/azure/jenkins/ReadMe.md`
			`- Jenkins on Google Cloud: integrations/google_cloud/ReadMe.md`
Update the docs 2020-08-08 13:21:46 +08:00			`- NodeJS Test Runner: https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/node_js`
Update the docs 2021-10-03 12:21:01 +08:00			`- Katalon Recorder Export: integrations/katalon/ReadMe.md`
			`- Selenium IDE Export: seleniumbase/utilities/selenium_ide/ReadMe.md`
Update mkdocs 2020-09-22 02:49:13 +08:00			`- Help Docs:`
Update the docs 2020-05-16 01:15:37 +08:00			`- Table of Contents: help_docs/ReadMe.md`
Update mkdocs for seleniumbase.io 2020-09-18 02:16:50 +08:00			`- JS Package Manager: help_docs/js_package_manager.md`
Update mkdocs 2021-02-01 04:26:23 +08:00			`- Master QA Hybrid Mode: seleniumbase/masterqa/ReadMe.md`
Update mkdocs 2021-02-04 08:30:05 +08:00			`- Decorators / Security: seleniumbase/common/ReadMe.md`
Update the docs 2020-05-18 09:50:11 +08:00			`- Desired Capabilities: help_docs/desired_capabilities.md`
Update mkdocs 2021-02-01 04:26:23 +08:00			`- Docker Start Guide: integrations/docker/ReadMe.md`
Update the docs 2020-05-16 01:15:37 +08:00			`- Using Safari Driver: help_docs/using_safari_driver.md`
Update the docs 2021-03-24 03:14:13 +08:00			`- Shadow DOM Support: help_docs/shadow_dom.md`
Add a help doc for the HTML Inspector 2021-03-27 05:51:51 +08:00			`- The HTML Inspector: help_docs/html_inspector.md`
Update the docs 2020-05-16 01:15:37 +08:00			`- macOS Hidden Files: help_docs/hidden_files_info.md`
Update mkdocs 2021-02-01 04:26:23 +08:00			`- MySQL Instructions: help_docs/mysql_installation.md`
Update mkdocs.yml 2022-02-04 11:18:10 +08:00			`- Useful grep commands: help_docs/useful_grep_commands.md`
Update mkdocs 2020-09-22 02:49:13 +08:00			`- Demo Pages:`
Update the docs 2021-11-04 11:28:13 +08:00			`- Demo Page (Test Page): https://seleniumbase.io/demo_page`
Update the docs 2022-07-06 07:30:07 +08:00			`- MFA Login (Test App): https://seleniumbase.io/realworld/login`
Update the docs 2021-11-04 11:28:13 +08:00			`- TinyMCE (Test Page): https://seleniumbase.io/tinymce/`
Update the docs 2022-07-06 07:30:07 +08:00			`- Calculator (Test App): https://seleniumbase.io/apps/calculator`
Update the docs 2021-11-04 11:28:13 +08:00			`- Error Page (Test Page): https://seleniumbase.io/error_page/`
			`- Drag-&-Drop (Test Page): https://seleniumbase.io/other/drag_and_drop`
Update the docs 2021-11-26 01:43:35 +08:00			`- Device Farm (Virtual): https://seleniumbase.io/devices/`
Update the docs 2021-10-31 13:57:45 +08:00			`- SeleniumBase in iframe: https://seleniumbase.io/w3schools/sbase`
Update the docs 2021-10-08 12:57:57 +08:00			`- Page with broken links: https://seleniumbase.io/other/broken_page`
Update the docs 2022-03-03 03:26:03 +08:00			`- W3Schools Playground: https://seleniumbase.io/w3schools/`
Update the docs 2021-10-08 12:57:57 +08:00			`- W3Schools iframes: https://seleniumbase.io/w3schools/iframes`
Update the docs 2021-11-26 01:43:35 +08:00			`- W3Schools file upload: https://seleniumbase.io/w3schools/file_upload`
Update the docs 2021-10-08 12:57:57 +08:00			`- W3Schools doubleclick: https://seleniumbase.io/w3schools/double_click`
			`- W3Schools drag & drop: https://seleniumbase.io/w3schools/drag_drop`
Update the docs 2021-11-26 01:43:35 +08:00			`- W3Schools checkboxes: https://seleniumbase.io/w3schools/checkboxes`
Update the docs 2021-10-08 12:57:57 +08:00			`- W3Schools radio buttons: https://seleniumbase.io/w3schools/radio_buttons`
Update the docs 2022-03-03 03:26:03 +08:00			`- Canvas Test Page One: https://seleniumbase.io/canvas/`
			`- Canvas Test Page Two: https://seleniumbase.io/other/canvas`
			`- Shadow DOM/Root Page: https://seleniumbase.io/other/shadow_dom`
Update the docs 2021-01-12 14:20:37 +08:00			`- Presentations:`
Update mkdocs for seleniumbase.io 2020-09-18 02:16:50 +08:00			`- Presenter Demo: https://seleniumbase.io/other/presenter.html`
			`- Core Presentation: https://seleniumbase.io/other/core_presentation.html`
			`- Chart Maker Demo: https://seleniumbase.io/other/chart_presentation.html`
Update the docs 2021-11-04 11:28:13 +08:00			`- Python Virtual Envs: https://seleniumbase.io/other/py_virtual_envs.html`
Update mkdocs 2021-02-01 04:26:23 +08:00			`- Other:`
			`- YouTube Link: https://www.youtube.com/playlist?list=PLp9uKicxkBc5UIlGi2BuE3aWC7JyXpD3m`
			`- Case Studies: help_docs/happy_customers.md`
			`- Thank You: help_docs/thank_you.md`
Update the docs 2020-05-22 11:07:22 +08:00			`# Google Analytics`
Update the docs 2021-09-20 15:22:58 +08:00			`extra:`
			`analytics:`
			`provider: google`
Update the docs 2022-06-09 12:58:50 +08:00			`# property: G-P5KFWRNLRN`
			`property: UA-167313767-1`
Update the docs 2021-09-28 03:08:03 +08:00			`# google_analytics: ['UA-167313767-1', 'seleniumbase.io']`