subtide/mkdocs.yml at main · rennerdo30/subtide · 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
site_name: Subtide Documentation
site_description: AI-powered video subtitle translation for YouTube, Twitch, and any video site
site_url: https://rennerdo30.github.io/subtide/
repo_url: https://github.com/rennerdo30/subtide
repo_name: rennerdo30/subtide
edit_uri: edit/main/docs/

theme:
  name: material
  custom_dir: overrides
  language: en

  # Color palette with toggle (dark mode default, matching Luminous Void theme)
  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
  - minify:
      minify_html: true

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

nav:
  - Home: index.md
  - Getting Started:
      - Quick Start: getting-started/quick-start.md
      - Installation: getting-started/installation.md
      - Configuration: getting-started/configuration.md
  - User Guide:
      - YouTube: user-guide/youtube.md
      - YouTube Shorts: user-guide/youtube-shorts.md
      - Twitch: user-guide/twitch.md
      - Generic Sites: user-guide/generic-sites.md
      - Keyboard Shortcuts: user-guide/keyboard-shortcuts.md
  - Backend:
      - Overview: backend/overview.md
      - Docker Deployment: backend/docker.md
      - RunPod Deployment: backend/runpod.md
      - Local LLM Setup: backend/local-llm.md
  - API Reference:
      - Endpoints: api/endpoints.md
      - Configuration: api/configuration.md
  - FAQ: faq.md
  - Troubleshooting: troubleshooting.md
  - Security: security.md
  - Contributing: contributing.md
  - Changelog: changelog.md

extra_css:
  - assets/stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/rennerdo30/subtide
  version:
    provider: mike