mydia/mkdocs.yml at master · getmydia/mydia · 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
site_name: Mydia Documentation
site_description: A modern, self-hosted media management platform for tracking, organizing, and monitoring your media library
site_url: https://docs.mydia.dev
repo_url: https://github.com/getmydia/mydia
repo_name: getmydia/mydia
docs_dir: docs
site_dir: _site

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    - scheme: default
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link
  icon:
    repo: fontawesome/brands/github

plugins:
  - search

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
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true

nav:
  - Home: index.md
  - Getting Started:
      - Quick Start: getting-started/quick-start.md
      - Installation: getting-started/installation.md
      - First Steps: getting-started/first-steps.md
  - User Guide:
      - Managing Libraries: user-guide/libraries.md
      - Adding Media: user-guide/adding-media.md
      - Quality Profiles: user-guide/quality-profiles.md
      - Download Clients: user-guide/download-clients.md
      - Indexers: user-guide/indexers.md
      - User Management: user-guide/users.md
  - Reference:
      - Environment Variables: reference/environment-variables.md
      - Configuration: reference/configuration.md
      - Database: reference/database.md
      - API: reference/api.md
      - Remote Access: reference/remote-access.md
  - Advanced:
      - Deployment: advanced/deployment.md
      - PostgreSQL: advanced/postgresql.md
      - SSO/OIDC: advanced/oidc.md
      - Cardigann Indexers: advanced/cardigann.md
  - Development:
      - Setup: development/setup.md
      - Testing: development/testing.md
      - E2E Testing: development/e2e-testing.md
      - Architecture: development/architecture.md

extra:
  version:
    provider: mike
    default: latest
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/getmydia/mydia