summaryrefslogtreecommitdiffstatshomepage
path: root/mkdocs.yml
blob: 45398af13983d61c83428527d512cd7e4373497a (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
site_name: HydroRollCore 核心文档 (草案)
repo_url: https://github.com/HydroRoll-Team/HydroRollCore
repo_name: HydroRoll-Team/HydroRollCore
edit_uri: edit/master/docs/
site_author: Hsiang Nianian
site_description: >-
  HydroRollCore -- 水系核心,一个基于通用规则包标准的规则包读取框架。
  
theme:
  name: material
  language: zh
  icon:
    logo: material/library-outline
    repo: fontawesome/brands/git-alt 
  custom_dir: overrides
  features:
    - content.action.edit
    - content.action.view
    - content.tooltips
    - 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
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default 
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  
extra:
  homepage: https://grps.retrofor.space # hydroroll-team.github.io
  alternate:
    # - name: English
    #   link: /en/ 
    #   lang: en
    - name: 中文
      link: /
      lang: zh
  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
  
extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/extra.js

copyright: >
  Copyright &copy; 2013 - PRESENT. <a href="https://github.com/HydroRoll-Team">HydroRoll-Team</a> –
  <a href="#__consent">管理Cookie</a>

markdown_extensions:
  - pymdownx.snippets:
      auto_append:
        - includes/abbreviations.md
  - 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:materialx.emoji.to_svg
      emoji_index: !!python/name:materialx.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - 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
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  
plugins:
  - blog
  - search
  # - git-authors
  - 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/HydroRollCore

nav:
  - 主页: index.md
  - 水系核心:
    - "核心概览": Core/index.md
  - 规则包入门:
    - 整体结构: 
      - "类": RulePackage/Structure/class.md
      - "方法": RulePackage/Structure/method.md
      - "属性": RulePackage/Structure/attribute.md
    - 实战内容: 
      - "了解Python": RulePackage/Write/python.md
      - "准备规则书": RulePackage/Write/prepare.md
      - "编写规则包": RulePackage/Write/write.md
  - 通用规则包标准(GRPS1):
    - 什么是规则包?: 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 时长:
        - sene 场: Standard/Term/Duration/sene.md
        - module 模组: Standard/Term/Duration/module.md
        - campaign 战役: Standard/Term/Duration/campaign.md
      - face 骰子面数: Standard/Term/dice-face.md
      - count 骰子个数: Standard/Term/dice-count.md
      - check 检定: 
        - Standard/Term/check/index.md
        - ability 检定: Standard/Term/check/ability.md
  - API Reference:
    - "API Reference": API/index.md