diff options
Diffstat (limited to 'mkdocs.yml')
| -rw-r--r-- | mkdocs.yml | 180 |
1 files changed, 180 insertions, 0 deletions
diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..20df8453 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,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://HydroRollCore.retrofor.space + 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 © 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 |