django-cachex/mkdocs.yml at main · oliverhaas/django-cachex · 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
site_name: Django CacheX
site_description: Full featured Redis and Valkey cache backend for Django
site_url: https://oliverhaas.github.io/django-cachex/
repo_url: https://github.com/oliverhaas/django-cachex
repo_name: oliverhaas/django-cachex
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: red
      accent: red
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: red
      accent: red
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - content.code.copy
    - content.code.annotate

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - toc:
      permalink: true

extra:
  version:
    provider: mike

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
  - User Guide:
      - Configuration: user-guide/configuration.md
      - Cache Admin: user-guide/admin.md
      - Async Support: user-guide/async.md
      - Advanced Usage: user-guide/advanced.md
      - Serializers: user-guide/serializers.md
      - Compression: user-guide/compression.md
      - Sentinel: user-guide/sentinel.md
      - Cluster: user-guide/cluster.md
  - Recipes: recipes.md
  - Migration: migration.md
  - Reference:
      - API: reference/api.md
      - Changelog: reference/changelog.md