From b37e0736ad4ad8de8856af5b515336d4731357c5 Mon Sep 17 00:00:00 2001 From: Xiangze Li Date: Fri, 11 Oct 2024 17:46:50 +0800 Subject: [PATCH 1/2] =?UTF-8?q?style:=20=E6=8C=89=E4=B8=AD=E6=96=87?= =?UTF-8?q?=E6=96=87=E6=A1=88=E6=8E=92=E7=89=88=E6=8C=87=E5=8C=97=E8=A7=84?= =?UTF-8?q?=E8=8C=83=E8=A1=8C=E6=96=87,=20=E4=B8=BAAutoCorrect=E6=8F=92?= =?UTF-8?q?=E4=BB=B6=E8=A1=A5=E5=85=85nolint=E6=A0=87=E8=AE=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .autocorrectrc | 132 ++++++++++++++++++++++ .github/workflows/lint.yml | 2 +- docs/about/develop.md | 6 +- docs/advanced/README.md | 3 +- docs/advanced/edit_complex_custom_text.md | 10 +- docs/advanced/edit_deck.md | 52 ++++----- docs/advanced/edit_reply.md | 18 +++ docs/advanced/introduce.md | 2 +- docs/advanced/js_api_list.md | 6 +- docs/advanced/js_example.md | 8 +- docs/archive/archive-about-opensource.md | 2 +- docs/archive/archive-guide.md | 4 +- docs/archive/archive-other.md | 10 +- docs/archive/archive-terms.md | 8 +- docs/config/custom_text.md | 2 + docs/config/reply.md | 14 +++ docs/deploy/db-repair.md | 4 +- docs/deploy/platform-minecraft.md | 2 +- docs/deploy/platform-qq-official.md | 6 +- docs/deploy/platform-qq.md | 2 +- docs/deploy/platform-slack.md | 4 +- docs/deploy/quick-start.md | 8 +- docs/deploy/special_feature.md | 6 + docs/use/coc7.md | 30 +++++ docs/use/core.md | 56 +++++++++ docs/use/deck_and_reply.md | 8 +- docs/use/dnd5e.md | 36 ++++++ docs/use/faq.md | 2 +- docs/use/fun.md | 30 +++++ docs/use/story.md | 2 + 30 files changed, 406 insertions(+), 69 deletions(-) create mode 100644 .autocorrectrc diff --git a/.autocorrectrc b/.autocorrectrc new file mode 100644 index 000000000..6cc25193a --- /dev/null +++ b/.autocorrectrc @@ -0,0 +1,132 @@ +# yaml-language-server: $schema=https://huacnlee.github.io/autocorrect/schema.json +rules: + # Default rules: https://github.com/huacnlee/autocorrect/raw/main/autocorrect/.autocorrectrc.default + spellcheck: 2 +# Enable or disable in special context +context: + # Enable or disable to format codeblock in Markdown or AsciiDoc etc. + codeblock: 0 +textRules: + # Config some special rule for some texts + # For example, if we wants to let "Hello你好" just warning, and "Hi你好" to ignore + # "Hello你好": 2 + # "Hi你好": 0 + "「QQ(onebot11反向WS)」": 0 + "「QQ(onebot11正向WS)」": 0 + "「onebot11反向WS」": 0 + "「onebot11正向WS」": 0 + "「Discord账号」": 0 + "「Telegram账号」": 0 + "「KOOK(开黑啦)账号」": 0 + "「DoDo语音」": 0 + "「反向WebSocket监听地址」": 0 +fileTypes: + # Config the files associations, you config is higher priority than default. + # "rb": ruby + # "Rakefile": ruby + # "*.js": javascript + # ".mdx": markdown +spellcheck: + words: + # Please do not add a general English word (eg. apple, python) here. + # Users can add their special words to their .autocorrectrc file by their need. + - ActiveMQ + - AirPods + - Aliyun + - API + - App Store + - AppKit + - AppStore = App Store + - AWS + - CacheStorage + - CDN + - CentOS + - CloudFront + - CORS + - CPU + - DNS + - Elasticsearch + - ESLint + - Facebook + - GeForce + - GitHub + - Google + - GPU + - H5 + - Hadoop + - HBase + - HDFS + - HKEX + - HTML + - HTTP + - HTTPS + - I10n + - I18n + - iMovie + - IndexedDB + - Intel + - iOS + - iPad + - iPadOS + - iPhone + - iTunes + - JavaScript + - jQuery + - JSON + - JWT + - Linux + - LocalStorage + - macOS + - Markdown + - Microsoft + - MongoDB + - Mozilla + - MVC + - MySQL + - Nasdaq + - Netflix + - NodeJS = Node.js + - NoSQL + - NVDIA + - NYSE + - OAuth + - Objective-C + - OLAP + - OSS + - P2P + - PaaS + - RabbitMQ + - Redis + - RESTful + - RSS + - RubyGem + - RubyGems + - SaaS + - Sass + - SDK + - Shopify + - SQL + - SQLite + - SQLServer + - SSL + - Tesla + - TikTok + - tvOS + - TypeScript + - Ubuntu + - UML + - URI + - URL + - VIM + - watchOS + - WebAssembly + - WebKit + - Webpack + - Wi-Fi + - Windows + - WWDC + - Xcode + - XML + - YAML + - YML + - YouTube diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 320e7febb..a2fb06637 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -11,4 +11,4 @@ jobs: - uses: actions/checkout@v4 - uses: DavidAnson/markdownlint-cli2-action@v16 with: - globs: '**/*.md' + globs: "**/*.md" diff --git a/docs/about/develop.md b/docs/about/develop.md index 5117b12e6..0b133225d 100644 --- a/docs/about/develop.md +++ b/docs/about/develop.md @@ -107,17 +107,17 @@ title: 参与项目 你的修改完成后，在你 fork 的新仓库向主仓库发起 Pull Request： -![创建PR](./images/develop-pr-1.png) +![创建 PR](./images/develop-pr-1.png) 提交时间很近的时候，GitHub 会提示快捷发起 PR 的操作按钮： -![快速创建PR](./images/develop-pr-2.png) +![快速创建 PR](./images/develop-pr-2.png) 进入 PR 编辑页填写信息，请确认是从你的仓库的新分支，提向主仓库的主分支的： `主仓库 主分支 <- fork仓库 功能分支` -![填写PR信息](./images/develop-open-pr-1.png) +![填写 PR 信息](./images/develop-open-pr-1.png) 填写完成后，等待开发组进行 review，有时会给你提出一些修改建议。在你的 PR review 通过并合并后，功能分支就可以被删除了。 diff --git a/docs/advanced/README.md b/docs/advanced/README.md index 27bfa812f..5b25d350d 100644 --- a/docs/advanced/README.md +++ b/docs/advanced/README.md @@ -10,10 +10,9 @@ index: false - [编写牌堆](./edit_deck.md) - [编写帮助文档](./edit_helpdoc.md) - [编写敏感词库](./edit_sensitive_words.md) -- Javascript 插件 +- JavaScript 插件 - [前言](./js_start.md) - [插件的工程化编写](./js_project.md) - [常见用法示例](./js_example.md) - [编写新的 TRPG 规则](./js_gamesystem.md) - [API 列表](./js_api_list.md) - \ No newline at end of file diff --git a/docs/advanced/edit_complex_custom_text.md b/docs/advanced/edit_complex_custom_text.md index c8afcf85f..c3f4e19ad 100644 --- a/docs/advanced/edit_complex_custom_text.md +++ b/docs/advanced/edit_complex_custom_text.md @@ -26,12 +26,14 @@ $t计算结果 == 1 ? " 啧！" ::: info 示例 + + ::: @@ -53,9 +55,9 @@ $t计算结果 == 1 ? " 啧！" ```text {% if $t1==""||$t1==" 默认" {$g文案模式 = 0; $t输出="默认模式启用"}; -if $t1==" 模式1" {$g文案模式 = 1; $t输出="模式1启用"}; +if $t1==" 模式1" {$g文案模式 = 1; $t输出="模式1启用"}; if $t1==" 模式2" {$g文案模式 = 2; $t输出="模式2启用"}; -if $t1!=""&&$t1!=" 默认"&&$t1!=" 模式1"&&$t1!=" 模式2" {$t输出=`不存在指定模式{$t1}`}; +if $t1!=""&&$t1!=" 默认"&&$t1!=" 模式1"&&$t1!=" 模式2" {$t输出=`不存在指定模式{$t1}`}; $t输出 %} ``` @@ -64,7 +66,7 @@ $t输出 回复： ```text -{% +{% $g文案模式==0 ? "当前在默认模式", $g文案模式==1 ? "当前在模式1" , $g文案模式==2 ? "当前在模式2" @@ -89,6 +91,7 @@ if $g文案模式 == 2 {$t目标文案 = `（这里填你个性化的模式2文 ::: info 示例 + + ::: diff --git a/docs/advanced/edit_deck.md b/docs/advanced/edit_deck.md index 29b56da1a..3cc0cc862 100644 --- a/docs/advanced/edit_deck.md +++ b/docs/advanced/edit_deck.md @@ -52,7 +52,7 @@ title: 编写牌堆 :::: tabs key:deck-format -== toml +== TOML #### TOML 注释 @@ -164,7 +164,7 @@ TRPG = [ ] ``` -== json +== JSON ::: info JSON with Comment / JWCC @@ -267,7 +267,7 @@ JSON 键值对以 `"key": value` 的形式表达，需要包裹在 `{}` 或 `[]` 从序列 `/*` 开始到随后出现的第一个 `*/` 序列为止的所有文本，包括换行，都被视为注释。 -== yaml +== YAML ### YAML 注释 @@ -368,7 +368,7 @@ YAML 的语法极其灵活，同一种形式在 YAML 中可以有多种等价表 ::: tabs key:deck-format -== toml +== TOML ```toml # 元信息表 @@ -407,7 +407,7 @@ desc = "这个示例牌堆怎么这么臭（恼）" 可以将上述内容保存名为 `野兽牌堆.toml`（名称任意，但必须是以 `.toml` 为后缀扩展名）的文件进行测试。 -== json +== JSON ```json { @@ -441,7 +441,7 @@ desc = "这个示例牌堆怎么这么臭（恼）" 可以将上述内容保存名为 `野兽牌堆.json`（名称任意，但必须是以 `.json` 为后缀扩展名）的文件进行测试。 -== yaml +== YAML ```yaml name: 野兽牌堆 @@ -488,7 +488,7 @@ command: :::: tabs key:deck-format -== toml +== TOML ```toml [decks] @@ -502,7 +502,7 @@ command: ] ``` -== json +== JSON ```json { @@ -517,7 +517,7 @@ command: } ``` -== yaml +== YAML ::: warning 注意：YAML 的放回表示 @@ -593,7 +593,7 @@ YAML 牌堆中的表示正好相反： ::: tabs key:deck-format -== toml +== TOML ```toml [decks] @@ -603,7 +603,7 @@ YAML 牌堆中的表示正好相反： ] ``` -== json +== JSON ```json { @@ -614,7 +614,7 @@ YAML 牌堆中的表示正好相反： } ``` -== yaml +== YAML ```yaml 捕捉海豹: @@ -680,11 +680,11 @@ YAML 牌堆中的表示正好相反： └─ test.json ``` -选中牌堆文件和 assets 文件夹压缩为 ZIP 文件，修改文件后缀为 deck 。 +选中牌堆文件和 assets 文件夹压缩为 ZIP 文件，修改文件后缀为 deck。 ![示例](./images/edit-deck-pkg.png) -图例中所使用的软件为 Bandizip ，使用 Windows 右键菜单中的 `压缩为 ZIP 文件` 与之等价的。 +图例中所使用的软件为 Bandizip，使用 Windows 右键菜单中的 `压缩为 ZIP 文件` 与之等价的。 ::: warning 注意：小心嵌套文件夹 @@ -697,7 +697,7 @@ YAML 牌堆中的表示正好相反： `.draw keys` 指令会列出所有允许抽取的牌组，但在牌堆编写过程中，经常会需要用到辅助的牌组，这些辅助项是不希望暴露给用户的。我们可以通过一定方式来隐藏这些项。 ::: tabs key:deck-format -== toml +== TOML 在 TOML 牌堆中，当牌组的名称以 `_` 开头，那么这个牌组将不会暴露在 `.draw keys` 中。 @@ -715,7 +715,7 @@ YAML 牌堆中的表示正好相反： 这样在 `.draw keys` 中就不会展示 `_时间点` 这一牌组。 -== json +== JSON 在 JSON 牌堆中，可以通过配置牌堆文件的 `_keys` 指定所有显示的牌组，未指定在列表中的牌组将不会暴露在 `.draw keys` 中。 @@ -735,7 +735,7 @@ YAML 牌堆中的表示正好相反： 这样在 `.draw keys` 中就不会展示 `时间点` 这一牌组。 -== yaml +== YAML YAML 牌堆**没有支持**这一功能。 @@ -745,7 +745,7 @@ YAML 牌堆**没有支持**这一功能。 ::: tabs key:deck-format -== toml +== TOML 在 TOML 牌堆中，当牌组的名称以 `__`（双下划线）开头，那么这个牌组将不导出，即无法使用 `.draw ` 进行抽取，更不会显示在列表中。 @@ -761,7 +761,7 @@ YAML 牌堆**没有支持**这一功能。 ] ``` -== json +== JSON 在 JSON 牌堆中，当牌组的名称以 `_` 开头，那么这个牌组将不导出，即无法使用 `.draw ` 进行抽取，更不会显示在列表中。 @@ -796,7 +796,7 @@ YAML 牌堆**没有支持**这一功能。 } ``` -== yaml +== YAML 如果在 YAML 牌堆中定义了 `default` 字段，海豹将以 `command` 字段的值为关键字，`default` 字段的值为内容组成一个牌组。除了这个牌组以外的牌组都被视为不导出。 @@ -835,7 +835,7 @@ default: ::: tabs key:deck-format -== toml +== TOML 配置牌堆文件的 `updateUrls` 以指定对应的更新链接： @@ -858,7 +858,7 @@ updateUrls = [ ] ``` -== json +== JSON 配置牌堆文件的 `_updateUrls` 以指定对应的更新链接： @@ -877,7 +877,7 @@ updateUrls = [ } ``` -== yaml +== YAML 配置牌堆文件的 `update_urls` 以指定对应的更新链接： @@ -910,7 +910,7 @@ update_urls: ::: tabs key:deck-format -== toml +== TOML ```toml [decks] @@ -920,7 +920,7 @@ update_urls: ] ``` -== json +== JSON ```json { @@ -931,7 +931,7 @@ update_urls: } ``` -== yaml +== YAML ```yaml 幸运转盘: diff --git a/docs/advanced/edit_reply.md b/docs/advanced/edit_reply.md index d532106ec..50e5e41ac 100644 --- a/docs/advanced/edit_reply.md +++ b/docs/advanced/edit_reply.md @@ -77,10 +77,12 @@ func strCompare(a string, b string) float64 { ::: info 示例 + + ::: @@ -114,12 +116,14 @@ func strCompare(a string, b string) float64 { ::: info 示例 + + ::: @@ -267,10 +271,12 @@ if 判断3 { $tRand=d10; $t输出 = $tRand==1 ? `内容1`, …… }; ::: info 示例 + + ::: @@ -381,29 +387,39 @@ if ($t0=="石头" && $tDicePlay=="剪刀") || ($t0=="布" && $tDicePlay=="石头 == 输入：AB + + + == 输入：A间隔B + + + == 输入：A（无回复） + + == 输入：B（无回复） + + ::: @@ -419,6 +435,7 @@ if ($t0=="石头" && $tDicePlay=="剪刀") || ($t0=="布" && $tDicePlay=="石头 ::: info 示例 + + ::: diff --git a/docs/advanced/introduce.md b/docs/advanced/introduce.md index 5372ee494..c9af1c93c 100644 --- a/docs/advanced/introduce.md +++ b/docs/advanced/introduce.md @@ -21,7 +21,7 @@ title: 进阶介绍 在很多地方为了实现一些逻辑，都需要用到海豹所提供的一种简单的脚本语言，可以称为「海豹语」「豹语」等。 -我们非常建议你在扩展功能的编写中，先了解海豹语。见 [扩展-内置脚本语言](./script.md)。 +我们非常建议你在扩展功能的编写中，先了解海豹语。见 [扩展 - 内置脚本语言](./script.md)。 ## 用什么编写？ diff --git a/docs/advanced/js_api_list.md b/docs/advanced/js_api_list.md index 880814de2..ad0b8970e 100644 --- a/docs/advanced/js_api_list.md +++ b/docs/advanced/js_api_list.md @@ -23,10 +23,10 @@ cmd.solve = (ctx, msg, cmdArgs) => { } ``` -下面是 api 的说明（完全了吧......应该？）： +下面是 API 的说明（完全了吧………应该？）： ```javascript -//被注释掉的 api 是可以提供的，但是在源码中被注释。 +//被注释掉的 API 是可以提供的，但是在源码中被注释。 //seal.setVarInt(ctx, `$XXX`, valueToSet) //`$XXX`即 rollvm（初阶豹语）中的变量，其会将$XXX 的值设定为 int 类型的 valueToSet。 //seal.setVarStr(ctx, `$XXX`, valueToSet) //同上，区别是设定的为 str 类型的 valueToSet。 seal.replyGroup(ctx, msg, something) //向收到指令的群中发送 something。 @@ -90,7 +90,7 @@ seal.ban.getUser(id) ``` -以下为部分 api 使用示例。 +以下为部分 API 使用示例。 ::: tip diff --git a/docs/advanced/js_example.md b/docs/advanced/js_example.md index 4972241e9..8bc780a27 100644 --- a/docs/advanced/js_example.md +++ b/docs/advanced/js_example.md @@ -342,7 +342,7 @@ if (!seal.ext.find('draw-decks-example')) { 白名单用户即通过骰主手动添加的信任名单用户，可以使用所有需要群管理权限的功能，但不具备 Master 权限。 -信任名单可以通过 .ban trust <统一ID> 添加，通过 .ban list trust 查看。 +信任名单可以通过 `.ban trust <统一ID>` 添加，通过 `.ban list trust` 查看。 ::: @@ -437,7 +437,7 @@ if (!seal.ext.find('myperm')) { - `id`：用户 ID，字符串类型 - `name`：用户昵称，字符串类型 - `score`：怒气值，整数类型 -- `rank`：拉黑/信任等级 0 没事 -10警告 -30禁止 30信任 +- `rank`：拉黑/信任等级 0=没事 -10=警告 -30=禁止 30=信任 - `times`：事发时间，数组类型，内部元素为整数时间戳 - `reasons`：拉黑/信任原因，数组类型，内部元素为字符串 - `places`：拉黑/信任的发生地点，数组类型，内部元素为字符串 @@ -1124,7 +1124,7 @@ seal.coc.registerRule(rule); ## 补充：使用非指令关键词 -> 你是否因为自定义回复能实现的功能有限而烦恼？你是否因为自定义回复的匹配方式不全而愤怒？你是否因为自定义回复只能调用图片 api 而感到焦头烂额？ +> 你是否因为自定义回复能实现的功能有限而烦恼？你是否因为自定义回复的匹配方式不全而愤怒？你是否因为自定义回复只能调用图片 API 而感到焦头烂额？ > > 不要紧张，我的朋友，试试非指令关键词，这会非常有用。 @@ -1277,7 +1277,7 @@ if (!seal.ext.find('js-config-example')) { ::: tip 提示：Cron 表达式 -如果你对 `cron` 或下文中提到的 Cron 表达式并不熟悉，可以参考 [Linux crontab 命令| 菜鸟教程](https://www.runoob.com/linux/linux-comm-crontab.html) 或 [Cron表达式 - 阿里云文档](https://help.aliyun.com/zh/ecs/user-guide/cron-expressions)。 +如果你对 `cron` 或下文中提到的 Cron 表达式并不熟悉，可以参考 [Linux crontab 命令 | 菜鸟教程](https://www.runoob.com/linux/linux-comm-crontab.html) 或 [Cron 表达式 - 阿里云文档](https://help.aliyun.com/zh/ecs/user-guide/cron-expressions)。 ::: diff --git a/docs/archive/archive-about-opensource.md b/docs/archive/archive-about-opensource.md index 057337127..d9069000c 100644 --- a/docs/archive/archive-about-opensource.md +++ b/docs/archive/archive-about-opensource.md @@ -83,7 +83,7 @@ title: 开源程序相关 我在使用 版本的海豹骰中，发现我的海豹骰的数据库文件的磁盘占用出现了无法通过重启解决的故障，它变得非常大，大概有 300 MB 这样的大小。但是我的骰子并没有如此大的数据量，它只是一个私骰。 -我试过对我的海豹骰进行重启，还有撤去一些自定义回复文件以及 json 牌堆文件，但是基本对数据库文件夹的异常磁盘占用问题没有效果。 +我试过对我的海豹骰进行重启，还有撤去一些自定义回复文件以及 JSON 牌堆文件，但是基本对数据库文件夹的异常磁盘占用问题没有效果。 我现在使用的是 Lagrange 分离部署，使用正向 WS 进行部署。 diff --git a/docs/archive/archive-guide.md b/docs/archive/archive-guide.md index 2e29952eb..4e3e3017f 100644 --- a/docs/archive/archive-guide.md +++ b/docs/archive/archive-guide.md @@ -115,7 +115,7 @@ GitHub 是多数开源程序发布代码的地方，SealDice 开发者们平时 ### 寻求资源 -当遇到不理解的概念时，我们的第一反应往往是去搜索引擎寻求答案。但是，如果你正在解决特定项目中遇到的问题，不妨先看看此项目的帮助文档、常见问题（FAQ）和 GitHUb 上的 [Issue](../archive/archive-terms#issue)。 +当遇到不理解的概念时，我们的第一反应往往是去搜索引擎寻求答案。但是，如果你正在解决特定项目中遇到的问题，不妨先看看此项目的帮助文档、常见问题（FAQ）和 GitHub 上的 [Issue](../archive/archive-terms#issue)。 一个合理的开源项目，往往都具备相对详尽的帮助文档，描述了使用这个项目的过程中可能涉及的方方面面。例如，你正在阅读的就是海豹骰点核心的用户手册，亦即帮助文档。帮助文档通常包含了各个项目从部署到使用的一系列教程，在你具备相关背景的情况下，阅读帮助文档远比直接使用搜素引擎高效得多，因为帮助文档中提供的信息都是服务于特定项目的，而搜索引擎往往只能找到泛化的知识。 @@ -205,7 +205,7 @@ flowchart TD 你不知道终端是什么意思，于是你在 [名词/术语速查表](../archive/archive-terms) 中翻阅了一下。虽然你对什么是 Shell、什么是命令行一知半解，但是你差不多知道他指的是那个在电脑上弹出来的黑框框。 -于是你又看了一眼日志是什么意思。虽让你搞不懂什么 Warning 与 Error,但你知道黑框框里那堆文字就是日志。 +于是你又看了一眼日志是什么意思。虽让你搞不懂什么 Warning 与 Error，但你知道黑框框里那堆文字就是日志。 最后，因为你从没在电脑上截屏过，你去搜索了一下，找到了 Snipaste 这一截图工具。把黑框框里的文字截图发了出去。 diff --git a/docs/archive/archive-other.md b/docs/archive/archive-other.md index b93de4dc1..2cd6bd5cb 100644 --- a/docs/archive/archive-other.md +++ b/docs/archive/archive-other.md @@ -70,13 +70,13 @@ Go-cqhttp 的开发者已无力维护项目（见 [go-cqhttp/issue#2471](https:/ 配置签名服务 -- 服务 url：你要链接的 qsign url +- 服务 URL：你要链接的 qsign URL - 服务 key：密码 - 服务鉴权：默认为空，如果有的服务器要求特定的鉴权，就填上吧 ::: tip 提示：默认的 qsign 配置 -没有特殊设置的话，qsign 的 url 通常默认为 `http://localhost:13579`，key 通常默认为 `114514`。 +没有特殊设置的话，qsign 的 URL 通常默认为 `http://localhost:13579`，key 通常默认为 `114514`。 ::: @@ -104,7 +104,7 @@ Go-cqhttp 的开发者已无力维护项目（见 [go-cqhttp/issue#2471](https:/ 参阅 qsign 提供的完整教程，看 [这里](https://github.com/fuqiuluo/unidbg-fetch-qsign/wiki/%E9%83%A8%E7%BD%B2%E5%9C%A8Linux)。 -== MacOS +== macOS 可以尝试使用 [AutoQSignForMac](https://github.com/Verplitic/AutoQSignForMac)。 @@ -140,7 +140,7 @@ Go-cqhttp 的开发者已无力维护项目（见 [go-cqhttp/issue#2471](https:/ ![选择简易配置](./images/qsign-select.png) -服务 url 填你的 qsign 服务地址。 +服务 URL 填你的 qsign 服务地址。 服务 key 填你的 qsign 服务密码，没有可以不填。 @@ -297,7 +297,7 @@ Shamrock 已于 2024 年 4 月 20 日归档，将不再进行更新。 ::: info Shamrock -[Shamrock](https://whitechi73.github.io/OpenShamrock/) 是一个基于 [LSPosed](https://github.com/LSPosed/LSPosed)/Xposed 框架，实现劫持 QQ 以对外暴露 Onebot Api 的软件。你可以在 Android 手机/模拟器中使用 Shamrock 代替已经停止开发的 gocq。 +[Shamrock](https://whitechi73.github.io/OpenShamrock/) 是一个基于 [LSPosed](https://github.com/LSPosed/LSPosed)/Xposed 框架，实现劫持 QQ 以对外暴露 Onebot API 的软件。你可以在 Android 手机/模拟器中使用 Shamrock 代替已经停止开发的 gocq。 遗憾的是，Shamrock 的使用依赖于 Android 的 root 权限，而手机厂商对 root 管控愈加严格，实体手机获取 root 权限的门槛很高，而模拟器中使用 Shamrock 的效果也不是很可观。因此，这种解决方案适合个人与朋友使用骰子的场景。 diff --git a/docs/archive/archive-terms.md b/docs/archive/archive-terms.md index d932b17ea..14ebe2831 100644 --- a/docs/archive/archive-terms.md +++ b/docs/archive/archive-terms.md @@ -32,7 +32,7 @@ title: 名词/术语速查表 ### CQ 码 -CQ 码是酷 Q （CoolQ） 时代定义的一套接口语言，方便用户快速编写指定类型 QQ 消息。可以参考 [这个页面](https://docs.go-cqhttp.org/cqcode) 进行编写。 +CQ 码是酷 Q（CoolQ）时代定义的一套接口语言，方便用户快速编写指定类型 QQ 消息。可以参考 [这个页面](https://docs.go-cqhttp.org/cqcode) 进行编写。 ## D @@ -112,9 +112,9 @@ JSON 是一种 [数据序列化语言](#数据序列化语言)。语法入门可 ### Lagrange -Lagrange（拉格兰）是一个 [NTQQ](#ntqq) 协议相关的开源项目。其包括目前实现了 [Linux](#linux) NTQQ 协议的 Lagrange.Core，和提供 OneBot-V11 Api 的 Lagrange.Onebot 两部分。 +Lagrange（拉格兰）是一个 [NTQQ](#ntqq) 协议相关的开源项目。其包括目前实现了 [Linux](#linux) NTQQ 协议的 Lagrange.Core，和提供 OneBot-V11 API 的 Lagrange.Onebot 两部分。 -Lagrange 可以很方便的在多个平台（Windows、Linux、Mac）部署，海豹核心可以对接其提供的 OneBot-V11 Api 来提供 QQ 骰子服务。 +Lagrange 可以很方便的在多个平台（Windows、Linux、Mac）部署，海豹核心可以对接其提供的 OneBot-V11 API 来提供 QQ 骰子服务。 可以参考 [连接平台 - QQ](../deploy/platform-qq) 中 [有关的部分](../deploy/platform-qq#Lagrange) 和 Lagrange 的官方 [GitHub 页面](https://github.com/LagrangeDev/Lagrange.Core)。 @@ -238,7 +238,7 @@ UI 即「用户界面（User Interface）」，通常指用户与程序发生交 > Windows 终端是一个为命令行用户准备的全新的、现代的、功能丰富的生产力 [终端](#终端)。它包含了 Windows 命令行社区经常希望加入的新功能，例如标签页、富文本、全球化、可配置性和主题与风格化等等。 -如果你在 Windows 「开始菜单」的搜素功能中，输入「终端」后并没有出现如上所示的图标。那么强烈建议你下载并安装 Windows 终端，而不是继续使用 [命令提示符](#命令提示符) 集成的 [控制台](#控制台)。 +如果你在 Windows「开始菜单」的搜素功能中，输入「终端」后并没有出现如上所示的图标。那么强烈建议你下载并安装 Windows 终端，而不是继续使用 [命令提示符](#命令提示符) 集成的 [控制台](#控制台)。 如果你发现你在启动海豹核心、[Lagrange](#lagrange) 或 [NapCatQQ](#napcatqq) 等程序时，弹出窗口的字体与风格都不属于 Windows 终端，那么强烈建议你在 Windows 终端中手动启动这些程序。 diff --git a/docs/config/custom_text.md b/docs/config/custom_text.md index a7b86d718..a0013591f 100644 --- a/docs/config/custom_text.md +++ b/docs/config/custom_text.md @@ -52,12 +52,14 @@ title: 自定义文案 ::: info 示例 + + ::: diff --git a/docs/config/reply.md b/docs/config/reply.md index b4b9f7c52..d818a4e99 100644 --- a/docs/config/reply.md +++ b/docs/config/reply.md @@ -21,10 +21,12 @@ title: 自定义回复 ::: info 示例 + + ::: @@ -138,7 +140,9 @@ title: 自定义回复 - 前缀匹配：消息以内容为开头时触发； - 后缀匹配：消息以此内容为结尾时触发。 + :::: info 「任意相符」示例 + 设置：任意相符，文本 `a|b`，回复 `c`。 @@ -146,35 +150,45 @@ title: 自定义回复 == 输入：a + + == 输入：b + + == 输入：ab（不回复） + + == 输入：a|b（不回复） + + == 输入：其它（不回复） + + ::: diff --git a/docs/deploy/db-repair.md b/docs/deploy/db-repair.md index bba4e3c89..ef73d7c7e 100644 --- a/docs/deploy/db-repair.md +++ b/docs/deploy/db-repair.md @@ -85,11 +85,11 @@ pause ## 修复数据库 - 通过数据库修复指令 -如果你熟悉 Sqlite 3，或者没有可用的备份文件，尝试以下方案。 +如果你熟悉 SQLite 3，或者没有可用的备份文件，尝试以下方案。 这种办法有一定的操作难度，酌情进行使用。这里我们以 Windows 系统为例。 -首先，你需要安装或下载一个 Sqlite 3 程序。 +首先，你需要安装或下载一个 SQLite 3 程序。 你可以从其[官网下载页](https://www.sqlite.org/download.html)，找到 Precompiled Binaries for Windows，下载其中的 sqlite-tools。确保你下载的是 3.40 以上版本，通常来说，直接下载最新版即可。 diff --git a/docs/deploy/platform-minecraft.md b/docs/deploy/platform-minecraft.md index d59e1bd72..b2507b219 100644 --- a/docs/deploy/platform-minecraft.md +++ b/docs/deploy/platform-minecraft.md @@ -145,7 +145,7 @@ eula=true # 请把该项修改为 true ![SealDice UI](./images/platform-minecraft_4.jpg) -Url 的填写请根据下列情况选择： +URL 的填写请根据下列情况选择： :::: tabs diff --git a/docs/deploy/platform-qq-official.md b/docs/deploy/platform-qq-official.md index e53e7823c..3ce26ed10 100644 --- a/docs/deploy/platform-qq-official.md +++ b/docs/deploy/platform-qq-official.md @@ -21,7 +21,7 @@ QQ 官方目前已开放了机器人功能，可进入 [QQ 开放平台](https:/ 目前， **QQ 官方机器人已开放个体使用权限。但官方文档没有及时更新**。 -同时，由于 QQ 官方对机器人能力的严格限制（包括获取 QQ 号、昵称，非 @ 时响应，私聊，群控、发送本地图片等大量功能目前不支持），目前**对接官方接口的骰子很多功能无法支持**（如跑团 Log ，暗骰，对抗等）。 +同时，由于 QQ 官方对机器人能力的严格限制（包括获取 QQ 号、昵称，非 @ 时响应，私聊，群控、发送本地图片等大量功能目前不支持），目前**对接官方接口的骰子很多功能无法支持**（如跑团 Log，暗骰，对抗等）。 QQ 官方机器人的优点，就是不用担心被风控。 @@ -41,7 +41,7 @@ QQ 官方机器人的优点，就是不用担心被风控。 切换到开发设置 -在页面中你可以看到这样的信息，其中「机器人 ID 」「机器人令牌」「机器人密钥」这三项是海豹进行连接所需要的。 +在页面中你可以看到这样的信息，其中「机器人 ID」「机器人令牌」「机器人密钥」这三项是海豹进行连接所需要的。 ![开发设置](./images/platform-qq-official-2.png) @@ -92,7 +92,9 @@ QQ 官方机器人的优点，就是不用担心被风控。 配置完成后，点击「发布配置」页面，上传「自测报告」与「隐私协议」。 + ::: details 「隐私协议」与「自测报告」模板 + 这里提供了海豹骰的机器人「隐私协议」与「自测报告」模版。 diff --git a/docs/deploy/platform-qq.md b/docs/deploy/platform-qq.md index f87f9f7bb..49a6a5780 100644 --- a/docs/deploy/platform-qq.md +++ b/docs/deploy/platform-qq.md @@ -129,7 +129,7 @@ Windows Server 2012 可能会缺少部分运行库，需要自行下载安装。 ::: -使用此方法你可能需要对「QQ(onebot11正向WS)」、「QQ(onebot11正向WS)」、「QQ(onebot11正向WS)」、「[WIP]Satori」的区别有一定了解。 +使用此方法你可能需要对「QQ(onebot11正向WS)」、「QQ(onebot11反向WS)」、「[WIP]Satori」的区别有一定了解。 「QQ(onebot11正向WS)」遵循 onebot11 标准，由海豹核心主动连接 QQ 登录框架。在 UI 界面添加「连接地址」格式应当为 `ws://{Host}:{Port}`。 diff --git a/docs/deploy/platform-slack.md b/docs/deploy/platform-slack.md index 5bd9de142..a6ff9b1a7 100644 --- a/docs/deploy/platform-slack.md +++ b/docs/deploy/platform-slack.md @@ -17,7 +17,7 @@ title: Slack ## 获取 Token -要获取用于连接海豹的 Token 之前，你需要建立好一个应用。登录 [Slack Api 平台](https://api.slack.com/apps)，点击「Create New App」，再点击「From Scratch」。按照要求填写应用名字，并选择你想要海豹被部署到的工作区后点击「Create App」。 +要获取用于连接海豹的 Token 之前，你需要建立好一个应用。登录 [Slack API 平台](https://api.slack.com/apps)，点击「Create New App」，再点击「From Scratch」。按照要求填写应用名字，并选择你想要海豹被部署到的工作区后点击「Create App」。 ::: tip 提示：私骰模式 @@ -43,7 +43,7 @@ Slack 平台的机制使没有公开发布的应用无法加入被指定的单 ### Bot Token -在侧边栏点击「OAuth & Permissions」，下滑在「Bot Token Scopes」下，添加海豹运作需要的权限: +在侧边栏点击「OAuth & Permissions」，下滑在「Bot Token Scopes」下，添加海豹运作需要的权限： 1. `channels:history` 1. `channels:read` diff --git a/docs/deploy/quick-start.md b/docs/deploy/quick-start.md index 547c0fbdb..338c5bfb6 100644 --- a/docs/deploy/quick-start.md +++ b/docs/deploy/quick-start.md @@ -37,7 +37,7 @@ title: 快速开始 - Linux: 提供给更专业的用户使用，需要使用终端启动。适用于服务器、树莓派等设备。 - x64：绝大多数使用 Intel 或 AMD CPU 的服务器都应使用此版本。 - arm64：树莓派等 arm 设备请使用 arm64 版。 -- MacOS：提供给 Mac 用户使用，需要使用终端启动。 +- macOS：提供给 Mac 用户使用，需要使用终端启动。 - arm64：Apple Silicon 芯片（M1、M2 等）请使用 arm64 版。 - x64：Intel 芯片请使用 x64 版。 - Docker：提供对应 Docker 镜像，支持多种架构。 @@ -75,7 +75,7 @@ chmod +x ./sealdice-core 给予其足够的运行权限。随后，运行 `./sealdice-core` 来启动海豹。在浏览器中输入 `localhost:3211` 来访问后台（WebUI）。 -== MacOS +== macOS 在 `sealdice-core` 所在的目录启动终端，输入以下命令： @@ -88,10 +88,10 @@ chmod +x ./lagrange/Lagrange.OneBot && xattr -rd com.apple.quarantine ./lagrange 随后，运行 `./sealdice-core` 来启动海豹。在浏览器中输入 `localhost:3211` 来访问后台（WebUI）。 -::: info MacOS 启动海豹失败问题排查 +::: info macOS 启动海豹失败问题排查 1. 启动时若出现 `Bad CPU type in executable`，请确认你是否下载的是正确版本的海豹。**Intel 芯片的 Mac 请下载 `darwin x64` ，Apple Silicon 芯片请下载 `darwin arm64`。** -2. 请确认 MacOS 版本高于 10.12，低版本 MacOS 不支持运行，建议尽量将 MacOS 更新至最新稳定版本。 +2. 请确认 macOS 版本高于 10.12，低版本 macOS 不支持运行，建议尽量将 macOS 更新至最新稳定版本。 ::: diff --git a/docs/deploy/special_feature.md b/docs/deploy/special_feature.md index b758450e4..aba643dc8 100644 --- a/docs/deploy/special_feature.md +++ b/docs/deploy/special_feature.md @@ -59,17 +59,21 @@ title: 特色功能 == .gugu + + == 查看鸽子背后的故事 + + ::: @@ -117,6 +121,7 @@ title: 特色功能 ::: info 示例 + + ::: diff --git a/docs/use/coc7.md b/docs/use/coc7.md index 015318365..cadf75a04 100644 --- a/docs/use/coc7.md +++ b/docs/use/coc7.md @@ -69,12 +69,14 @@ title: 克苏鲁的呼唤 7 版 ::: info 示例 + + ::: @@ -90,6 +92,7 @@ title: 克苏鲁的呼唤 7 版 ::: info 示例 + + ::: @@ -125,6 +129,7 @@ rc 是规则书检定。而 ra 是房规检定。区别主要在于对大成功/ 假设角色的侦查技能是40 + + ::: @@ -144,10 +150,12 @@ rc 是规则书检定。而 ra 是房规检定。区别主要在于对大成功/ ::: info 示例 + + ::: @@ -161,10 +169,12 @@ rc 是规则书检定。而 ra 是房规检定。区别主要在于对大成功/ 假设角色的侦查技能是40 + + ::: @@ -176,10 +186,12 @@ rc 是规则书检定。而 ra 是房规检定。区别主要在于对大成功/ ::: info 示例 + + ::: @@ -191,10 +203,12 @@ rc 是规则书检定。而 ra 是房规检定。区别主要在于对大成功/ 假定 Szz 的侦查技能是80 + + ::: @@ -202,10 +216,12 @@ rc 是规则书检定。而 ra 是房规检定。区别主要在于对大成功/ ::: info 示例 + + ::: @@ -233,18 +249,22 @@ rc 是规则书检定。而 ra 是房规检定。区别主要在于对大成功/ == 跑团群 + + == KP 收到的私聊信息 + + ::: @@ -273,10 +293,12 @@ rc 是规则书检定。而 ra 是房规检定。区别主要在于对大成功/ ::: info 示例 + + ::: @@ -288,10 +310,12 @@ rc 是规则书检定。而 ra 是房规检定。区别主要在于对大成功/ ::: info 示例 + + ::: @@ -315,10 +339,12 @@ rc 是规则书检定。而 ra 是房规检定。区别主要在于对大成功/ ::: info 示例 + + ::: @@ -340,10 +366,12 @@ rc 是规则书检定。而 ra 是房规检定。区别主要在于对大成功/ ::: info 示例 + + ::: @@ -421,10 +449,12 @@ rc 是规则书检定。而 ra 是房规检定。区别主要在于对大成功/ ::: info 示例 + + ::: diff --git a/docs/use/core.md b/docs/use/core.md index e80bd1ac5..2657a90a6 100644 --- a/docs/use/core.md +++ b/docs/use/core.md @@ -81,6 +81,7 @@ title: 核心指令 ::: info 示例 + + ::: @@ -108,6 +110,7 @@ title: 核心指令 ::: info 示例 + + ::: @@ -147,6 +151,7 @@ title: 核心指令 ::: info 示例 + + ::: @@ -170,10 +176,12 @@ title: 核心指令 ::: info 示例 + + ::: @@ -185,10 +193,12 @@ title: 核心指令 此时木落的侦查技能点是 53 + + ::: @@ -198,6 +208,7 @@ CoC 规则中，对于百分骰的一种补偿骰法，通过额外骰一定数 ::: info 示例 + + ::: @@ -215,6 +227,7 @@ D&D 规则中对 20 面骰的一种补偿骰法。额外骰一次，取较高或 ::: info 示例 + + ::: @@ -230,12 +244,14 @@ D&D 规则中对 20 面骰的一种补偿骰法。额外骰一次，取较高或 ::: info 示例 + + ::: @@ -247,35 +263,43 @@ D&D 规则中对 20 面骰的一种补偿骰法。额外骰一次，取较高或 == 优势骰 + + == 劣势骰 + + == 排除低值 骰 4 个排除 1 个最低值： + + == 排除高值 骰 4 个排除 1 个最高值： + + ::: @@ -293,17 +317,21 @@ D&D 规则中对 20 面骰的一种补偿骰法。额外骰一次，取较高或 == 一般使用 + + == 带补正的情况 + + ::: @@ -325,12 +353,14 @@ WOD 骰点规则是一个多轮骰点规则，国内多见于无限团。 ::: info 示例 + + ::: @@ -342,10 +372,12 @@ WOD 骰点规则是一个多轮骰点规则，国内多见于无限团。 ::: info 示例 + + ::: @@ -365,10 +397,12 @@ WOD 骰点规则是一个多轮骰点规则，国内多见于无限团。 ::: info 示例 + + ::: @@ -380,6 +414,7 @@ WOD 骰点规则是一个多轮骰点规则，国内多见于无限团。 ::: info 示例 + + ::: @@ -395,12 +431,14 @@ WOD 骰点规则是一个多轮骰点规则，国内多见于无限团。 ::: info 示例 + + ::: @@ -424,16 +462,20 @@ WOD 骰点规则是一个多轮骰点规则，国内多见于无限团。 == 群聊 + + == 收到的私聊 + + ::: @@ -449,12 +491,14 @@ WOD 骰点规则是一个多轮骰点规则，国内多见于无限团。 此时木落的侦查是 75，Szz 的侦查是 80 + + ::: @@ -470,6 +514,7 @@ WOD 骰点规则是一个多轮骰点规则，国内多见于无限团。 ::: info 示例 + + ::: @@ -543,6 +589,7 @@ WOD 骰点规则是一个多轮骰点规则，国内多见于无限团。 ::: info 示例 + + ::: @@ -560,10 +608,12 @@ WOD 骰点规则是一个多轮骰点规则，国内多见于无限团。 ::: info 示例 + + ::: @@ -571,10 +621,12 @@ WOD 骰点规则是一个多轮骰点规则，国内多见于无限团。 ::: info 示例 + + ::: @@ -588,10 +640,12 @@ WOD 骰点规则是一个多轮骰点规则，国内多见于无限团。 ::: info 示例 + + ::: @@ -633,6 +687,7 @@ D&D 系列资料的整理者主要为 DicePP 项目组成员，包括**Farevell* ::: info 示例 + + ::: diff --git a/docs/use/deck_and_reply.md b/docs/use/deck_and_reply.md index b2655b8ff..b965c7e66 100644 --- a/docs/use/deck_and_reply.md +++ b/docs/use/deck_and_reply.md @@ -35,6 +35,7 @@ title: 牌堆 自定义回复 ::: info 示例 + + ::: - + 需要说明，在以上的例子中，「GRE单词」同时是牌堆名与牌组名。在 `.draw keys GRE单词` 中，它作为牌堆名出现；在 `.draw desc GRE单词` 中，它作为牌组名出现。 @@ -66,12 +68,14 @@ title: 牌堆 自定义回复 ::: info 示例 + + ::: @@ -79,10 +83,12 @@ title: 牌堆 自定义回复 ::: info 示例 + + ::: diff --git a/docs/use/dnd5e.md b/docs/use/dnd5e.md index 401fe34c3..5663ff341 100644 --- a/docs/use/dnd5e.md +++ b/docs/use/dnd5e.md @@ -29,12 +29,14 @@ title: 龙与地下城 5E ::: info 示例 + + ::: @@ -53,6 +55,7 @@ title: 龙与地下城 5E ::: info 示例 + + ::: @@ -88,6 +92,7 @@ title: 龙与地下城 5E 已经设置了先攻列表的情况 + + ::: @@ -135,6 +141,7 @@ title: 龙与地下城 5E ::: info 示例 + + ::: @@ -159,10 +167,12 @@ title: 龙与地下城 5E - 当生命值归零，若伤害小于血量上限，人物昏迷； - 当人物已经昏迷，不足致死的伤害自动折算为死亡豁免失败。 + + ::: @@ -188,6 +198,7 @@ title: 龙与地下城 5E ::: info 示例 + + ::: @@ -209,12 +221,14 @@ title: 龙与地下城 5E ::: info 示例 + + ::: @@ -236,6 +250,7 @@ title: 龙与地下城 5E ::: info 示例 + + ::: @@ -251,6 +267,7 @@ title: 龙与地下城 5E ::: info 示例 + + ::: @@ -266,6 +284,7 @@ title: 龙与地下城 5E ::: info 示例 + + ::: @@ -281,12 +301,14 @@ title: 龙与地下城 5E ::: info 示例 + + ::: @@ -314,6 +336,7 @@ title: 龙与地下城 5E ::: info 示例 + + ::: @@ -339,10 +363,12 @@ title: 龙与地下城 5E ::: info 示例 + + ::: @@ -356,12 +382,14 @@ title: 龙与地下城 5E ::: info 示例 + + ::: @@ -385,30 +413,38 @@ st 指令对 hp 的操作也会自动触发死亡豁免。 ::: info 示例 + + 昏迷后被攻击： + + 死亡： + + 医学奇迹： + + ::: diff --git a/docs/use/faq.md b/docs/use/faq.md index 51593ad89..0400d0b77 100644 --- a/docs/use/faq.md +++ b/docs/use/faq.md @@ -104,7 +104,7 @@ title: 常见问题 ```text http/socks5简易工具©sealdice.com 将在服务器上开启一个 socks5 服务，端口 13325，默认持续时长为 25 分钟 - 将在服务器上开启一个 http 代理服务，端口 13326，默认持续时长为 25 分钟 + 将在服务器上开启一个 HTTP 代理服务，端口 13326，默认持续时长为 25 分钟 可能的公网 IP: 12.34.56.78 请于服务器管理面板放行你要用的端口 (一般为 13325 即 socks)，协议 TCP diff --git a/docs/use/fun.md b/docs/use/fun.md index 1874e5805..4b2357818 100644 --- a/docs/use/fun.md +++ b/docs/use/fun.md @@ -25,10 +25,12 @@ title: 功能 ::: info 示例 + + ::: @@ -36,10 +38,12 @@ title: 功能 ::: info 示例 + + ::: @@ -49,10 +53,12 @@ title: 功能 ::: info 示例 + + ::: @@ -68,6 +74,7 @@ title: 功能 ::: info 示例 + + ::: @@ -89,10 +97,12 @@ title: 功能 ::: info 示例 + + ::: @@ -110,15 +120,19 @@ title: 功能 == 群聊 + + == Master 收到的消息 + + ::: @@ -134,17 +148,21 @@ Master 可以通过这个指令进行回复。目标 ID 可以是群号，也可 == Master 回复 + + == 群聊 + + ::: @@ -181,11 +199,13 @@ Master 可以通过这个指令进行回复。目标 ID 可以是群号，也可 == 频道私聊 + + ::: tip @@ -197,16 +217,20 @@ Master 可以通过这个指令进行回复。目标 ID 可以是群号，也可 ::: + + == 频道公屏 + + :::: @@ -243,12 +267,14 @@ Master 可以通过这个指令进行回复。目标 ID 可以是群号，也可 == 私聊 + + ::: @@ -264,10 +290,12 @@ Master 可以通过这个指令进行回复。目标 ID 可以是群号，也可 ::: info 示例 + + ::: @@ -277,6 +305,7 @@ Master 可以通过这个指令进行回复。目标 ID 可以是群号，也可 ::: info 示例 + + ::: diff --git a/docs/use/story.md b/docs/use/story.md index 60232a500..ce8703521 100644 --- a/docs/use/story.md +++ b/docs/use/story.md @@ -47,10 +47,12 @@ title: 故事 ::: info 示例 + + ::: From 336117d27fa0e1db2f076d9f435ecaa168abbff2 Mon Sep 17 00:00:00 2001 From: Xiangze Li Date: Sat, 12 Oct 2024 10:23:14 +0800 Subject: [PATCH 2/2] =?UTF-8?q?build:=20=E9=9B=86=E6=88=90=20AutoCorrect?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 24 +++++++++++++++----- package.json | 7 ++++-- pnpm-lock.yaml | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 85 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index cf86826ce..8fe8c7bc5 100644 --- a/README.md +++ b/README.md @@ -10,23 +10,37 @@ VitePress 驱动的海豹骰官方使用手册。 如需调整导航栏和侧边栏，则涉及到修改 `docs/.vitepress/theme.ts` 和 `docs/.vitepress/catalogue.ts` 中的配置。 -## Lint +## 安装依赖 -提交前请务必使用 markdownlint 进行检查，不满足格式要求的修改无法合并入主仓库。 +编写文档原则上不需要安装任何依赖。但是，如果希望利用 linter 自检或本地运行预览效果，则需要执行以下指令安装依赖。 ```shell pnpm install +``` + +## MarkDown 格式规范 + +提交前请务必使用 markdownlint 进行检查，不满足格式要求的修改无法合并入主仓库。 + +```shell pnpm run lint:md -pnpm run lint:md:fix // 检查并进行部分自动修复 +pnpm run lint:md:fix # 检查并进行部分自动修复 ``` 对于 VS Code 用户，请使用 [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) 插件获取编辑器警告。这一插件已经被添加到本项目的推荐插件中，只需在打开本项目时按 VS Code 的提示安装即可。 -## 排版 +## 排版规范 文档排版应当遵循 [中文文案排版指北](https://github.com/sparanoid/chinese-copywriting-guidelines) 的规范。 -使用 AutoCorrect 插件可以提供相关帮助。 +项目集成了自动检查和修复插件，可以通过以下指令调用。 + +```shell +pnpm run lint:autocorrect +pnpm run lint:autocorrect:fix # 检查并进行部分自动修复 +``` + +使用 AutoCorrect 插件可以提供编辑器集成的提示，但确有观察到编辑器插件不识别配置文件造成假阳性报告的问题。 - [VS Code](https://marketplace.visualstudio.com/items?itemName=huacnlee.autocorrect) - [JetBrains](https://plugins.jetbrains.com/plugin/20244-autocorrect) diff --git a/package.json b/package.json index 551a43279..f1cf81e05 100644 --- a/package.json +++ b/package.json @@ -8,13 +8,16 @@ "docs:build": "vitepress build docs", "docs:preview": "vitepress preview docs", "lint:md": "markdownlint-cli2 \"**/*.md\" \"#node_modules\"", - "lint:md:fix": "markdownlint-cli2 \"**/*.md\" \"#node_modules\" --fix" + "lint:md:fix": "markdownlint-cli2 \"**/*.md\" \"#node_modules\" --fix", + "lint:autocorrect": "autocorrect --lint", + "lint:autocorrect:fix": "autocorrect --fix" }, "keywords": [], "author": "Sealdice Team", "license": "MIT", "devDependencies": { "markdownlint-cli2": "^0.14.0", + "autocorrect-node": "^2.11.1", "mermaid": "^11.3.0", "sass": "^1.79.4", "vitepress": "^1.3.4", @@ -29,4 +32,4 @@ "dayjs": "^1.11.13", "debug": "^4.3.7" } -} \ No newline at end of file +} diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 4f0bec3a2..1b460e043 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -24,6 +24,9 @@ importers: specifier: ^4.3.7 version: 4.3.7 devDependencies: + autocorrect-node: + specifier: ^2.11.1 + version: 2.11.1 markdownlint-cli2: specifier: ^0.14.0 version: 0.14.0 @@ -580,6 +583,41 @@ packages: argparse@2.0.1: resolution: {integrity: sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==} + autocorrect-node-darwin-arm64@2.11.1: + resolution: {integrity: sha512-7VdYsMAbJuLVHXPM6hv9+Sds91VX55DaMjiVvC6/p/orAg3pIy1wnk2JfJ0GKouKbkOKBp1fT2XFCJXVPBdh5w==} + engines: {node: '>= 10'} + cpu: [arm64] + os: [darwin] + + autocorrect-node-darwin-x64@2.11.1: + resolution: {integrity: sha512-oHiIq+RQm70DfgliW2W5/J8i7ov2cZyyK6l73fHxKOUzwVi7CSxMV6CHnthOZ7yUA07Y2QlFqVyYYPYbMykavA==} + engines: {node: '>= 10'} + cpu: [x64] + os: [darwin] + + autocorrect-node-linux-x64-gnu@2.11.1: + resolution: {integrity: sha512-qWFiur7vXgnMLQ0zLpJ+ZRpBg23FQY0UrWIXgv+5uSVgPIUcDWa78FVpSDVmeWelpP3XTJ4ljUQuuXdok8oQEA==} + engines: {node: '>= 10'} + cpu: [x64] + os: [linux] + + autocorrect-node-linux-x64-musl@2.11.1: + resolution: {integrity: sha512-Hml5ZRdZMqpeM1p/j7TVy6xdv0+I5yxpRBAMCIkYJp6Le/NIz9EkEP9eYFxHOwdL+MexXvOd/1xSeHEjUL6JDw==} + engines: {node: '>= 10'} + cpu: [x64] + os: [linux] + + autocorrect-node-win32-x64-msvc@2.11.1: + resolution: {integrity: sha512-1Cx2iI0eVz/tLyjnkaDx0uH+fXMRxV16tEjbnX0mWPV+LVp2KM5zqYYuzsSkm6f9O6dOFWGUn0ybKZ4QpZb/Dg==} + engines: {node: '>= 10'} + cpu: [x64] + os: [win32] + + autocorrect-node@2.11.1: + resolution: {integrity: sha512-xalvvRcynT9BEKCq05SinOkaoINtmkqWk8qHQMh/R6ZA962we3W+zv1I4Qx6Ac3CcegSbGoJgCcYM59ZABhBNQ==} + engines: {node: '>= 10'} + hasBin: true + birpc@0.2.17: resolution: {integrity: sha512-+hkTxhot+dWsLpp3gia5AkVHIsKlZybNT5gIYiDlNzJrmYPcTM9k5/w2uaj3IPpd7LlEYpmCj4Jj1nC41VhDFg==} @@ -1821,6 +1859,29 @@ snapshots: argparse@2.0.1: {} + autocorrect-node-darwin-arm64@2.11.1: + optional: true + + autocorrect-node-darwin-x64@2.11.1: + optional: true + + autocorrect-node-linux-x64-gnu@2.11.1: + optional: true + + autocorrect-node-linux-x64-musl@2.11.1: + optional: true + + autocorrect-node-win32-x64-msvc@2.11.1: + optional: true + + autocorrect-node@2.11.1: + optionalDependencies: + autocorrect-node-darwin-arm64: 2.11.1 + autocorrect-node-darwin-x64: 2.11.1 + autocorrect-node-linux-x64-gnu: 2.11.1 + autocorrect-node-linux-x64-musl: 2.11.1 + autocorrect-node-win32-x64-msvc: 2.11.1 + birpc@0.2.17: {} braces@3.0.3: