mkdocs.yml

site_name: "Stove"
site_description: "End-to-end testing framework for the JVM"
repo_url: https://github.com/trendyol/stove
repo_name: trendyol/stove
edit_uri: edit/main/docs/
extra_css:
  - css/custom.css
extra_javascript:
  - assets/rough-notation.iife.js
  - js/rough-notation-mkdocs.js
  - https://cdn.jsdelivr.net/npm/alpinejs@3.13.10/dist/cdn.min.js
  - js/wizard.js
  # Prism.js for client-side Kotlin syntax highlight in the wizard + cookbook
  # (Material's server-side pygments doesn't reach Alpine-rendered dynamic content).
  # `prism-init.js` MUST load before prism-core to set window.Prism.manual = true
  # — otherwise Prism auto-runs and re-tokenizes static MD blocks, mangling whitespace.
  - js/prism-init.js
  - https://cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-core.min.js
  - https://cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-clike.min.js
  - https://cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-java.min.js
  - https://cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-kotlin.min.js
  - https://cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-properties.min.js
  # KotlinPlayground script tag is injected dynamically by the init below
  # so we can set the required `data-selector` attribute (mkdocs extra_javascript
  # can't add custom attrs).
  - js/kotlin-playground-init.js
  - js/stove-flow.js
plugins:
  - search
  - awesome-pages:
     collapse_single_pages: true
  - macros:
      module_name: hooks/macros
      include_dir: docs/_data
      on_undefined: keep

hooks:
  - hooks/wizard_snippets.py
nav:
  - Home: index.md
  - Start:
    - Setup Wizard: wizard.md
    - Cookbook: cookbook.md
    - Playground: playground.md
    - Getting Started: getting-started.md
  - JVM Frameworks:
    - Overview: frameworks/index.md
    - Spring Boot: frameworks/spring-boot.md
    - Ktor: frameworks/ktor.md
    - Micronaut: frameworks/micronaut.md
    - Quarkus: frameworks/quarkus.md
  - Polyglot:
    - Overview: other-languages/index.md
    - Go:
      - Overview: other-languages/go.md
      - Process Mode: other-languages/go-process.md
      - Container Mode: other-languages/go-container.md
    - Container AUT (any language): Components/22-container.md
    - Provided Application (deployed): Components/19-provided-application.md
  - Systems:
    - Overview: Components/index.md
    - Databases:
      - PostgreSQL: Components/06-postgresql.md
      - MySQL: Components/16-mysql.md
      - MSSQL: Components/08-mssql.md
      - MongoDB: Components/07-mongodb.md
      - Couchbase: Components/01-couchbase.md
      - Cassandra: Components/17-cassandra.md
      - Redis: Components/09-redis.md
      - Elasticsearch: Components/03-elasticsearch.md
    - Messaging:
      - Kafka: Components/02-kafka.md
    - Network:
      - HTTP Client: Components/05-http.md
      - gRPC: Components/12-grpc.md
    - Mocks:
      - WireMock: Components/04-wiremock.md
      - gRPC Mock: Components/14-grpc-mock.md
    - Multiple Systems: Components/20-multiple-systems.md
    - Provided Instances: Components/11-provided-instances.md
  - Observability:
    - When a Test Fails: observability/when-it-fails.md
    - Reporting: Components/13-reporting.md
    - Tracing: Components/15-tracing.md
    - Dashboard: Components/18-dashboard.md
    - MCP: Components/21-mcp.md
  - Concepts:
    - Bridge: Components/10-bridge.md
    - Chaos Testing: chaos-testing.md
    - Writing Custom Systems: writing-custom-systems.md
  - Reference:
    - Best Practices: best-practices.md
    - Troubleshooting: troubleshooting.md
  - Recipes:
    - Overview: recipes/index.md
    - Order Placement Flow: recipes/order-flow.md
  - Blog:
      - "Polyglot Stove in 0.24.0": blog/polyglot-0.24.0.md
      - "Stove Dashboard in 0.23.0": blog/dashboard-0.23.0.md
      - "Execution Tracing in 0.21.0": blog/tracing-0.21.0.md
  - Release Notes:
      - "0.27.x": release-notes/0.27.x.md
      - "0.26.0": release-notes/0.26.0.md
      - "0.25.0": release-notes/0.25.0.md
      - "0.24.0": release-notes/0.24.0.md
      - "0.23.0": release-notes/0.23.0.md
      - 0.22.2: release-notes/0.22.2.md
      - 0.21.2: release-notes/0.21.2.md
      - 0.21.0: release-notes/0.21.0.md
      - 0.20.0: release-notes/0.20.0.md
      - 0.19.0: release-notes/0.19.0.md
      - 0.15.0: release-notes/0.15.0.md
theme:
  name: material
  logo: assets/stove-mark.svg
  favicon: assets/favicon.svg
  features:
    # Navigation
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - navigation.path
    # Search
    - search.highlight
    - search.share
    - search.suggest
    # Content
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - content.tooltips
    # Header
    - header.autohide
    # Table of contents
    - toc.follow

  palette:
    - scheme: default
      primary: teal
      accent: amber
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - scheme: slate
      primary: teal
      accent: amber
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - tables
  - attr_list
  - md_in_html
  - def_list
  - toc:
      permalink: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/trendyol/stove
    - icon: fontawesome/regular/building
      link: https://trendyol.github.io/