From 8ca5c9e84d57cd48813de7203fa0947fd586962d Mon Sep 17 00:00:00 2001 From: Xiangze Li Date: Mon, 28 Oct 2024 09:24:13 +0800 Subject: [PATCH 1/2] fix: typo --- docs/advanced/edit_deck.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/advanced/edit_deck.md b/docs/advanced/edit_deck.md index 3cc0cc862..a753fb5b4 100644 --- a/docs/advanced/edit_deck.md +++ b/docs/advanced/edit_deck.md @@ -663,11 +663,11 @@ YAML 牌堆中的表示正好相反： ::: -假如牌堆文件内容如下（使用相对路径 `./asstes/...` ）： +假如牌堆文件内容如下（使用相对路径 `./assets/...` ）： ```json { - "test":["[图:./asstes/1.jpg]"] + "test":["[图:./assets/1.jpg]"] } ``` @@ -675,7 +675,7 @@ YAML 牌堆中的表示正好相反： ```text . -├─asstes +├─assets │ └─1.jpg └─ test.json ``` From 07bd2d4acc1e43bc9c9abe98ef41623f2c97f8f6 Mon Sep 17 00:00:00 2001 From: Xiangze Li Date: Mon, 28 Oct 2024 09:28:36 +0800 Subject: [PATCH 2/2] docs(README): update about formatting rules --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f389f8d60..032dd9249 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,9 @@ VitePress 驱动的海豹骰官方使用手册。 pnpm install ``` -## Markdown 格式规范 +## 规范和要求 + +### Markdown 格式规范 提交前请务必使用 markdownlint 进行检查，不满足格式要求的修改无法合并入主仓库。 @@ -29,9 +31,9 @@ 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) 的规范。 +文档排版应当遵循 [中文文案排版指北](https://github.com/sparanoid/chinese-copywriting-guidelines) 的规范，不满足格式要求的修改无法合并入主仓库。 项目集成了自动检查和修复插件，可以通过以下指令调用。 @@ -45,7 +47,7 @@ pnpm run lint:autocorrect:fix # 检查并进行部分自动修复 - [VS Code](https://marketplace.visualstudio.com/items?itemName=huacnlee.autocorrect) - [JetBrains](https://plugins.jetbrains.com/plugin/20244-autocorrect) -## 标注功能版本 +### 标注功能版本 对于新加入的功能，需要在标题和正文开头都注明加入的版本。 @@ -65,7 +67,7 @@ pnpm run lint:autocorrect:fix # 检查并进行部分自动修复 ![版本标签](README.assets/version_badge.png) -### 开发版中的新功能 +#### 开发版中的新功能 如果是为当前开发版中的新功能编写文档，而不能确定下一个正式版的版本号，使用以下标签： @@ -75,7 +77,7 @@ pnpm run lint:autocorrect:fix # 检查并进行部分自动修复 这样做的好处是：在确定版本号后，方便通过文本替换批量修改。 -## 归档警告 +### 归档警告 对于弃用的功能，需要在正文开头注明弃用的版本和归档的时间。 @@ -91,7 +93,7 @@ pnpm run lint:autocorrect:fix # 检查并进行部分自动修复 ![归档警告](README.assets/archieve_exanple.png) -### 开发版中弃用的功能 +#### 开发版中弃用的功能 对于在当前开发版中弃用，即将于下一个正式版中去除的功能，**不要**在正式版发布前移动原始文本。