modding-notes/mkdocs.yml at master · toapuro/modding-notes · 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
site_name: Forge Modding Notes
site_description: Forge Modding Explained
site_author: toapuro
site_url: https://toapuro.github.io/modding-notes/
repo_name: toapuro/modding-notes
repo_url: https://github.com/toapuro/modding-notes
copyright: MIT License

theme:
  name: material
  icon:
    repo: fontawesome/brands/github
  features:
    - content.code.copy
    - content.code.select
    - content.tooltips
    - content.code.annotate

    - navigation.instant

  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue grey
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/toggle-switch-off
        name: Switch to system preference

  icon:
    annotation: material/star-four-points-circle

markdown_extensions:
  # Code
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true

  # Document
  - toc:
      permalink: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower

  # Text
  - footnotes
  - admonition
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde

  - attr_list
  - md_in_html

plugins:
  - search:
      lang: 'ja'
  - redirects:
      redirect_maps:
        'index.md': 'content/index.md'
  - mkdocs-simple-hooks:
      hooks:
        on_pre_build: "hooks.gather:gather_md"

hooks:
  - hooks/check.py

nav:
  - ホーム: content/index.md
  - 入門:
    - 環境構築: content/getting-started/setup.md
    - 依存関係の追加: content/getting-started/dependency.md
    - Modファイル構造: content/getting-started/mod-files.md
    - Modクラス: content/getting-started/mod.md
    - Git基礎: content/getting-started/git.md

  - 発展:
    - マッピング: content/advanced/mapping.md
    - Gradle: content/advanced/gradle.md

  - レンダリング:
    - 基本: content/rendering/basic.md
    - 基本概念: content/rendering/api.md
    - 描画設定: content/rendering/render-options.md
    - レンダラー:
      - アイテム: content/rendering/renderer/item.md
      - モデル: content/rendering/renderer/model.md

  - レジストリ:
    - レジストリについて: content/registries/basic.md
    - アイテム: content/registries/item.md

  - Mixin:
    - 基本: content/mixin/index.md
    - インジェクション: content/mixin/injections.md
    - MixinExtras: content/mixin/mixin-extras.md
    - トリック: content/mixin/tricks.md