mkdocs.yml

site_name: CloakBrowser MCP
site_description: Playwright MCP bridge for CloakBrowser browser automation with Docker, Streamable HTTP, persistent profiles, validated context options, extension loading, GeoIP proxy matching, and humanized input.
site_url: https://swimmwatch.github.io/cloakbrowser-mcp/
site_author: swimmwatch
repo_url: https://github.com/swimmwatch/cloakbrowser-mcp
repo_name: swimmwatch/cloakbrowser-mcp
edit_uri: edit/main/docs/
copyright: Copyright © 2026 swimmwatch
docs_dir: docs
site_dir: site
hooks:
  - docs/hooks/generate_cli_docs.py
exclude_docs: |
  dockerhub-readme.md
  hooks/
  overrides/
  requirements.txt
strict: true
theme:
  name: material
  language: en
  custom_dir: docs/overrides
  logo: assets/brand/logo.svg
  favicon: assets/brand/favicon.svg
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/github
    tag:
      default: material/tag
      user: material/account
      docker: fontawesome/brands/docker
      config: material/tune
      geoip: material/map-marker-radius
      humanize: material/gesture-tap
      proxy: material/lan-connect
      tools: material/tools
      security: material/shield-lock
      project: material/source-branch
      test: material/test-tube
      api: material/api
      release: material/tag-check
      docs: material/file-document-multiple
  features:
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.path
    - navigation.footer
    - navigation.top
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.code.select
    - content.action.edit
    - content.action.view
    - content.tabs.link
    - content.tooltips
  palette:
    - media: '(prefers-color-scheme: light)'
      scheme: default
      primary: teal
      accent: deep orange
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      primary: teal
      accent: amber
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

plugins:
  - i18n:
      docs_structure: suffix
      fallback_to_default: true
      reconfigure_material: true
      reconfigure_search: true
      languages:
        - locale: en
          name: English
          build: true
          default: true
        - locale: ru
          name: Русский
          build: true
          nav_translations:
            Overview: Обзор
            User Guide: Руководство пользователя
            Getting Started: Начало работы
            Comparison: Сравнение
            Recipes: Рецепты
            Persistent Login Profile: Постоянный профиль входа
            Load Chrome Extension: Загрузка расширения Chrome
            Docker Streamable HTTP Behind Reverse Proxy: Docker Streamable HTTP за обратным прокси
            Regional QA Through Proxy: Региональное QA через прокси
            Connect To Claude Desktop: Подключение к Claude Desktop
            Connect To Codex CLI: Подключение к Codex CLI
            CI Smoke Test: Smoke-тест CI
            Docker: Docker
            Version Compatibility: Совместимость версий
            Configuration: Конфигурация
            GeoIP Proxy Matching: Сопоставление GeoIP прокси
            Humanized Input Behavior: Человекообразный ввод
            CLI Reference: Справочник CLI
            Tools: Инструменты
            Security: Безопасность
            FAQ: Вопросы и ответы
            Tags: Теги
            Project Internals: Устройство проекта
            Contributor Guide: Руководство участника
            Development: Разработка
            Testing: Тестирование
            Architecture: Архитектура
            Release: Релиз
            Contributing: Участие
        - locale: be
          name: Беларуская
          build: true
          nav_translations:
            Overview: Агляд
            User Guide: Кіраўніцтва карыстальніка
            Getting Started: Пачатак працы
            Comparison: Параўнанне
            Recipes: Рэцэпты
            Persistent Login Profile: Пастаянны профіль уваходу
            Load Chrome Extension: Загрузка пашырэння Chrome
            Docker Streamable HTTP Behind Reverse Proxy: Docker Streamable HTTP за зваротным проксі
            Regional QA Through Proxy: Рэгіянальнае QA праз проксі
            Connect To Claude Desktop: Падключэнне да Claude Desktop
            Connect To Codex CLI: Падключэнне да Codex CLI
            CI Smoke Test: Smoke-тэст CI
            Docker: Docker
            Version Compatibility: Сумяшчальнасць версій
            Configuration: Канфігурацыя
            GeoIP Proxy Matching: Супастаўленне GeoIP проксі
            Humanized Input Behavior: Чалавекападобны ўвод
            CLI Reference: Даведнік CLI
            Tools: Інструменты
            Security: Бяспека
            FAQ: Пытанні і адказы
            Tags: Тэгі
            Project Internals: Унутраная будова праекта
            Contributor Guide: Кіраўніцтва ўдзельніка
            Development: Распрацоўка
            Testing: Тэставанне
            Architecture: Архітэктура
            Release: Выпуск
            Contributing: Удзел
        - locale: uk
          name: Українська
          build: true
          nav_translations:
            Overview: Огляд
            User Guide: Посібник користувача
            Getting Started: Початок роботи
            Comparison: Порівняння
            Recipes: Рецепти
            Persistent Login Profile: Постійний профіль входу
            Load Chrome Extension: Завантаження розширення Chrome
            Docker Streamable HTTP Behind Reverse Proxy: Docker Streamable HTTP за зворотним проксі
            Regional QA Through Proxy: Регіональне QA через проксі
            Connect To Claude Desktop: Підключення до Claude Desktop
            Connect To Codex CLI: Підключення до Codex CLI
            CI Smoke Test: Smoke-тест CI
            Docker: Docker
            Version Compatibility: Сумісність версій
            Configuration: Конфігурація
            GeoIP Proxy Matching: Зіставлення GeoIP проксі
            Humanized Input Behavior: Людиноподібне введення
            CLI Reference: Довідник CLI
            Tools: Інструменти
            Security: Безпека
            FAQ: Запитання й відповіді
            Tags: Теги
            Project Internals: Внутрішня будова проєкту
            Contributor Guide: Посібник учасника
            Development: Розробка
            Testing: Тестування
            Architecture: Архітектура
            Release: Реліз
            Contributing: Участь
        - locale: es
          name: Español
          build: true
          nav_translations:
            Overview: Resumen
            User Guide: Guía de usuario
            Getting Started: Primeros pasos
            Comparison: Comparación
            Recipes: Recetas
            Persistent Login Profile: Perfil de inicio de sesión persistente
            Load Chrome Extension: Cargar extensión de Chrome
            Docker Streamable HTTP Behind Reverse Proxy: Docker Streamable HTTP detrás de proxy inverso
            Regional QA Through Proxy: QA regional mediante proxy
            Connect To Claude Desktop: Conectar con Claude Desktop
            Connect To Codex CLI: Conectar con Codex CLI
            CI Smoke Test: Prueba smoke de CI
            Docker: Docker
            Version Compatibility: Compatibilidad de versiones
            Configuration: Configuración
            GeoIP Proxy Matching: Correspondencia GeoIP del proxy
            Humanized Input Behavior: Entrada humanizada
            CLI Reference: Referencia CLI
            Tools: Herramientas
            Security: Seguridad
            FAQ: Preguntas frecuentes
            Tags: Etiquetas
            Project Internals: Internos del proyecto
            Contributor Guide: Guía para colaboradores
            Development: Desarrollo
            Testing: Pruebas
            Architecture: Arquitectura
            Release: Lanzamiento
            Contributing: Contribuir
        - locale: pt-BR
          name: Português (Brasil)
          build: true
          nav_translations:
            Overview: Visão geral
            User Guide: Guia do usuário
            Getting Started: Primeiros passos
            Comparison: Comparação
            Recipes: Receitas
            Persistent Login Profile: Perfil de login persistente
            Load Chrome Extension: Carregar extensão do Chrome
            Docker Streamable HTTP Behind Reverse Proxy: Docker Streamable HTTP atrás de proxy reverso
            Regional QA Through Proxy: QA regional via proxy
            Connect To Claude Desktop: Conectar ao Claude Desktop
            Connect To Codex CLI: Conectar ao Codex CLI
            CI Smoke Test: Teste smoke de CI
            Docker: Docker
            Version Compatibility: Compatibilidade de versões
            Configuration: Configuração
            GeoIP Proxy Matching: Correspondência GeoIP do proxy
            Humanized Input Behavior: Entrada humanizada
            CLI Reference: Referência da CLI
            Tools: Ferramentas
            Security: Segurança
            FAQ: Perguntas frequentes
            Tags: Tags
            Project Internals: Internos do projeto
            Contributor Guide: Guia para colaboradores
            Development: Desenvolvimento
            Testing: Testes
            Architecture: Arquitetura
            Release: Lançamento
            Contributing: Contribuição
        - locale: zh
          name: 简体中文
          build: true
          nav_translations:
            Overview: 概览
            User Guide: 用户指南
            Getting Started: 快速开始
            Comparison: 对比
            Recipes: 操作示例
            Persistent Login Profile: 持久登录配置文件
            Load Chrome Extension: 加载 Chrome 扩展
            Docker Streamable HTTP Behind Reverse Proxy: 反向代理后的 Docker Streamable HTTP
            Regional QA Through Proxy: 通过代理进行区域 QA
            Connect To Claude Desktop: 连接到 Claude Desktop
            Connect To Codex CLI: 连接到 Codex CLI
            CI Smoke Test: CI 冒烟测试
            Docker: Docker
            Version Compatibility: 版本兼容性
            Configuration: 配置
            GeoIP Proxy Matching: GeoIP 代理匹配
            Humanized Input Behavior: 人性化输入行为
            CLI Reference: CLI 参考
            Tools: 工具
            Security: 安全
            FAQ: 常见问题
            Tags: 标签
            Project Internals: 项目内部
            Contributor Guide: 贡献者指南
            Development: 开发
            Testing: 测试
            Architecture: 架构
            Release: 发布
            Contributing: 贡献
        - locale: ja
          name: 日本語
          build: true
          nav_translations:
            Overview: 概要
            User Guide: ユーザーガイド
            Getting Started: はじめに
            Comparison: 比較
            Recipes: レシピ
            Persistent Login Profile: 永続ログインプロファイル
            Load Chrome Extension: Chrome 拡張機能を読み込む
            Docker Streamable HTTP Behind Reverse Proxy: リバースプロキシ背後の Docker Streamable HTTP
            Regional QA Through Proxy: プロキシ経由のリージョン QA
            Connect To Claude Desktop: Claude Desktop に接続
            Connect To Codex CLI: Codex CLI に接続
            CI Smoke Test: CI スモークテスト
            Docker: Docker
            Version Compatibility: バージョン互換性
            Configuration: 設定
            GeoIP Proxy Matching: GeoIP プロキシ照合
            Humanized Input Behavior: 人間らしい入力動作
            CLI Reference: CLI リファレンス
            Tools: ツール
            Security: セキュリティ
            FAQ: よくある質問
            Tags: タグ
            Project Internals: プロジェクト内部
            Contributor Guide: コントリビューターガイド
            Development: 開発
            Testing: テスト
            Architecture: アーキテクチャ
            Release: リリース
            Contributing: コントリビュート
        - locale: de
          name: Deutsch
          build: true
          nav_translations:
            Overview: Überblick
            User Guide: Benutzerhandbuch
            Getting Started: Erste Schritte
            Comparison: Vergleich
            Recipes: Rezepte
            Persistent Login Profile: Persistentes Login-Profil
            Load Chrome Extension: Chrome-Erweiterung laden
            Docker Streamable HTTP Behind Reverse Proxy: Docker Streamable HTTP hinter Reverse Proxy
            Regional QA Through Proxy: Regionale QA über Proxy
            Connect To Claude Desktop: Mit Claude Desktop verbinden
            Connect To Codex CLI: Mit Codex CLI verbinden
            CI Smoke Test: CI-Smoke-Test
            Docker: Docker
            Version Compatibility: Versionskompatibilität
            Configuration: Konfiguration
            GeoIP Proxy Matching: GeoIP-Proxy-Abgleich
            Humanized Input Behavior: Humanisiertes Eingabeverhalten
            CLI Reference: CLI-Referenz
            Tools: Werkzeuge
            Security: Sicherheit
            FAQ: FAQ
            Tags: Tags
            Project Internals: Projektinternes
            Contributor Guide: Leitfaden für Mitwirkende
            Development: Entwicklung
            Testing: Tests
            Architecture: Architektur
            Release: Release
            Contributing: Mitwirken
        - locale: fr
          name: Français
          build: true
          nav_translations:
            Overview: Vue d'ensemble
            User Guide: Guide utilisateur
            Getting Started: Premiers pas
            Comparison: Comparaison
            Recipes: Recettes
            Persistent Login Profile: Profil de connexion persistant
            Load Chrome Extension: Charger une extension Chrome
            Docker Streamable HTTP Behind Reverse Proxy: Docker Streamable HTTP derrière un proxy inverse
            Regional QA Through Proxy: QA régionale via proxy
            Connect To Claude Desktop: Connecter à Claude Desktop
            Connect To Codex CLI: Connecter à Codex CLI
            CI Smoke Test: Test smoke CI
            Docker: Docker
            Version Compatibility: Compatibilité des versions
            Configuration: Configuration
            GeoIP Proxy Matching: Correspondance GeoIP du proxy
            Humanized Input Behavior: Saisie humanisée
            CLI Reference: Référence CLI
            Tools: Outils
            Security: Sécurité
            FAQ: FAQ
            Tags: Tags
            Project Internals: Internes du projet
            Contributor Guide: Guide de contribution
            Development: Développement
            Testing: Tests
            Architecture: Architecture
            Release: Publication
            Contributing: Contribuer
        - locale: hi
          name: हिन्दी
          build: true
          nav_translations:
            Overview: अवलोकन
            User Guide: उपयोगकर्ता मार्गदर्शिका
            Getting Started: शुरुआत करें
            Comparison: तुलना
            Recipes: रेसिपी
            Persistent Login Profile: स्थायी लॉगिन प्रोफ़ाइल
            Load Chrome Extension: Chrome एक्सटेंशन लोड करें
            Docker Streamable HTTP Behind Reverse Proxy: रिवर्स प्रॉक्सी के पीछे Docker Streamable HTTP
            Regional QA Through Proxy: प्रॉक्सी के माध्यम से क्षेत्रीय QA
            Connect To Claude Desktop: Claude Desktop से कनेक्ट करें
            Connect To Codex CLI: Codex CLI से कनेक्ट करें
            CI Smoke Test: CI स्मोक टेस्ट
            Docker: Docker
            Version Compatibility: संस्करण संगतता
            Configuration: कॉन्फ़िगरेशन
            GeoIP Proxy Matching: GeoIP प्रॉक्सी मिलान
            Humanized Input Behavior: मानवीय इनपुट व्यवहार
            CLI Reference: CLI संदर्भ
            Tools: टूल
            Security: सुरक्षा
            FAQ: सामान्य प्रश्न
            Tags: टैग
            Project Internals: परियोजना आंतरिक
            Contributor Guide: योगदानकर्ता मार्गदर्शिका
            Development: विकास
            Testing: परीक्षण
            Architecture: आर्किटेक्चर
            Release: रिलीज़
            Contributing: योगदान
  - macros:
      module_name: docs_macros
      on_error_fail: true
      on_undefined: strict
  - meta
  - search:
      lang: en
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
  - tags
  - git-revision-date-localized:
      enabled: !ENV [MKDOCS_GIT_DATES, true]
      type: date
      timezone: UTC
      locale: en
      enable_creation_date: true
      fallback_to_build_date: true
      strict: false
  - privacy:
      enabled: !ENV [MKDOCS_PRIVACY, false]
      links: true
      assets: false
  - social:
      enabled: !ENV [MKDOCS_SOCIAL_CARDS, false]
      cards_layout_options:
        logo: docs/assets/brand/logo.svg
        background_color: '#0f766e'
        color: '#ffffff'
  - advanced-seo:
      url_base: https://swimmwatch.github.io/cloakbrowser-mcp/
      use_canonical_url: false
      use_open_graph: true
      use_twitter_cards: true
      add_schema_org_json_ld: true
      og_type: website
      og_image: assets/brand/social-card.png
      og_locale: en_US
      twitter_card_type: summary_large_image
      support_document_dates: true
  - minify:
      minify_html: !ENV [MKDOCS_MINIFY_HTML, true]
      htmlmin_opts:
        remove_comments: true

nav:
  - Overview: index.md
  - User Guide:
      - Getting Started: getting-started.md
      - Comparison: comparison.md
      - Recipes:
          - Overview: recipes/index.md
          - Persistent Login Profile: recipes/persistent-login-profile.md
          - Load Chrome Extension: recipes/load-chrome-extension.md
          - Docker Streamable HTTP Behind Reverse Proxy: recipes/docker-streamable-http-reverse-proxy.md
          - Regional QA Through Proxy: recipes/regional-qa-through-proxy.md
          - Connect To Claude Desktop: recipes/connect-claude-desktop.md
          - Connect To Codex CLI: recipes/connect-codex-cli.md
          - CI Smoke Test: recipes/ci-smoke-test.md
      - Docker: docker.md
      - Version Compatibility: version-compatibility.md
      - Configuration: configuration.md
      - GeoIP Proxy Matching: geoip-proxy-matching.md
      - Humanized Input Behavior: humanized-input-behavior.md
      - CLI Reference: generated/cli.md
      - Tools: tools.md
      - Security: security.md
      - FAQ: faq.md
      - Tags: tags.md
  - Project Internals:
      - Contributor Guide: contributor-guide.md
      - Development: development.md
      - Testing: testing.md
      - Architecture: architecture.md
      - Release: release.md
      - Contributing: contributing.md

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: true
      toc_depth: 3

