django-returns/mkdocs.yml at main · brunodantas/django-returns · 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
site_name: django-returns
site_url: https://brunodantas.github.io/django-returns
site_description: Meaningful Django utils based on Functional Programming

repo_url: https://github.com/brunodantas/django-returns
repo_name: brunodantas/django-returns

nav:
  - Quick Look: index.md
  - Getting Started: getting-started.md
  - Async Methods: async-io.md
  - API Reference: api.md

theme:
  name: material
  icon:
    logo: material/function-variant

  features:
    - content.code.copy
    - navigation.footer
    - navigation.instant
    - navigation.top

  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

plugins:
  - social:
      enabled: !ENV [CI, false]
      cards_layout_options:
        background_color: "#0D9488"
        color: "#ffffff"
  - macros

extra:
  homepage: .
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/brunodantas/django-returns
      name: GitHub

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

extra_css:
  - stylesheets/extra.css