Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: typos #289

Merged
merged 2 commits into from
Oct 28, 2024
Merged

fix: typos #289

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8ca5c9e
fix: typo
Xiangze-Li Oct 28, 2024
07bd2d4
docs(README): update about formatting rules
Xiangze-Li Oct 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ VitePress 驱动的海豹骰官方使用手册。
pnpm install
```

## Markdown 格式规范
## 规范和要求

### Markdown 格式规范

提交前请务必使用 markdownlint 进行检查，不满足格式要求的修改无法合并入主仓库。

Expand All @@ -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) 的规范，不满足格式要求的修改无法合并入主仓库。

项目集成了自动检查和修复插件，可以通过以下指令调用。

Expand All @@ -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)

## 标注功能版本
### 标注功能版本

对于新加入的功能，需要在标题和正文开头都注明加入的版本。

Expand All @@ -65,7 +67,7 @@ pnpm run lint:autocorrect:fix # 检查并进行部分自动修复

![版本标签](README.assets/version_badge.png)

### 开发版中的新功能
#### 开发版中的新功能

如果是为当前开发版中的新功能编写文档，而不能确定下一个正式版的版本号，使用以下标签：

Expand All @@ -75,7 +77,7 @@ pnpm run lint:autocorrect:fix # 检查并进行部分自动修复

这样做的好处是：在确定版本号后，方便通过文本替换批量修改。

## 归档警告
### 归档警告

对于弃用的功能，需要在正文开头注明弃用的版本和归档的时间。

Expand All @@ -91,7 +93,7 @@ pnpm run lint:autocorrect:fix # 检查并进行部分自动修复

![归档警告](README.assets/archieve_exanple.png)

### 开发版中弃用的功能
#### 开发版中弃用的功能

对于在当前开发版中弃用，即将于下一个正式版中去除的功能，**不要**在正式版发布前移动原始文本。

Expand Down
6 changes: 3 additions & 3 deletions docs/advanced/edit_deck.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -663,19 +663,19 @@ YAML 牌堆中的表示正好相反：

:::

假如牌堆文件内容如下（使用相对路径 `./asstes/...` ）：
假如牌堆文件内容如下（使用相对路径 `./assets/...` ）：

```json
{
"test":["[图:./asstes/1.jpg]"]
"test":["[图:./assets/1.jpg]"]
}
```

则牌堆文件所在文件夹结构应是：

```text
.
├─asstes
├─assets
│ └─1.jpg
└─ test.json
```
Expand Down