RIMAPI/mkdocs.yml at master · AppSprout-dev/RIMAPI · 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
site_name: RimWorld REST API
site_description: Auto-generated API documentation
repo_url: https://github.com/IlyaChichkov/RIMAPI
repo_name: IlyaChichkov/RIMAPI
site_url: https://ilyachichkov.github.io/RIMAPI/
edit_uri: ""

copyright: Copyright &copy; 2025 Ilya Chichkov

theme:
  name: material
  palette:
    # Set dark mode as default
    - scheme: default
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

    - scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
  features:
    - navigation.expand
    - search.suggest
    - search.share
    - content.tabs.link
    - content.code.copy
    - content.code.annotate
    - content.code.select
    - content.tooltips

extra_css:
  - stylesheets/extra.css

nav:
  - Home: index.md
  - Quick Start: quick_start.md
  - API Reference: api.md
  - Developers:
    - Add new extension: developer_guide/creating_extensions.md
  - Contributors:
    - Architecture: contributors_guide/architecture.md
    - Add new endpoint: contributors_guide/creating_endpoints.md
    - Contribute: contributors_guide/contribute.md

plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;|(?<=\/)(?=\/)|(?<=\w)(?=\/)'
      pipeline:
        - stemmer
        - stopWordFilter
        - trimmer
      lang: en
  - macros:
      module_name: scripts/docs/mkdocs_generate_api
      on_error_fail: false
      on_undefined: lax
  - offline
  - social
  - tags
  - i18n:
      docs_structure: suffix
      fallback_to_default: true
      languages:
        - build: true
          default: true
          locale: en
          name: English
        - build: true
          default: false
          locale: ja
          name: 日本語
        - build: true
          default: false
          locale: ru
          name: Русский
      reconfigure_material: true
      reconfigure_search: true
  - mermaid2:
      javascript: https://unpkg.com/mermaid@10.4.0/dist/mermaid.esm.min.mjs
  - minify:
      minify_js: true
      minify_css: true
      htmlmin_opts:
          remove_comments: true
      cache_safe: true
  - llmstxt:
      full_output: llms-full.txt
      sections:
        API documentation:
        - index.md
        - api.md
        Developers documentation:
        - developer_guide/*.md
        Contributors documentation:
        - contributors_guide/*.md

markdown_extensions:
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true
  - tables
  - fenced_code
  - codehilite
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - admonition
  - attr_list
  - toc:
      permalink: true
      toc_depth: 2-3
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

extra:
  alternate:
    - name: English
      link: /RIMAPI/
      lang: en
    - name: 日本語
      link: /RIMAPI/ja/
      lang: ja
    - name: Русский
      link: /RIMAPI/ru/
      lang: ru
  social:
    - icon: fontawesome/brands/github
      link: https://ilyachichkov.github.io/RIMAPI
    - icon: fontawesome/brands/discord
      link: https://discord.gg/Css9b9BgnM