extra:
  homepage: https://github.com/swimmwatch/cloakbrowser-mcp
  generator: false
  status:
    new: Recently added
  seo:
    image: assets/brand/social-card.png
    verification:
      google: !ENV [GOOGLE_SITE_VERIFICATION, '']
      bing: !ENV [BING_SITE_VERIFICATION, '']
      yandex: !ENV [YANDEX_SITE_VERIFICATION, '']
      baidu: !ENV [BAIDU_SITE_VERIFICATION, '']
      naver: !ENV [NAVER_SITE_VERIFICATION, '']
  tags:
    User Guide: user
    Docker: docker
    Configuration: config
    GeoIP: geoip
    Humanize: humanize
    Proxy: proxy
    Tools: tools
    Security: security
    FAQ: docs
    Project Internals: project
    Testing: test
    API: api
    Release: release
    Documentation: docs
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/swimmwatch/cloakbrowser-mcp
      name: GitHub repository
    - icon: fontawesome/brands/npm
      link: https://www.npmjs.com/package/cloakbrowser-mcp
      name: npm package
    - icon: fontawesome/brands/docker
      link: https://github.com/swimmwatch/cloakbrowser-mcp/pkgs/container/cloakbrowser-mcp
      name: GHCR image

extra_css:
  - assets/stylesheets/extra.css