phonox/mkdocs.yml at master · Hoshi42/phonox · 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
site_name: Phonox Documentation
site_description: AI-Powered Vinyl Record Identification System
site_author: Phonox Contributors
site_url: https://phonox-docs.example.com
docs_dir: docs
theme:
  name: material
  logo: images/phonox.png
  favicon: images/phonox.png
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Light mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Dark mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate

plugins:
  - search
  - offline

nav:
  - Home: index.md
  - Getting Started:
    - Overview: getting-started/overview.md
    - Installation: getting-started/installation.md
    - Configuration: getting-started/configuration.md
    - Quick Start: getting-started/quick-start.md
    - CLI Tool: getting-started/cli.md
  - User Guide:
    - Uploading Records: user-guide/uploading.md
    - Managing Collection: user-guide/collection.md
    - Chat Features: user-guide/chat.md
    - Cost Estimation: user-guide/cost-estimation.md
  - Architecture:
    - Cost Model: architecture/cost-model.md
  - API Reference:
    - Introduction: api/introduction.md
    - Endpoints: api/endpoints.md
    - Authentication: api/authentication.md
    - Examples: api/examples.md
  - Troubleshooting & Support:
    - Database Connection: database-retry.md
  - Gallery: gallery.md
  - Contributing: contributing.md
  - Changelog: changelog.md
  - License: license.md

extra:
  version: "2.0.1"
  social:
    - icon: fontawesome/solid/blog
      link: https://phonox-blog.web.app/
      name: Phonox Blog
    - icon: fontawesome/brands/github
      link: https://github.com/your-username/phonox
      name: GitHub
    - icon: fontawesome/brands/python
      link: https://www.python.org
      name: Python
    - icon: fontawesome/brands/react
      link: https://react.dev
      name: React

markdown_extensions:
  - pymdownx.highlight:
      use_pygments: true
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:pymdownx.emoji.twemoji
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
  - admonition
  - toc:
      permalink: true
  - tables
  - attr_list
  - md_in_html

copyright: Copyright &copy; 2026 Phonox Contributors - MIT License