docs: 完善 README.md，规范化部分简称 (#12)

sealdice · Oct 25, 2023 · fca27da · fca27da
1 parent 58ca2f7
commit fca27da
Show file tree

Hide file tree

Showing 8 changed files with 55 additions and 28 deletions.
diff --git a/README.MD b/README.MD
@@ -1,3 +1,28 @@
 # sealdice-manual-next
 
-海豹骰全新官方文档。
+Vuepress2 驱动的海豹骰全新官方文档。
+
+## 编写
+
+文档写在 `docs` 下的 `.md` 文件中，按文件夹分组。
+
+如需调整导航栏和侧边栏，需要修改 `docs/.vuepress/navbar.ts` 和 `docs/.vuepress/sidebar.ts` 中的配置。
+
+## 排版
+
+文档排版应当遵循 [中文文案排版指北](https://github.com/sparanoid/chinese-copywriting-guidelines) 的规范。
+
+## 本地调试
+
+```bash
+pnpm install
+pnpm run docs:dev
+```
+
+运行以上命令启动本地文档服务便于调试。
+
+## Vuepress2 和 Markdown 扩展
+
+文档使用 Vuepress2 驱动，文档见 [Vuepress2 文档](https://v2.vuepress.vuejs.org/zh/)。
+
+同时使用了 `vuepress-plugin-md-enhance` 插件为 Markdown 提供更多扩展语法，文档见 [vuepress-plugin-md-enhance 文档](https://plugin-md-enhance.vuejs.press/zh/guide)。
diff --git a/docs/advanced/edit_jsscript.md b/docs/advanced/edit_jsscript.md
@@ -1,13 +1,13 @@
 ---
 lang: zh-cn
-title: 编写 JS 插件
+title: 编写 JavaScript 插件
 ---
 
-# 编写 JS 插件
+# 编写 JavaScript 插件
 
 ::: info 本节内容
 
-本节将介绍 JS 脚本的编写，请善用侧边栏和搜索，按需阅读文档。
+本节将介绍 JavaScript 脚本的编写，请善用侧边栏和搜索，按需阅读文档。
 
 :::
 
@@ -44,7 +44,7 @@ vscode相比于记事本的优势：
 
 （已经有了，名为[Sealdice Snippets](https://marketplace.visualstudio.com/items?itemName=yxChangingSelf.sealdice-snippets)，在vscode的扩展商店就能找到并直接安装，提供了一些常见代码片段，可以快速生成模板代码）
 
-## 1.创建一个JS扩展
+## 1.创建一个 JS 扩展
 
 你可以选择使用JavaScript或者Typescript来作为你的编写语言。
 

diff --git a/docs/config/custom_text.md b/docs/config/custom_text.md
@@ -33,7 +33,7 @@ title: 自定义文案
 
 左侧是分类，可以看见，文案目前被分为以下几个大类：
 
-- COC：内置的 COC 支持相关的文案；
+- CoC：内置的 CoC 支持相关的文案；
 - DND：内置的 DND 支持相关的文案；
 - 其它：一些杂项文案设置；
 - 娱乐：内置 [娱乐功能](../use/fun.md) 的相关文案，如 `.jrrp` 的文案；

diff --git a/docs/config/helpdoc.md b/docs/config/helpdoc.md
@@ -27,7 +27,7 @@ title: 帮助文档
 
 海豹目前可以健康食用的 helpdoc 格式为 `json` 以及 `xslx`，其中更多使用后者来编写资料查询文档。
 
-海豹官方安装包中也默认提供了 COC 和 DND 的资料查询文档，无需额外下载即可使用相关内容搜索。
+海豹官方安装包中也默认提供了 CoC 和 D&D 的资料查询文档，无需额外下载即可使用相关内容搜索。
 
 ## 如何使用帮助文档？
 
@@ -43,7 +43,7 @@ title: 帮助文档
 
 ![帮助文档管理](./images/helpdoc-ui.png)
 
-我们可以看到默认置入的 COC 与 DND 的资料文档已经在列表中展示出来了。
+我们可以看到默认置入的 CoC 与 D&D 的资料文档已经在列表中展示出来了。
 
 帮助文档列表以文件树的形式展示。文件夹内部的文档在一级文件夹下平铺展示，最外层的 **一级文件夹名将作为其中所有文档的分组名**，用于精确控制查询范围的分组。
 

diff --git a/docs/config/jsscript.md b/docs/config/jsscript.md
@@ -1,23 +1,23 @@
 ---
 lang: zh-cn
-title: JS 插件
+title: JavaScript 插件
 ---
 
-# JS 插件
+# JavaScript 插件
 
 ::: info 本节内容
 
 本节将介绍 JavaScript 插件功能，请善用侧边栏和搜索，按需阅读文档。
 
 :::
 
-## JS 插件是什么
+## JavaScript 插件是什么
 
 为了给有能力的用户提供更大的自定义空间，海豹核心支持使用 `JavaScript` 语言编写扩展插件。
 
 :::: tip JavaScript
 
-JavaScript（通常缩写为 JS）是一门基于原型和头等函数的多范式高级解释型编程语言，它支持面向对象程序设计、指令式编程和函数式编程。它提供方法来操控文本、数组、日期以及正则表达式等。
+JavaScript（JS）是一门基于原型和头等函数的多范式高级解释型编程语言，它支持面向对象程序设计、指令式编程和函数式编程。它提供方法来操控文本、数组、日期以及正则表达式等。
 
 ::: right
 —— [WIKI](https://zh.wikipedia.org/wiki/JavaScript)

diff --git a/docs/index.md b/docs/index.md
@@ -22,7 +22,7 @@ actions:
 
 ## 特性
 
-- 实现了跑团常用的绝大部分指令，且 COC、DND、SR、WOD 等规则都有专门支持；
+- 实现了跑团常用的绝大部分指令，且 CoC、D&D、SR、WOD 等规则都有专门支持；
 
 - 丰富的同义词表，兼容中文简体、繁体、英文缩写和其他常见别名；
 

diff --git a/docs/use/coc7.md b/docs/use/coc7.md
@@ -1,9 +1,9 @@
 ---
 lang: zh-cn
-title: 扩展：克苏鲁的呼唤7版
+title: 扩展：克苏鲁的呼唤 7 版
 ---
 
-# 扩展：克苏鲁的呼唤7版
+# 扩展：克苏鲁的呼唤 7 版
 
 ::: info 本节内容
 
@@ -15,7 +15,7 @@ title: 扩展：克苏鲁的呼唤7版
 
 ::: note 克苏鲁的呼唤
 
-**「克苏鲁的呼唤」** 是一个充满了秘密、神秘和恐怖的游戏。你将扮演一位坚定的侦探，奔波在奇怪而危险的场所之间，揭开邪恶的阴谋，对抗暗夜的恐怖。你将面对令人 SAN 值直葬（令人理智崩溃）的存在、怪物们，还有疯魔的邪教徒们。在被人遗忘的奇异书卷中，你会发现不应当为人类所知晓的秘密。
+**「克苏鲁的呼唤」**（Call of Cthulhu）是一个充满了秘密、神秘和恐怖的游戏。你将扮演一位坚定的侦探，奔波在奇怪而危险的场所之间，揭开邪恶的阴谋，对抗暗夜的恐怖。你将面对令人 SAN 值直葬（令人理智崩溃）的存在、怪物们，还有疯魔的邪教徒们。在被人遗忘的奇异书卷中，你会发现不应当为人类所知晓的秘密。
 
 :::
 
@@ -368,13 +368,13 @@ HP:11 幸运:55 [485/540]
 
 | 序号    | 规则                                                         |
 | ------- | ------------------------------------------------------------ |
-| 0(默认) | 出1大成功，不满50出96-100大失败，满50出100大失败(COC7规则书) |
-| 1       | 不满50出1大成功，不满50出96-100大失败，满50出100大失败       |
-| 2(常用) | 出1-5且判定成功为大成功，出96-100且判定失败为大失败          |
-| 3       | 出1-5大成功，出96-100大失败(即大成功/大失败时无视判定结果)   |
-| 4       | 出1-5且≤(成功率/10)为大成功，不满50出>=96+(成功率/10)为大失败，满50出100大失败 |
-| 5       | 出1-2且≤(成功率/5)为大成功，不满50出96-100大失败，满50出99-100大失败 |
-| dg      | 出1或检定成功基础上个位十位相同为大成功，出100或检定失败基础上个位十位相同为大失败，此规则无困难成功或极难成功 |
+| 0(默认) | 出 1 大成功，不满 50 出 96-100 大失败，满 50 出 100大失败(CoC7th规则书) |
+| 1       | 不满 50 出 1 大成功，不满 50 出 96-100 大失败，满 50 出 100 大失败       |
+| 2(常用) | 出 1-5 且判定成功为大成功，出96-100且判定失败为大失败          |
+| 3       | 出 1-5 大成功，出 96-100 大失败(即大成功/大失败时无视判定结果)   |
+| 4       | 出 1-5 且≤(成功率/10)为大成功，不满50出>=96+(成功率/10)为大失败，满50出100大失败 |
+| 5       | 出 1-2 且≤(成功率/5)为大成功，不满50出96-100大失败，满50出99-100大失败 |
+| dg      | 出 1 或检定成功基础上个位十位相同为大成功，出100或检定失败基础上个位十位相同为大失败，此规则无困难成功或极难成功 |
 
 ### 设定房规
 

diff --git a/docs/use/dnd5e.md b/docs/use/dnd5e.md
@@ -1,19 +1,21 @@
 ---
 lang: zh-cn
-title: 扩展：龙与地下城 
+title: 扩展：龙与地下城 5E
 ---
 
-# 扩展：龙与地下城 
+# 扩展：龙与地下城 5E
 
 ::: info 本节内容
 
-本节将展示 **DND 5e** 玩家所需指令，请善用侧边栏和搜索，按需阅读文档。
+本节将展示 **D&D 5E** 玩家所需指令，请善用侧边栏和搜索，按需阅读文档。
+
+我们假定读者已对 D&D 规则有适当了解，本节只涉及如何使用海豹核心完成规则中指定的操作。
 
 :::
 
 ::: note 龙与地下城
 
-**「龙与地下城」** 是一款剑与魔法奇幻背景的叙事性角色扮演游戏。与孩提时代的过家家扮演游戏相似，D&D 依靠的是玩家无穷的想象力。你所需要做的，即是描述场景如暴风骤雨里，夜空下的某座高耸古堡。然后想象奇幻世界中的冒险者们会如何迎接即将到来的挑战。
+**「龙与地下城」**（Dungeons & Dragons, D&D, DND）是一款剑与魔法奇幻背景的叙事性角色扮演游戏。与孩提时代的过家家扮演游戏相似，D&D 依靠的是玩家无穷的想象力。你所需要做的，即是描述场景如暴风骤雨里，夜空下的某座高耸古堡。然后想象奇幻世界中的冒险者们会如何迎接即将到来的挑战。
 
 :::
 
@@ -159,7 +161,7 @@ Dice:
 
 DND 的录卡，和属性操作指令。
 
-这个指令最好在关闭 COC 扩展时使用，如果一起用，可以使用`.dst`来规避指令冲突。
+这个指令最好在关闭 CoC 扩展时使用，如果一起用，可以使用`.dst`来规避指令冲突。
 
 目前支持技能调整值的自动计算，包括属性带来的加值，和熟练带来的加值。