mkdocs.yml

site_name: OpenTalking
site_description: Open-source real-time digital-human orchestration layer with pluggable model backends, LLM, TTS, WebRTC, and character voices.
site_url: https://datascale-ai.github.io/opentalking/
repo_url: https://github.com/datascale-ai/opentalking
repo_name: datascale-ai/opentalking
edit_uri: edit/main/docs/

exclude_docs: |
  requirements.txt
  */design/architecture-review.md
  */design/realtime-digital-human-research.md
  */design/wav2lip-v2-integration.md
  */roadmap/

theme:
  name: material
  language: zh
  logo: assets/images/logo.png
  favicon: assets/images/logo.png
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - navigation.tracking
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.action.edit
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/datascale-ai/opentalking

extra_css:
  - assets/stylesheets/navigation.css

plugins:
  - search
  - i18n:
      docs_structure: folder
      languages:
        - locale: zh
          name: 中文
          default: true
          build: true
          nav_translations:
            Home: 首页
            Quick Start: 快速开始
            Platform Notes: 平台说明
            Compshare Image Quick Experience: 优云智算镜像快速体验
            Docker Deployment: Docker 部署
            Windows Deployment: Windows 部署
            Usage: 使用指南
            Usage Overview: 使用概览
            WebUI Usage: WebUI 使用
            Basic Usage: 基础使用
            Command Line Usage: 命令行使用
            Examples: 案例教程
            Video Creation: 视频创作
            Video Clone: 视频克隆
            Examples Overview: 案例概览
            AI Customer Support: AI 客服数字人
            Product Demo and Live Sales: 商品讲解与直播导购
            Course and News Presenter: 课程与新闻口播
            Emotional Companion: 情绪安抚与实时陪伴
            Private Digital Human Assistant: 私有数字人助手
            Huangshan Scenic Area Digital Human: 黄山景区数字人
            Custom Avatar: 自定义 Avatar
            Voice and TTS: 音色与 TTS
            Command Line Tools: 命令行工具
            Advanced CLI Arguments: 命令行进阶参数
            Model Support: 模型支持
            Model Support Overview: 模型支持概览
            Model and Backend Selection: 模型与后端选择
            Runtime Backends: 推理后端
            Local Adapter: Local Adapter
            Direct WebSocket: Direct WebSocket
            OmniRT: OmniRT
            Supported Models: 支持的模型
            Mock Backend: Mock Backend
            FlashTalk with OmniRT: FlashTalk 与 OmniRT
            Reference Materials: 参考资料
            Reference Materials Overview: 资料概览
            Benchmark: Benchmark
            Changelog: 更新日志
            FAQ: 常见问题
            AI Customer Support: AI 客服数字人
            Product Demo and Live Sales: 商品讲解与直播导购
            Private Deployment: 企业私有化部署
            Model Deployment: 模型部署
            Deployment Guide: 部署指南
            Deployment Basics: 部署基础
            Deployment Overview: 部署概览
            Deployment Topology: 部署拓扑
            Docs: 文档
            Concepts and API: 概念与 API
            API Interfaces: API 接口
            Quickstart: 快速上手
            Platform Notes: 平台说明
            Configuration: 配置
            Mock E2E: Mock 端到端
            Wav2Lip Integration: Wav2Lip 接入
            FlashTalk Integration: FlashTalk 接入
            Custom Avatar: 自定义 Avatar
            Models: 模型
            Support Matrix: 支持矩阵
            LLM and STT: LLM 与 STT
            Mem0 Memory Engine: Mem0 记忆引擎
            TTS: TTS
            Text-to-Speech: 语音合成
            Backend Modes: 后端模式
            Local: Local
            Recipes: 部署配方
            Wav2Lip Local: Wav2Lip Local
            Local Audio + QuickTalk: 本地语音 + QuickTalk
            V100 + FasterLivePortrait + FlashHead: V100 + FasterLivePortrait + FlashHead
            Avatar Assets: Avatar 资产
            Talking-Head Models: Talking-head 模型
            Talking-Head Model Deployment: 数字人模型部署
            Mock: Mock
            Wav2Lip: Wav2Lip
            MuseTalk: MuseTalk
            QuickTalk: QuickTalk
            FlashTalk: FlashTalk
            FlashHead: FlashHead
            FasterLivePortrait: FasterLivePortrait
            Deployment: 部署
            Avatar Format: Avatar 资产格式
            Render Pipeline: 渲染管线
            Architecture: 架构设计
            Developing: 开发流程
            Model Adapter: 模型适配器
            Contributing: 贡献指南
            Community: 社区
            Docs Publishing: 文档发布
            Overview: 概览
            Metrics: 指标定义
            Runbook: 运行方法
            Results and Baselines: 结果与基线
            Health and Models: 健康检查与模型
            Avatars: 数字人形象
            Sessions: 会话
            TTS and Voices: TTS 与音色
            Events and Streaming: 事件与流式接口
        - locale: en
          name: English
          build: true

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - footnotes
  - def_list
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.keys
  - pymdownx.caret
  - pymdownx.tilde
  - pymdownx.mark
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
  - Home:
      - Home: index.md
      - Quick Start:
          - Quick Start: quick-start/index.md
          - Platform Notes: quick-start/platform-notes.md
          - Compshare Image Quick Experience: quick-start/compshare-image.md
          - Docker Deployment: quick-start/docker-deployment.md
          - Windows Deployment: quick-start/windows-deployment.md
      - Usage:
          - Usage Overview: usage/index.md
          - Command Line Usage:
              - Command Line Tools: usage/cli.md
              - Advanced CLI Arguments: usage/cli-advanced.md
          - WebUI Usage:
              - Basic Usage: usage/webui/basic.md
              - Video Creation: usage/webui/video-creation.md
              - Video Clone: usage/webui/video-clone.md
              - Custom Avatar: usage/webui/custom-avatar.md
              - Voice and TTS: usage/webui/voice-and-tts.md
      - Examples:
          - Examples Overview: examples/index.md
          - Emotional Companion: examples/companion.md
          - AI Customer Support: examples/customer-support.md
          - Product Demo and Live Sales: examples/product-demo-live-sales.md
          - Course and News Presenter: examples/course-news-presenter.md
          - Private Digital Human Assistant: examples/private-assistant.md
          - Huangshan Scenic Area Digital Human: examples/huangshan-digital-human-guide.md
      - Model Support:
          - Model Support Overview: model-support/index.md
          - Model and Backend Selection: model-support/selection.md
          - Runtime Backends:
              - Mock Backend: model-support/runtime-backends/mock.md
              - Local Adapter: model-support/runtime-backends/local-adapter.md
              - Direct WebSocket: model-support/runtime-backends/direct-websocket.md
              - OmniRT: model-support/runtime-backends/omnirt.md
          - Supported Models:
              - Wav2Lip: model-support/models/wav2lip.md
              - QuickTalk: model-support/models/quicktalk.md
              - MuseTalk: model-support/models/musetalk.md
              - FlashTalk: model-support/models/flashtalk.md
              - FlashHead: model-support/models/flashhead.md
              - FasterLivePortrait: model-support/models/fasterliveportrait.md
      - Deployment Guide:
          - Deployment Basics:
              - Deployment Overview: model-deployment/index.md
              - Deployment Topology: model-deployment/deployment.md
              - Avatar Assets: model-deployment/avatar.md
          - Backend Modes:
              - Overview: model-deployment/backends/index.md
              - Local Adapter: model-deployment/backends/local.md
              - OmniRT: model-deployment/backends/omnirt.md
          - Talking-Head Model Deployment:
              - Talking-Head Model Deployment: model-deployment/talking-head/index.md
              - Mock Backend: model-deployment/mock.md
              - QuickTalk:
                  - Overview: model-deployment/quicktalk.md
                  - Local: model-deployment/quicktalk/local.md
                  - Apple Silicon: model-deployment/quicktalk/apple-silicon.md
                  - OmniRT: model-deployment/quicktalk/omnirt.md
              - Wav2Lip:
                  - Overview: model-deployment/wav2lip.md
                  - Local: model-deployment/wav2lip/local.md
                  - OmniRT: model-deployment/wav2lip/omnirt.md
              - MuseTalk:
                  - Overview: model-deployment/musetalk.md
                  - Local: model-deployment/musetalk/local.md
                  - OmniRT: model-deployment/musetalk/omnirt.md
              - FlashTalk: model-deployment/flashtalk.md
              - FlashHead: model-deployment/flashhead.md
              - FasterLivePortrait: model-deployment/fasterliveportrait.md
          - Recipes:
              - Local Audio + QuickTalk: model-deployment/recipes/local-quicktalk-audio.md
              - V100 + FasterLivePortrait + FlashHead: model-deployment/recipes/v100-fasterliveportrait-flashhead.md
          - LLM and STT: model-deployment/llm-stt.md
          - Mem0 Memory Engine: model-deployment/mem0-memory.md
          - TTS: model-deployment/tts.md
          - Support Matrix: model-deployment/support-matrix.md
      - Reference Materials:
          - Reference Materials Overview: reference/index.md
          - Docs Publishing: community/publishing-docs.md
          - Benchmark: reference/benchmark.md
          - Changelog: reference/changelog.md
      - FAQ:
          - FAQ: faq.md
  - Quick Start:
      - Quick Start: quick-start/index.md
      - Platform Notes: quick-start/platform-notes.md
      - Compshare Image Quick Experience: quick-start/compshare-image.md
      - Docker Deployment: quick-start/docker-deployment.md
      - Windows Deployment: quick-start/windows-deployment.md
  - Usage:
      - Usage Overview: usage/index.md
      - Command Line Usage:
          - Command Line Tools: usage/cli.md
          - Advanced CLI Arguments: usage/cli-advanced.md
      - WebUI Usage:
          - Basic Usage: usage/webui/basic.md
          - Video Creation: usage/webui/video-creation.md
          - Video Clone: usage/webui/video-clone.md
          - Custom Avatar: usage/webui/custom-avatar.md
          - Voice and TTS: usage/webui/voice-and-tts.md
  - Examples:
      - Examples Overview: examples/index.md
      - Emotional Companion: examples/companion.md
      - AI Customer Support: examples/customer-support.md
      - Product Demo and Live Sales: examples/product-demo-live-sales.md
      - Course and News Presenter: examples/course-news-presenter.md
      - Private Digital Human Assistant: examples/private-assistant.md
      - Huangshan Scenic Area Digital Human: examples/huangshan-digital-human-guide.md
  - Model Support:
      - Model Support Overview: model-support/index.md
      - Model and Backend Selection: model-support/selection.md
      - Runtime Backends:
          - Mock Backend: model-support/runtime-backends/mock.md
          - Local Adapter: model-support/runtime-backends/local-adapter.md
          - Direct WebSocket: model-support/runtime-backends/direct-websocket.md
          - OmniRT: model-support/runtime-backends/omnirt.md
      - Supported Models:
          - Wav2Lip: model-support/models/wav2lip.md
          - QuickTalk: model-support/models/quicktalk.md
          - MuseTalk: model-support/models/musetalk.md
          - FlashTalk: model-support/models/flashtalk.md
          - FlashHead: model-support/models/flashhead.md
          - FasterLivePortrait: model-support/models/fasterliveportrait.md
  - Deployment Guide:
      - Deployment Basics:
          - Deployment Overview: model-deployment/index.md
          - Deployment Topology: model-deployment/deployment.md
          - Avatar Assets: model-deployment/avatar.md
      - Backend Modes:
          - Overview: model-deployment/backends/index.md
          - Local Adapter: model-deployment/backends/local.md
          - OmniRT: model-deployment/backends/omnirt.md
      - Talking-Head Model Deployment:
          - Talking-Head Model Deployment: model-deployment/talking-head/index.md
          - Mock Backend: model-deployment/mock.md
          - QuickTalk:
              - Overview: model-deployment/quicktalk.md
              - Local: model-deployment/quicktalk/local.md
              - Apple Silicon: model-deployment/quicktalk/apple-silicon.md
              - OmniRT: model-deployment/quicktalk/omnirt.md
          - Wav2Lip:
              - Overview: model-deployment/wav2lip.md
              - Local: model-deployment/wav2lip/local.md
              - OmniRT: model-deployment/wav2lip/omnirt.md
          - MuseTalk:
              - Overview: model-deployment/musetalk.md
              - Local: model-deployment/musetalk/local.md
              - OmniRT: model-deployment/musetalk/omnirt.md
          - FlashTalk: model-deployment/flashtalk.md
          - FlashHead: model-deployment/flashhead.md
          - FasterLivePortrait: model-deployment/fasterliveportrait.md
      - Recipes:
          - Local Audio + QuickTalk: model-deployment/recipes/local-quicktalk-audio.md
          - V100 + FasterLivePortrait + FlashHead: model-deployment/recipes/v100-fasterliveportrait-flashhead.md
      - LLM and STT: model-deployment/llm-stt.md
      - Mem0 Memory Engine: model-deployment/mem0-memory.md
      - TTS: model-deployment/tts.md
      - Support Matrix: model-deployment/support-matrix.md
  - Reference Materials:
      - Reference Materials Overview: reference/index.md
      - Benchmark: reference/benchmark.md
      - Changelog: reference/changelog.md
  - FAQ:
      - FAQ: faq.md