beetkeeper/mkdocs.yml at main · zach-overflow/beetkeeper · 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
site_name: beetkeeper
site_url: https://beetkeeper.dadbodaudio.com/
site_description: Self-hosted web app for managing and monitoring your beets music library.
site_author: Zach Gottesman
copyright: Copyright &copy; 2026 Zach Gottesman — AGPL-3.0-or-later

repo_name: zach-overflow/beetkeeper
repo_url: https://github.com/zach-overflow/beetkeeper
edit_uri: edit/main/docs/

docs_dir: docs

# Keep non-doc files (e.g. the Pants BUILD file) out of the published site.
# https://www.mkdocs.org/user-guide/configuration/#exclude_docs
exclude_docs: |
  BUILD
  BUILD.*
  *.py[cod]

theme:
  name: material
  # Theme partial overrides (e.g. the mike "you are viewing outdated docs" banner block).
  custom_dir: docs_overrides
  color_mode: false
  user_color_mode_toggle: false
  logo: assets/images/logo/logo-CRT-green.svg
  favicon: assets/images/logo/favicon-16.png
  icon:
    repo: fontawesome/brands/github
  # `custom` primary/accent: the actual CRT colors are defined in extra_css (docs/assets/css/…).
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: slate
      primary: custom
      accent: custom
      # toggle:
      #   icon: material/weather-night
      #   name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      # toggle:
      #   icon: material/weather-sunny
      #   name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.action.edit
    - content.tabs.link

extra_css:
  - assets/css/beetkeeper.css

# Versioned docs (one site version per app MAJOR.MINOR, deployed by mike to the gh-pages branch):
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/
extra:
  version:
    provider: mike
    default: latest
    alias: true

plugins:
  - search
  - swagger-ui-tag:
      extra_css:
        - assets/css/beetkeeper.css

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

nav:
  - Overview: index.md
  - Quickstart:
    - Getting Started: quickstart/index.md
    - Installation: quickstart/installation.md
    - Demo: quickstart/demo.md
    - Using the Web Interface: quickstart/web-interface.md
    - Using the REST API: quickstart/rest-api.md
    - Using the CLI: quickstart/cli.md
    - Deployment: quickstart/deployment.md
  - Configuration: configuration.md
  - Public API Reference: public_api_reference/index.md
  - Contributing:
      - Overview: contributor_docs/index.md
      - Testing & development: contributor_docs/testing_and_development.md
      - Building artifacts: contributor_docs/building_artifacts.md
      - Release management: contributor_docs/release_management.md