omniavatar/mkdocs.yml at main · plexusone/omniavatar · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
site_name: OmniAvatar
site_description: Provider-agnostic AI avatars for PlexusOne — real-time streaming sessions and batch video generation
site_url: https://plexusone.github.io/omniavatar
repo_url: https://github.com/plexusone/omniavatar
repo_name: plexusone/omniavatar

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    # Dark mode first (PlexusOne default)
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - content.code.copy

extra_css:
  - https://plexusone.dev/css/plexusone-mkdocs.css

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
      - Live (Real-Time): getting-started/live.md
      - Render (Batch): getting-started/render.md
  - Providers:
      - HeyGen: providers/heygen.md
      - Tavus: providers/tavus.md
      - bitHuman: providers/bithuman.md
      - LivePortrait + JoyVASA (Local): providers/liveportrait-joyvasa.md
  - Guides:
      - Architecture: guides/architecture.md
      - LiveKit Integration: guides/livekit.md
      - Render Job Lifecycle: guides/render-lifecycle.md
  - Specs:
      - Render PRD: specs/render/PRD.md
      - Render TRD: specs/render/TRD.md
      - Render Plan: specs/render/PLAN.md
      - Render Roadmap: specs/render/ROADMAP.md
  - Releases:
      - v0.3.0: releases/v0.3.0.md
      - v0.2.0: releases/v0.2.0.md
      - v0.1.0: releases/v0.1.0.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/plexusone/omniavatar