Mixins/mkdocs.yml at main · MicrocontrollersDev/Mixins · 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
site_name: Mixins
copyright: Copyright 2024 MicrocontrollersDev

theme:
  # favicon: assets/images/logo.png
  features:
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.tracking
    - navigation.expand
    - navigation.indexes
    - toc.integrate
    - toc.follow
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - content.action.edit
  name: material
  # logo: assets/images/logo.png
  icon:
    repo: fontawesome/brands/github
  palette:
  - media: "(prefers-color-scheme: light)"
    scheme: default
    primary: blue green
    accent: blue
    toggle:
      icon: material/weather-sunny
      name: Switch to dark mode
  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    primary: blue green
    accent: blue
    toggle:
      icon: material/weather-night
      name: Switch to light mode

repo_name: Mixins
repo_url: https://github.com/MicrocontrollersDev/Mixins
edit_uri: ../Mixins/edit/main/docs/
extra:
  social:
    - icon: simple/modrinth
      link: https://modrinth.com/user/Microcontrollers
    - icon: simple/curseforge
      link: https://legacy.curseforge.com/members/microcontrollerstv/projects
    - icon: simple/codeberg
      link: https://codeberg.org/MicrocontrollersDev
    - icon: fontawesome/brands/github
      link: https://github.com/MicrocontrollersDev
    - icon: simple/matrix
      link: https://matrix.to/#/!axTNrRSaDlwHtQznCp:matrix.org
    - icon: simple/revoltdotchat
      link: https://rvlt.gg/vNMTy2bw
    - icon: fontawesome/brands/discord
      link: https://discord.gg/rejfv9kFJj
    - icon: simple/mastodon
      link: https://sakurajima.social/@microcontrollers
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/@Microcontrollers
    - icon: simple/kofi
      link: https://ko-fi.com/microcontrollers

nav:
  - "Welcome":
      - "Overview": "welcome/overview.md"
      - "Getting Started": "welcome/gettingstarted.md"
  - "General":
      - "Overview": "general/overview.md"
      - "Debug": "general/debug.md"
      - "Method": "general/method.md"
      - "At": "general/at.md"
      - "Ordinal": "general/ordinal.md"
      - "Index": "general/index_.md"
      - "Shift": "general/shift.md"
      - "Shadow": "general/shadow.md"
      - "Unique": "general/unique.md"
      - "Slice": "general/slice.md"
      - "Ducks": "general/duck.md"
      - "Corece": "general/coerce.md"
      - "Psuedo" : "general/pseudo.md"
  - "Default Injections":
      - "Overview": "default/overview.md"
      - "Overwrite": "default/overwrite.md"
      - "Inject": "default/inject.md"
      - "Redirect": "default/redirect.md"
      - "ModifyArg": "default/modifyarg.md"
      - "ModifyArgs": "default/modifyargs.md"
      - "ModifyConstant": "default/modifyconstant.md"
      - "ModifyVariable": "default/modifyvariable.md"
      - "Accessor": "default/accessor.md"
      - "Invoker": "default/invoker.md"
  - "Mixin Extras":
      - "Overview": "mixinextras/overview.md"
      - "ModifyExpressionValue": "mixinextras/modifyexpressionvalue.md"
      - "ModifyReceiver": "mixinextras/modifyreceiver.md"
      - "ModifyReturnValue": "mixinextras/modifyreturnvalue.md"
      - "WrapMethod": "mixinextras/wrapmethod.md"
      - "WrapOperation": "mixinextras/wrapoperation.md"
      - "WrapWithCondition": "mixinextras/wrapwithcondition"
      - "Sugar":
          - "Overview": "mixinextras/sugar/overview.md"
          - "Cancellable": "mixinextras/sugar/cancellable.md"
          - "Local": "mixinextras/sugar/local.md"
          - "Share": "mixinextras/sugar/share.md"

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - footnotes
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.saneheaders

plugins:
  - search
  - open-in-new-tab
  - redirects:
      redirect_maps:
        index.md: welcome/overview.md
#  - git-revision-date-localized:
#      enable_creation_date: true
#      fallback_to_build_date: true
#  - git-committers:
#      repository: MicrocontrollersDev/Mixins
#      branch: main
# TODO: set up GH actions to push to cloudflare https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/issues/123#issuecomment-1992734955