mkdocs.yml

site_name: httptap Documentation
site_url: https://docs.httptap.dev/
site_description: HTTP request visualizer with detailed timing breakdown
site_author: Sergei Ozeranskii
repo_url: https://github.com/ozeranskii/httptap
repo_name: ozeranskii/httptap
edit_uri: edit/main/docs/
copyright: Copyright © 2025-2026 Sergei Ozeranskii

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  nav:
    omitted_files: warn
    not_found: warn
    absolute_links: warn
  links:
    not_found: warn
    anchors: warn
    absolute_links: warn
    unrecognized_links: warn

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - search.share
    - content.action.edit
    - content.action.view
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
  icon:
    logo: material/flash
    repo: fontawesome/brands/github

extra:
  social:
    - icon: fontawesome/brands/telegram
      link: https://t.me/sergeiozeranskii
      name: Telegram Channel
    - icon: fontawesome/brands/github
      link: https://github.com/ozeranskii
      name: GitHub Profile
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/httptap/
      name: PyPI Package

plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
  - i18n:
      docs_structure: suffix
      reconfigure_material: true
      reconfigure_search: true
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: zh
          name: 简体中文
          build: true
          site_name: httptap 文档
          nav_translations:
            Home: 首页
            Getting Started: 快速上手
            Installation: 安装
            Quick Start: 快速开始
            Usage: 使用
            Basic Usage: 基础用法
            Output Formats: 输出格式
            SLO Threshold Checking: SLO 阈值检查
            Advanced Features: 高级功能
            Troubleshooting & FAQ: 故障排查与常见问题
            Security: 安全
            Assurance Case: 保障案例
            API Reference: API 参考
            Overview: 概览
            Core Components: 核心组件
            Interfaces: 接口
            Development: 开发
            Contributing: 贡献指南
            Release Process: 发布流程
            About: 关于
            License: 许可证
            Changelog: 更新日志
        - locale: ja
          name: 日本語
          build: true
          site_name: httptap ドキュメント
          nav_translations:
            Home: ホーム
            Getting Started: はじめに
            Installation: インストール
            Quick Start: クイックスタート
            Usage: 使い方
            Basic Usage: 基本的な使い方
            Output Formats: 出力形式
            SLO Threshold Checking: SLOしきい値チェック
            Advanced Features: 高度な機能
            Troubleshooting & FAQ: トラブルシューティングとFAQ
            Security: セキュリティ
            Assurance Case: 保証ケース
            API Reference: APIリファレンス
            Overview: 概要
            Core Components: コアコンポーネント
            Interfaces: インターフェース
            Development: 開発
            Contributing: コントリビュート
            Release Process: リリースプロセス
            About: このプロジェクトについて
            License: ライセンス
            Changelog: 変更履歴
        - locale: es
          name: Español
          build: true
          site_name: httptap Documentación
          nav_translations:
            Home: Inicio
            Getting Started: Primeros pasos
            Installation: Instalación
            Quick Start: Guía rápida
            Usage: Uso
            Basic Usage: Uso básico
            Output Formats: Formatos de salida
            SLO Threshold Checking: Comprobación de umbrales SLO
            Advanced Features: Funciones avanzadas
            Troubleshooting & FAQ: Resolución de problemas y preguntas frecuentes
            Security: Seguridad
            Assurance Case: Caso de garantía
            API Reference: Referencia de la API
            Overview: Descripción general
            Core Components: Componentes principales
            Interfaces: Interfaces
            Development: Desarrollo
            Contributing: Contribuir
            Release Process: Proceso de publicación
            About: Acerca de
            License: Licencia
            Changelog: Registro de cambios
  - social:
      cards: true
      cards_dir: assets/images/social
      cards_layout_options:
        background_color: "#1a1f4b"
        color: "#f5f7ff"
  - git-revision-date-localized:
      enable_creation_date: true
      type: date
      fallback_to_build_date: true
  - autorefs:
      resolve_closest: true
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            docstring_style: google
            docstring_section_style: list
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            members_order: source
            filters:
              - "!^_"
            summary: true
            show_if_no_docstring: false
            show_source: true
  - redirects:
      redirect_maps: {}
  - minify:
      minify_html: true
      htmlmin_opts:
        remove_comments: true

markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - 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.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quick-start.md
  - Usage:
      - Basic Usage: usage/basic.md
      - Output Formats: usage/output-formats.md
      - SLO Threshold Checking: usage/slo.md
      - Advanced Features: usage/advanced.md
      - Troubleshooting & FAQ: troubleshooting.md
  - Security:
      - Assurance Case: security/assurance-case.md
  - API Reference:
      - Overview: api/overview.md
      - Core Components: api/core.md
      - Interfaces: api/interfaces.md
  - Development:
      - Contributing: development/contributing.md
      - Release Process: development/release.md
  - About:
      - License: about/license.md
      - Changelog: about/changelog.md