Allay/mkdocs.yml at master · AllayMC/Allay · 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
site_name: AllayMC
site_url: https://docs.allaymc.org
site_author: daoge_cmd

repo_name: AllayMC/Allay
repo_url: https://github.com/AllayMC/Allay

copyright: Copyright &copy; 2023 - 2024 AllayMC

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/AllayMC
    - icon: fontawesome/brands/discord
      link: https://discord.gg/ngkkE4hPTU

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js?config=TeX-AMS_CHTML

extra_css:
  - stylesheets/extra.css

plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true
  - gen-files:
      scripts:
        - docs/gen_event_list.py

theme:
  name: 'material'
  custom_dir: docs/overrides
  logo: assets/logo/allay-chan-480x.png
  favicon: assets/logo/allay-chan-480x.png
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - navigation.footer
    - navigation.indexes
    # - navigation.instant
    # - navigation.instant.prefetch
    # - navigation.instant.progress
    # - navigation.prune
    - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      auto_append:
        - includes/mkdocs.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - mdx_truly_sane_lists

nav:
  - Home: index.md

  - Getting Started:
      - Installation: getting-started/installation.md
      - Use Terra: getting-started/use-terra.md

  - Plugins: https://hub.allaymc.org/

  - Tutorials:
      - Create Your First Plugin: tutorials/create-your-first-plugin.md
      - Register Commands: tutorials/register-commands.md
      - Use Permission: tutorials/use-permission.md
      - Register Event Handlers: tutorials/register-event-listeners.md
      - Schedule Tasks: tutorials/schedule-tasks.md
      - Use Config: tutorials/use-config.md
      - Use Color Codes: tutorials/use-color-codes.md
      - Use Forms: tutorials/use-forms.md
      - Use Scoreboards: tutorials/use-scoreboards.md
      - Use BossBars: tutorials/use-bossbars.md
      - Use Primitive Shapes: tutorials/use-primitive-shapes.md
      - Block API: tutorials/block-api.md
      - Item API: tutorials/item-api.md
      - Container API: tutorials/container-api.md
      - Persistent Data Container: tutorials/persistent-data-container.md
      - Use i18n: tutorials/use-i18n.md

  - Advanced:
      - Custom Block API: advanced/custom-block-api.md
      - Custom Item API: advanced/custom-item-api.md
      - Event List: advanced/event-list.md
      - Block and Item Id: advanced/block-and-item-id.md

  - Development:
      - Update to The Next Protocol Version: development/update-to-the-next-protocol-version.md
      - Version of Allay: development/version-of-allay.md
      - Chunk Freezing Issue: development/chunk-freezing-issue.md
      - Component Injection System: development/component-injection-system.md

  - Javadoc: https://javadoc.io/doc/org.allaymc.allay/api/latest/index.html

  - Changelog: changelog.md