mkdocs.yml

site_name: Browserist 👨‍💻
site_url: https://jakob-bagterp.github.io/browserist
site_description: Python extension for the Selenium web driver that makes browser automation even easier
site_author: Jakob Bagterp
copyright: Copyright © 2022 – present, Jakob Bagterp. All Rights Reserved.
repo_url: https://github.com/jakob-bagterp/browserist

nav:
  - Home:
    - index.md
    - Difference from Selenium: difference-from-selenium.md
    - Project:
      - Donate: project/donate.md
      - Support and Contribution: project/support-and-contribution.md
      - License 🔗: https://github.com/jakob-bagterp/browserist/blob/master/LICENSE.md
      - Release Notes 🔗: https://github.com/jakob-bagterp/browserist/releases
      - Source Code 🔗: https://github.com/jakob-bagterp/browserist
    - Index:
      - Tags: index/tags.md
  - Getting Started:
    - getting-started/index.md
    - Installation: getting-started/installation.md
    - First Script: getting-started/first-script.md
    - Recommended Drivers: getting-started/recommended-drivers.md
    - Install Browsers and Drivers:
      - Chrome: getting-started/install-browsers-and-drivers/chrome.md
      - Edge: getting-started/install-browsers-and-drivers/edge.md
      - Firefox: getting-started/install-browsers-and-drivers/firefox.md
  - User Guide:
    - user-guide/index.md
    - Context Manager: user-guide/context-manager.md
    - Download Files: user-guide/download-files.md
    - Screenshots: user-guide/screenshots.md
    - Get HTML Source: user-guide/html-source.md
    - Navigation:
      - Basics: user-guide/navigation/basics.md
      - Scrolling: user-guide/navigation/scrolling.md
      - Iframes: user-guide/navigation/iframes.md
      - Tabs: user-guide/navigation/tabs.md
      - Windows: user-guide/navigation/windows.md
      - Window Size: user-guide/navigation/window-size.md
    - Combo Methods:
      - Cookie Banner: user-guide/combo-methods/cookie-banner.md
      - Log In: user-guide/combo-methods/log-in.md
      - Search: user-guide/combo-methods/search.md
    - Tools:
      - Execute JavaScript: user-guide/tools/execute-javascript.md
      - Count Elements: user-guide/tools/count-elements.md
      - Input Validation: user-guide/tools/input-validation.md
    - Wait Methods:
      - Implicit for Elements: user-guide/wait-methods/implicit-for-elements.md
      - Explicit in Seconds: user-guide/wait-methods/explicit-in-seconds.md
      - Conditional: user-guide/wait-methods/conditional.md
  - Settings:
    - Overview: settings/overview.md
    - Browser Types: settings/browser-types.md
    - Timeout Strategy: settings/timeout-strategy.md
    - Page Load Strategy: settings/page-load-strategy.md
    - Viewport: settings/viewport.md
    - User Agent: settings/user-agent.md
    - Check Connection: settings/check-connection.md
    - Proxy: settings/proxy.md
    - Comparison to Selenium:
      - Main Differences: settings/comparison-to-selenium/main-differences.md
      - Browser Types: settings/comparison-to-selenium/browser-types.md
      - Headless Mode: settings/comparison-to-selenium/headless-mode.md
      - Disable Images: settings/comparison-to-selenium/disable-images.md
  - Performance:
    - Overview: performance/overview.md
    - Headless: performance/headless.md
    - Disable Images: performance/disable-images.md
    - Parallelization:
      - Results Summary: performance/parallelization/results-summary.md
      - 1. Linear: performance/parallelization/1-linear.md
      - 2. Ascynchronous: performance/parallelization/2-asynchronous.md
      - 3. Multi-Threading: performance/parallelization/3-multi-threading.md
      - 4. Multi-Processing: performance/parallelization/4-multi-processing.md
  - XPath:
    - Basics: xpath/basics.md
    - Absolute and Relative: xpath/absolute-and-relative.md
    - Browserist Compared to Selenium: xpath/browserist-compared-to-selenium.md
    - Tips and Tricks:
      - Target Attributes: xpath/tips-and-tricks/target-attributes.md
      - Conditional Functions: xpath/tips-and-tricks/conditional-functions.md
    - Cheatsheets:
      - Node Selection: xpath/cheatsheets/node-selection.md
      - Text: xpath/cheatsheets/text.md
      - Links: xpath/cheatsheets/links.md
      - SEO: xpath/cheatsheets/seo.md
      - Axes: xpath/cheatsheets/axes.md
  - Reference:
    - reference/index.md
    - Configuration:
      - BrowserSettings: reference/configuration/browser-settings.md
      - BrowserType: reference/configuration/browser-type.md
      - PageLoadStrategy: reference/configuration/page-load-strategy.md
      - TimeoutSettings: reference/configuration/timeout-settings.md
      - ProxySettings: reference/configuration/proxy-settings.md
    - Browser:
      - __main__: reference/browser/main.md
      - check_if: reference/browser/check-if.md
      - click: reference/browser/click.md
      - combo:
        - cookie_banner: reference/browser/combo/cookie-banner.md
        - log_in: reference/browser/combo/log-in.md
        - search: reference/browser/combo/search.md
      - get:
        - __main__: reference/browser/get/main.md
        - attribute: reference/browser/get/attribute.md
        - html: reference/browser/get/html.md
        - url: reference/browser/get/url.md
      - iframe: reference/browser/iframe.md
      - input: reference/browser/input.md
      - mouse: reference/browser/mouse.md
      - open: reference/browser/open.md
      - prompt: reference/browser/prompt.md
      - screenshot: reference/browser/screenshot.md
      - scroll:
        - __main__: reference/browser/scroll/main.md
        - check_if: reference/browser/scroll/check-if.md
        - get: reference/browser/scroll/get.md
        - page: reference/browser/scroll/page.md
      - tool: reference/browser/tool.md
      - user_agent: reference/browser/user-agent.md
      - viewport:
        - get: reference/browser/viewport/get.md
        - set: reference/browser/viewport/set.md
      - wait:
        - __main__: reference/browser/wait/main.md
        - until:
          - __main__: reference/browser/wait/until/main.md
          - download_file: reference/browser/wait/until/download-file.md
          - page_title: reference/browser/wait/until/page-title.md
          - text: reference/browser/wait/until/text.md
          - url: reference/browser/wait/until/url.md
      - window:
        - __main__: reference/browser/window/main.md
        - get: reference/browser/window/get.md
        - handle: reference/browser/window/handle.md
        - open: reference/browser/window/open.md
        - set: reference/browser/window/set.md
    - Viewport:
      - common_devices:
        - Apple: reference/viewport/common-devices/apple.md
        - Google: reference/viewport/common-devices/google.md
        - Huawei: reference/viewport/common-devices/huawei.md
        - Microsoft: reference/viewport/common-devices/microsoft.md
        - OnePlus: reference/viewport/common-devices/oneplus.md
        - Oppo: reference/viewport/common-devices/oppo.md
        - Samsung: reference/viewport/common-devices/samsung.md
        - Vivo: reference/viewport/common-devices/vivo.md
        - Xiaomi: reference/viewport/common-devices/xiaomi.md

