aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/mkdocs.yml
blob: 5c80514eb2965eaac0080146b3ee83ee182e1ebb (plain) (blame)
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
site_name: Infini 核心文档
repo_url: https://github.com/HydroRoll-Team/infini
repo_name: HydroRoll-Team/infini
edit_uri: edit/master/docs/
site_author: HsiangNianian
site_description: >-
  一个基于通用规则包标准的规则包加载器

theme:
  name: material
  language: zh
  favicon: images/logo.png
  icon:
    logo: material/book-sync
    repo: fontawesome/brands/git-alt
    annotation: material/arrow-right-circle
  custom_dir: docs/src/overrides
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.action.edit
    - content.action.view
    - content.tooltips
    - content.tabs.link
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - navigation.footer
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.sections
    # - navigation.expand
    - navigation.path
    - navigation.indexes
    - toc.follow
    - navigation.top
    - search.highlight
    - search.suggest
    - search.share
    - header.autohide
    - navigation.footer
    - announce.dismiss
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress

  font:
    text: Times New
    code: Times New
extra:
  status:
    new: 最近添加
    deprecated: 已被废弃
  version:
    provider: mike
  homepage: https://grps.hydroroll.team # hydroroll-team.github.io
  consent:
    title: Cookie 偏好设置
    description: >-
      我们使用Cookie来识别您的重复访问和偏好,以及衡量我们的文档的有效性和用户是否找到他们搜索的内容。在您的同意下,这将帮助我们改善我们的文档。
    actions:
      - accept
      - manage
    cookies:
      analytics:
        name: Google Analytics
        checked: true
      github:
        name: GitHub
        checked: true

  social:
    - icon: fontawesome/brands/github
      link: https://github.com/HydroRoll-Team
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/infini/

copyright: >
  Copyright &copy; 2023 - PRESENT. <a href="#__consent">(管理Cookies)</a>

markdown_extensions:
  - attr_list
  - md_in_html
  - pymdownx.superfences
  - pymdownx.snippets:
      auto_append:
        - RulePackage/getStart/getDeeper/Module.md
  - abbr
  - admonition
  - def_list
  - footnotes
  - toc:
      permalink: ⚓
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
      linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: HydroRoll-Team
      repo: infini
  - pymdownx.mark
  - pymdownx.smartsymbols
  - 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

plugins:
  - blog
  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - git-authors
  - mike:
      version_selector: true
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
  - git-revision-date-localized:
      enable_creation_date: true
      fallback_to_build_date: true
      timezone: Asia/Shanghai
      type: timeago
      custom_format: "%d. %B %Y"
  - git-committers:
      repository: HydroRoll-Team/infini
  - minify:
      minify_html: true
nav:
  - 主页: index.md
  - 水系核心:
      - "核心概览": Core/index.md
  - 规则包入门:
      - 概述: RulePackage/intro.md
      - 开始:
          - "类": RulePackage/getStart/class.md
          - "方法": RulePackage/getStart/method.md
          - "属性": RulePackage/getStart/attribute.md
          - 深入:
              - "对象": RulePackage/getStart/getDeeper/object.md
              - "模块": RulePackage/getStart/getDeeper/Module.md
              - "包": RulePackage/getStart/getDeeper/Package.md
      - 实战:
          - "了解Python": RulePackage/Write/python.md
          - "准备规则书": RulePackage/Write/prepare.md
          - "编写规则包": RulePackage/Write/write.md
      - 技巧:
          - RulePackage/skill/index.md
          - "善用语法糖": RulePackage/skill/fstring.md
  - 通用规则包标准:
      - 什么是规则包?: Standard/what-is-rule-package.md
      - 为什么要做规则包?: Standard/why-rule-package.md
      - 什么是通用规则包标准?: Standard/what-is-standard.md
      - 术语表(草案):
          - setting 背景: Standard/Term/setting.md
          - scenario 剧本: Standard/Term/scenario.md
          - duration 时长:
              - Standard/Term/duration/index.md
              - sene 场: Standard/Term/duration/sene.md
              - module 模组: Standard/Term/duration/module.md
              - campaign 战役: Standard/Term/duration/campaign.md
          - DefaultDice 默认骰子:
              - Standard/Term/DefaultDice/index.md
              - _sides 骰子面数: Standard/Term/DefaultDice/_sides.md
              - _counts 骰子个数: Standard/Term/DefaultDice/_counts.md
          - check 检定:
              - Standard/Term/check/index.md
              - ability 检定: Standard/Term/check/ability.md
          - PlayerCard 人物卡:
              - Standard/Term/PlayerCard/index.md
  - CLI 参考:
      - "CLI Reference": CLI/index.md
  - API 参考:
      - "API Reference": API/index.md
  - 其他帮助:
      - "术语表一览": Help/TermList.md
      - "Python 技巧": Help/PythonSkill.md
      - "图标、图例、注释说明": Help/emoji.md
  - 博客:
      - blog/index.md
  - 日志:
      - changelog.md

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - "https://samuelcolvin.github.io/mkdocs-run-code/run_code_main.js"