Reclaimerr/mkdocs.yml at dev · code-boar/Reclaimerr · 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
site_name: Reclaimerr Docs
site_url: https://jessielw.github.io/Reclaimerr/
site_description: Reclaimerr documentation, setup, deployment, and development notes
site_author: jessielw
repo_url: https://github.com/jessielw/Reclaimerr
repo_name: jessielw/Reclaimerr
edit_uri: edit/main/docs/

theme:
  name: material
  variant: classic
  language: en
  icon:
    logo: material/arrow-decision
  features:
    - navigation.instant
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - navigation.tracking
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - search.highlight
    - search.share
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue-grey
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue-grey
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to light mode

plugins:
  - search

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

nav:
  - Home: index.md
  - Features: features.md
  - Getting Started:
      - Quick Start: getting-started/index.md
      - Installation: getting-started/installation.md
      - Configuration: getting-started/configuration.md
  - Using Reclaimerr:
      - How It Works: usage/how-it-works.md
      - Deletion Flow: usage/deletion-flow.md
      - Rules: usage/rules.md
      - Tasks: usage/tasks.md
  - Deployment:
      - Docker: deployment/docker.md
      - Production: deployment/production.md
      - Backups: deployment/backups.md
      - SWAG Reverse Proxy: deployment/swag.md
  - Development:
      - Contributing: development/contributing.md
      - Architecture: development/architecture.md
      - Release Process: development/release-process.md
      - Database Migrations: development/migrations.md
  - Reference:
      - Changelog: reference/changelog.md
      - External API: reference/api.md
      - Internal UI API: reference/internal-api.md
      - FAQ: reference/faq.md
      - Troubleshooting: reference/troubleshooting.md