theme:
  name: material
  custom_dir: docs/assets/overrides
  features:
    - search.suggest
    - search.highlight
    - navigation.footer
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - navigation.path
    - navigation.indexes
    - content.code.copy
    - content.code.select
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: light blue
      accent: light blue
      toggle:
        icon: material/eye
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: light blue
      accent: light blue
      toggle:
        icon: material/eye-outline
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - toc:
      permalink: "#"
  - pymdownx.highlight:
      anchor_linenums: false
      line_spans: __span
      use_pygments: true
      pygments_lang_class: true
      auto_title: true
  - pymdownx.inlinehilite
  - pymdownx.details
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - attr_list
  - footnotes
  - tables
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

extra:
  social:
    - icon: fontawesome/brands/github
      name: Browserist on GitHub
      link: https://github.com/jakob-bagterp/browserist
    - icon: fontawesome/brands/linkedin
      name: Jakob Bagterp on LinkedIn
      link: https://www.linkedin.com/in/jakobbagterp/
    - icon: fontawesome/brands/instagram
      name: Jakob Bagterp on Instagram
      link: https://www.instagram.com/bagterp_photography/
  analytics:
    provider: google
    property: G-0BNHYMBHHK
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/thumb-up-outline
          name: This page was helpful
          data: 1
          note: >-
            Thank you for your feedback!
        - icon: material/thumb-down-outline
          name: This page could be improved
          data: 0
          note: >-
            Thank you for your feedback! Help us improve this page by using our
            <a href="https://github.com/jakob-bagterp/browserist/issues/new/?title=[Feedback]+{title}+-+{url}"
            target="_blank" rel="noopener">
            feedback form</a>.
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.

