mkdocs.yml

site_name: 'wp-browser docs'
site_url: 'https://wpbrowser.wptestkit.dev/'
repo_url: 'https://github.com/lucatume/wp-browser/'
edit_uri: 'blob/main/docs'
docs_dir: docs
site_dir: site
watch:
  - docs
site_description: 'Documentation for the wp-browser WordPress testing framework.'
site_author: 'Luca Tumedei'
nav:
  - Setup:
    - Getting started: 'README.md'
    - Migrating to newer versions: 'migration.md'
    - Default configuration: 'default-configuration.md'
    - Custom configuration: 'custom-configuration.md'
  - Modules:
      - WPBrowser: 'modules/WPBrowser.md'
      - WPCLI: 'modules/WPCLI.md'
      - WPDb: 'modules/WPDb.md'
      - WPFilesystem: 'modules/WPFilesystem.md'
      - WPLoader: 'modules/WPLoader.md'
      - WPQueries: 'modules/WPQueries.md'
      - WPWebDriver: 'modules/WPWebDriver.md'
      - Airplane Mode: 'modules/AirplaneMode.md'
  - Extensions:
      - PHP Built-in Server Controller: 'extensions/BuiltInServerController.md'
      - ChromeDriver Controller: 'extensions/ChromeDriverController.md'
      - Docker Compose Controller: 'extensions/DockerComposeController.md'
      - MySqlServer Controller: 'extensions/MySqlServerController.md'
      - Isolation Support: 'extensions/IsolationSupport.md'
      - Event Dispatcher Bridge: 'extensions/EventDispatcherBridge.md'
  - Commands:
      - run and codeception:run: 'commands#run-and-codeceptionrun'
      - dev:start: 'commands#devstart'
      - dev:stop: 'commands#devstop'
      - dev:restart: 'commands#devrestart'
      - wp:db:import: 'commands#wpdbimport'
      - wp:db:export: 'commands#wpdbexport'
      - chromedriver:update: 'commands#chromedriverupdate'
      - generate:wpunit: 'commands#generatewpunit'
      - generate:wpajax: 'commands#generatewpajax'
      - generate:wpcanonical: 'commands#generatewpcanonical'
      - generate:wprestapi: 'commands#generatewprestapi'
      - generate:wprestcontroller: 'commands#generatewprestcontroller'
      - generate:wprestposttypecontroller: 'commands#generatewprestposttypecontroller'
      - generate:wpxml: 'commands#generatewpxml'
      - generate:wpxmlrpc: 'commands#generatewpxmlrpc'
      - monkey:cache:path: 'commands#monkeycachepath'
      - monkey:cache:clear: 'commands#monkeycacheclear'
  - Helpers:
      - UopzFunctions trait: 'traits/UopzFunctions.md'
      - Dispatcher API: 'DispatcherAPI.md'
  - Troubleshooting: 'troubleshooting.md'
  - Changelog: 'https://github.com/lucatume/wp-browser/blob/master/CHANGELOG.md'
  - v3:
    - Welcome: v3/README.md
    - Frequently asked questions: v3/faq.md
    - Codeception, PHPUnit and wp-browser: v3/codeception-phpunit-and-wpbrowser.md
    - Using wp-browser with Codeception 4.0: v3/codeception-4-support.md
    - Migration guides:
        - Version 2 to version 3: v3/migration/from-version-2-to-version-3.md
        - Levels of testing: v3/levels-of-testing.md
    - Getting started:
        - Requirements: v3/requirements.md
        - Installation: v3/installation.md
        - Setting up a minimum WordPress installation: v3/setting-up-minimum-wordpress-installation.md
        - Configuration: v3/configuration.md
    - Tutorials:
        - Automatically change database during acceptance and functional tests: v3/tutorials/automatically-change-db-in-tests.md
        - Setting up wp-browser on VVV to test a plugin: v3/tutorials/vvv-setup.md
        - Setting up wp-browser on MAMP for Mac to test a plugin: v3/tutorials/mamp-mac-setup.md
        - Setting up wp-browser on WAMP for Windows to test a plugin: v3/tutorials/wamp-setup.md
        - Setting up wp-browser on Local by Flywheel to test a plugin: v3/tutorials/local-flywheel-setup.md
    - Modules:
        - WPBrowser: v3/modules/WPBrowser.md
        - WPCLI: v3/modules/WPCLI.md
        - WPDb: v3/modules/WPDb.md
        - WPFilesystem: v3/modules/WPFilesystem.md
        - WPLoader: v3/modules/WPLoader.md
        - WPQueries: v3/modules/WPQueries.md
        - WPWebDriver: v3/modules/WPWebDriver.md
    - Advanced Usage:
        - Running tests in separate processes: v3/advanced/run-in-separate-process.md
        - Events API: v3/events-api.md
        - Extensions: v3/extensions.md
        - Commands: v3/commands.md

theme:
  name: material
  features:
    - content.code.copy
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.tracking
    - navigation.top
    - navigation.sections
    - navigation.tabs
    - toc.follow
    - content.code.select
    - content.tabs.link
  logo: assets/logo.png
  favicon: assets/favicon.png
  palette:
    primary: teal
use_directory_urls: true
plugins:
  - optimize
  - search
  - privacy:
      links_attr_map:
        target: _blank
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.tabbed:
      alternate_style: true
extra:
  social:
    - icon: fontawesome/solid/paper-plane
      link: mailto:luca@theaveragedev.com
    - icon: fontawesome/brands/github
      link: https://github.com/lucatume