speakora/mkdocs.yml at main · rennerdo30/speakora · 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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
site_name: Speakora
site_description: Speech-to-Speech Translation Made Simple - Powered by Meta's SeamlessM4T v2
site_url: https://rennerdo30.github.io/speakora
repo_url: https://github.com/rennerdo30/speakora
repo_name: rennerdo30/speakora
edit_uri: edit/main/docs/

# Theme Configuration - Luminous Void Theme
theme:
  name: material
  custom_dir: overrides
  language: en

  # Color palette with toggle (dark mode default, matching renner.dev)
  palette:
    - 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

  # Font configuration
  font:
    text: Inter
    code: Fira Code

  # Features
  features:
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - navigation.footer
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - content.tooltips
    - header.autohide

  # Icons
  icon:
    logo: material/rocket-launch
    repo: fontawesome/brands/github

  # Favicon
  favicon: assets/images/favicon.png

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true

markdown_extensions:
  - 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
  - admonition
  - pymdownx.details
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
      - Configuration: getting-started/configuration.md
  - User Guide:
      - CLI Usage: user-guide/cli.md
      - Web Dashboard: user-guide/dashboard.md
      - YouTube Integration: user-guide/youtube.md
      - Video Processing: user-guide/video.md
      - Batch Processing: user-guide/batch.md
  - API Reference:
      - REST API: api/rest.md
      - WebSocket API: api/websocket.md
  - Deployment:
      - Docker: deployment/docker.md
      - RunPod: deployment/runpod.md
  - Development:
      - Architecture: development/architecture.md
      - Contributing: development/contributing.md
  - FAQ: faq.md

# Extra CSS and JavaScript
extra_css:
  - assets/stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/rennerdo30/speakora