TagStudio/mkdocs.yml at main · TagStudioDev/TagStudio · 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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json

# MkDocs: https://www.mkdocs.org/
# Material for MkDocs: https://squidfunk.github.io/mkdocs-material/

# To install:
# pip install mkdocs-material

# To run the preview server:
# mkdocs serve

---
site_name: TagStudio
site_description: "A User-Focused Photo & File Management System"
site_url: https://docs.tagstud.io/
repo_url: https://github.com/TagStudioDev/TagStudio
edit_uri: blob/main/docs/
repo_name: TagStudioDev/TagStudio

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/TagStudioDev
    - icon: fontawesome/brands/discord
      link: https://discord.gg/hRNnVKhF2G
  tags:
    Upcoming Feature: upcoming

nav:
  - Home:
      - index.md
  - Getting Started:
      - install.md
      - usage.md
      - Developing:
        - developing.md
        - contributing.md
        - style.md
      - Help:
          - help/ffmpeg.md
  - Using Libraries:
      - libraries.md
      - entries.md
      - preview-support.md
      - search.md
      - ignore.md
      - macros.md
      - Fields:
        - fields.md
      - Tags:
          - tags.md
          - colors.md
  - Updates:
      - changelog.md
      - roadmap.md
      - Schema History:
        - library-changes.md

theme:
  name: material
  custom_dir: overrides
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/lightbulb-auto-outline
        name: Switch to Light Mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: purple
      accent: purple
      toggle:
        icon: material/lightbulb
        name: Switch to Dark Mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: purple
      accent: purple
      toggle:
        icon: material/lightbulb-night-outline
        name: Switch to System Preference
  logo: assets/icon_mono.svg
  favicon: assets/icon.ico
  font:
    code: Jetbrains Mono
  language: en
  features:
    - content.action.edit
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - navigation.indexes
    - navigation.instant
    - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.tracking
    - search.suggest
  icon:
    repo: fontawesome/brands/github
    tag:
      upcoming: material/flask-outline

markdown_extensions:

  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 3

  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.snippets

plugins:
  - search
  - tags
  - social:  # social embed cards
      enabled: !ENV [CI, false]  # enabled only when running in CI (eg GitHub Actions)
  - redirects:
      redirect_maps:
        "develop.md": "developing.md"
        "library/entry.md": "entries.md"
        "library/field.md": "fields.md"
        "library/index.md": "libraries.md"
        "library/library_search.md": "search.md"
        "library/tag_categories.md": "tags.md"
        "library/tag_color.md": "colors.md"
        "library/tag.md": "tags.md"
        "updates/changelog.md": "changelog.md"
        "updates/roadmap.md": "roadmap.md"
        "updates/schema_changes.md": "library-changes.md"
        "utilities/ignore.md": "ignore.md"
        "utilities/macro.md": "macros.md"

extra_css:
  - stylesheets/extra.css
  - https://fonts.googleapis.com/css2?family=Bai+Jamjuree:ital,wght@0,200;0,300;0,400;0,500;0,600;0,700;1,200;1,300;1,400;1,500;1,600;1,700&display=swap