extra_css:
  - assets/stylesheets/colors.css
  - assets/stylesheets/tables.css

plugins:
  - search:
      lang: en
  - tags
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_source: false
            show_bases: false
            heading_level: 2
            show_category_heading: true
            show_root_toc_entry: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            merge_init_into_class: true
  - git-revision-date-localized:
      enabled: true
      type: timeago
      enable_creation_date: true
      fallback_to_build_date: true
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      htmlmin_opts:
          remove_comments: true
      js_files:
          - js/timeago_mkdocs_material.js
      css_files:
          - css/timeago.css
          - assets/_mkdocstrings.css
          - assets/stylesheets/tables.css
  - redirects:
      redirect_maps:
        getting-started/browser-drivers.md: getting-started/recommended-drivers.md
        getting-started/browsers/chrome.md: getting-started/install-browsers-and-drivers/chrome.md
        getting-started/browsers/edge.md: getting-started/install-browsers-and-drivers/edge.md
        getting-started/browsers/firefox.md: getting-started/install-browsers-and-drivers/firefox.md
        user-guide/settings/overview.md: settings/overview.md
        user-guide/settings/browser-types.md: settings/browser-types.md
        user-guide/settings/timeout-strategy.md: settings/timeout-strategy.md
        user-guide/settings/page-load-strategy.md: settings/page-load-strategy.md
        user-guide/settings/viewport.md: settings/viewport.md
        user-guide/settings/user-agent.md: settings/user-agent.md
        donate.md: project/donate.md
        support-and-contribution.md: project/support-and-contribution.md
        tags.md: index/tags.md
        user-guide/performance/headless.md: performance/headless.md
        user-guide/performance/disable-images.md: performance/disable-images.md
        user-guide/performance/parallelisation.md: performance/parallelization/results-summary.md
        xpath/tips-and-tricks/index.md: xpath/tips-and-tricks/target-attributes.md
        reference/settings.md: reference/configuration/browser-settings.md
        reference/browser-settings.md: reference/configuration/browser-settings.md
        reference/browser/get/__main__.md: reference/browser/get/main.md
        reference/browser/scroll/__main__.md: reference/browser/scroll/main.md
        reference/browser/scroll/check_if.md: reference/browser/scroll/check-if.md
        reference/browser/wait/__main__.md: reference/browser/wait/main.md
        reference/browser/wait/until/__main__.md: reference/browser/wait/until/main.md
        reference/browser/wait/until/download_file.md: reference/browser/wait/until/download-file.md
        reference/browser/wait/until/page_title.md: reference/browser/wait/until/page-title.md
        reference/browser/window/__main__.md: reference/browser/window/main.md
        reference/browser/__main__.md: reference/browser/main.md
        reference/browser/check_if.md: reference/browser/check-if.md
        reference/browser/user_agent.md: reference/browser/user-agent.md
        reference/viewport/common_devices/apple.md: reference/viewport/common-devices/apple.md
        reference/viewport/common_devices/google.md: reference/viewport/common-devices/google.md
        reference/viewport/common_devices/huawei.md: reference/viewport/common-devices/huawei.md
        reference/viewport/common_devices/microsoft.md: reference/viewport/common-devices/microsoft.md
        reference/viewport/common_devices/oneplus.md: reference/viewport/common-devices/oneplus.md
        reference/viewport/common_devices/oppo.md: reference/viewport/common-devices/oppo.md
        reference/viewport/common_devices/samsung.md: reference/viewport/common-devices/samsung.md
        reference/viewport/common_devices/vivo.md: reference/viewport/common-devices/vivo.md
        reference/viewport/common_devices/xiaomi.md: reference/viewport/common-devices/xiaomi.md

exclude_docs: |
  /requirements.txt
  /README.md

watch:
  - src

dev_addr: 127.0.0.1:8001