diff options
| author | 2023-10-07 06:48:07 +0800 | |
|---|---|---|
| committer | 2023-10-07 06:48:07 +0800 | |
| commit | 991fd7a6d67ee017c57beaaa21fc31c4bee7944d (patch) | |
| tree | e895202203fcaa50b0052f60ef6fc7d6d2928cf9 /mkdocs.yml | |
| parent | d62900046bb6f754a8e6e7e670a66a90134055d9 (diff) | |
| download | infini-991fd7a6d67ee017c57beaaa21fc31c4bee7944d.tar.gz infini-991fd7a6d67ee017c57beaaa21fc31c4bee7944d.zip | |
feat(version): versions
Diffstat (limited to 'mkdocs.yml')
| -rw-r--r-- | mkdocs.yml | 167 |
1 files changed, 100 insertions, 67 deletions
@@ -4,15 +4,15 @@ 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 + repo: fontawesome/brands/git-alt + custom_dir: material/overrides features: - content.action.edit - content.action.view @@ -21,9 +21,9 @@ theme: - navigation.tabs # - navigation.tabs.sticky - navigation.sections - - navigation.expand + # - navigation.expand - navigation.path - - navigation.indexes + - navigation.indexes - toc.follow - navigation.top - search.highlight @@ -31,6 +31,12 @@ theme: - search.share - header.autohide - navigation.footer + - content.code.annotate + - content.code.copy + - content.code.select + - navigation.instant + - navigation.instant.prefetch + - navigation.instant.progress palette: # Palette toggle for automatic mode - media: "(prefers-color-scheme)" @@ -40,7 +46,7 @@ theme: # Palette toggle for light mode - media: "(prefers-color-scheme: light)" - scheme: default + scheme: default toggle: icon: material/brightness-7 name: Switch to dark mode @@ -51,49 +57,48 @@ theme: toggle: icon: material/brightness-4 name: Switch to system preference - + font: + text: Roboto + code: Roboto Mono extra: + version: + provider: mike homepage: https://grps.retrofor.space # hydroroll-team.github.io alternate: # - name: English - # link: /en/ + # link: /en/ # lang: en - name: 中文 - link: / lang: zh consent: title: Cookie 偏好设置 - description: >- + description: >- 我们使用Cookie来识别您的重复访问和偏好,以及衡量我们的文档的有效性和用户是否找到他们搜索的内容。在您的同意下,这将帮助我们改善我们的文档。 actions: - accept - manage cookies: - analytics: - name: Google Analytics - checked: true - github: - name: GitHub - checked: true + 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 + - icon: fontawesome/brands/python + link: https://pypi.org/project/HydroRollCore/ copyright: > Copyright © 2013 - PRESENT. <a href="https://github.com/HydroRoll-Team">HydroRoll-Team</a> – - <a href="#__consent">管理Cookie</a> + <a href="#__consent">管理Cookies</a> markdown_extensions: - pymdownx.snippets: auto_append: - - includes/abbreviations.md + - RulePackage/getStart/getDeeper/Module.md - abbr - admonition - attr_list @@ -101,7 +106,7 @@ markdown_extensions: - footnotes - md_in_html - toc: - permalink: true + permalink: ⚓︎ - pymdownx.arithmatex: generic: true - pymdownx.betterem: @@ -115,12 +120,14 @@ markdown_extensions: 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: squidfunk - repo: mkdocs-material + user: HydroRoll-Team + repo: HydroRollCore - pymdownx.mark - pymdownx.smartsymbols - pymdownx.superfences: @@ -130,56 +137,82 @@ markdown_extensions: 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 - # - git-authors + - search: + separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])' + - git-authors + - mike + - 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" + 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 - + - minify: + minify_html: true nav: - 主页: index.md - 水系核心: - - "核心概览": Core/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 + - 简介: 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 - 通用规则包标准(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 时长: - - 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 + - 什么是规则包?: 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 Reference: + - "CLI Reference": CLI/index.md - API Reference: - - "API Reference": API/index.md + - "API Reference": API/index.md + - Blog: + - blog/index.md + - Changelog: + - changelog.md + +extra_css: + - stylesheets/extra.css |
