mkdocs.yaml

# Copyright 2025 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

site_name: A2UI
site_url: https://a2ui.org/
site_description: A2UI, a streaming protocol for Agent-Driven User Interfaces
site_author: Google
site_dir: site

extra:
  analytics:
    provider: google
    property: G-YX9TPV8DCC
  consent:
      title: Cookie consent
      description: >-
        We use cookies to recognize repeated visits and preferences,
        as well as to measure the effectiveness of our documentation and
        whether users find the information they need. With your consent,
        you're helping us to make our documentation better.

# Navigation
nav:
  - Home: index.md
  - Introduction & FAQ:
      - What is A2UI?: introduction/what-is-a2ui.md
      - Who is it For?: introduction/who-is-it-for.md
      - How Can I Use It?: introduction/how-to-use.md
      - Where is it Used?: introduction/where-is-it-used.md
      - Agent UI Ecosystem: introduction/agent-ui-ecosystem.md
  - Quickstart: quickstart.md
  - A2UI Composer ⭐: composer.md
  - Developer Guides:
      - Client Setup: guides/client-setup.md
      - Agent Development: guides/agent-development.md
      - Custom Components: guides/custom-components.md
      - Theming & Styling: guides/theming.md
  - Core Concepts:
      - Overview: concepts/overview.md
      - Data Flow: concepts/data-flow.md
      - Components & Structure: concepts/components.md
      - Data Binding: concepts/data-binding.md
  - Specifications:
      - v0.8 (Stable):
          - A2UI Specification: specification/v0.8-a2ui.md
          - A2A Extension: specification/v0.8-a2a-extension.md
      - v0.9 (Draft):
          - A2UI Specification: specification/v0.9-a2ui.md
          - Evolution Guide: specification/v0.9-evolution-guide.md
  - Renderers (Clients): renderers.md
  - Transports (Message Passing): transports.md
  - Agents (Server-side): agents.md
  - Community: community.md
  - Roadmap: roadmap.md
  - Reference:
      - Component Reference: reference/components.md
      - Message Reference: reference/messages.md

# Repository
repo_name: google/A2UI
repo_url: https://github.com/google/A2UI

# Copyright
copyright: Copyright Google 2025&nbsp;&nbsp;|&nbsp;&nbsp;<a href="//policies.google.com/terms">Terms</a>&nbsp;&nbsp;|&nbsp;&nbsp;<a href="//policies.google.com/privacy">Privacy</a>&nbsp;&nbsp;|&nbsp;&nbsp;<a href="#__consent">Manage cookies</a>

# Custom CSS
extra_css:
  - stylesheets/custom.css


# Configuration
theme:
  name: material
  font:
    text: Google Sans
    code: Roboto Mono
  logo: assets/A2UI_light.svg
  favicon: assets/A2UI_dark.svg
  icon:
    repo: fontawesome/brands/github
    # view: material/pencil-box-multiple
    admonition:
      note: fontawesome/solid/note-sticky
      abstract: fontawesome/solid/book
      info: fontawesome/solid/circle-info
      tip: fontawesome/solid/bullhorn
      success: fontawesome/solid/check
      question: fontawesome/solid/circle-question
      warning: fontawesome/solid/triangle-exclamation
      failure: fontawesome/solid/bomb
      danger: fontawesome/solid/skull
      bug: fontawesome/solid/robot
      example: fontawesome/solid/flask
      quote: fontawesome/solid/quote-left
  palette:
    - scheme: default
      primary: teal
      accent: light blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    - scheme: slate
      primary: teal
      accent: light blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  features:
    - announce.dismiss
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.tabs.link
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.progress
    - navigation.path
    - navigation.top
    - navigation.tracking
    - toc.follow

# Extensions
markdown_extensions:
  - meta
  - footnotes
  - admonition
  - attr_list
  - md_in_html
  - 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.snippets:
      url_download: true
      dedent_subsections: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: true

# Plugins
plugins:
  - search
  - macros
  # - include-markdown
  # - mermaid2
  # - llmstxt:
  #     full_output: llms-full.txt
  #     sections:
  #       "Specification":
  #         - a2ui_protocol.md
  # - redirects:
  #     redirect_maps:
  #       "index.md": "a2ui_protocol.md"