Skip to content

Commit 5258a45

Browse files
committed
【维护】更新项目配置和文档
- 修改 .gitignore 文件,添加 index.min.html 到忽略列表 - 更新 CONTRIBUTING.md,调整代码提交流程说明 - 修改 README.md 和 README_EN.md,使用 v1 版本并添加星标图表 - 删除 index.min.html 文件
1 parent 3989ff3 commit 5258a45

5 files changed

Lines changed: 15 additions & 19 deletions

File tree

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
/target
2-
/Cargo.lock
2+
/Cargo.lock
3+
index.min.html

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@
2121

2222
1. Fork 源码,下载到本地并运行项目;
2323
2. 添加或修改代码;
24-
3. 对相关改动进行全面的自我测试
25-
4. 运行 `cargo run --release -- index.html index.min.html` 命令以生成压缩的最小文件
24+
3. 运行 `cargo run --release -- index.html index.min.html` 命令以生成压缩的最小文件
25+
4. 对相关改动进行全面的自我测试
2626
5. 确认无误后提交修改到 Github;
2727
6. 提交 Pull Request。
2828

2929
### 注意事项
3030

3131
- 单次 Pull Request 不应提交过多修改,请确保每次提交都针对特定的功能且务必说明本次改动的具体目的,例如:修复某 bug 、优化某方法 等,方便进行 Code Review;
3232
- 对于 bug 的修复,应该将本次 Pull Request 和相对应 bug 的 issue 关联起来,让别人知道该问题已经被修复;
33-
- 对于较大的新功能,你需要先提交 Issues,例如 “添加 XXX 功能”,确认该功能有被添加的必要后,再开始工作;
33+
- 对于较大的新功能,你需要先提交 Issues,例如 “【新增】添加 XXX 功能”,确认该功能有被添加的必要后,再开始工作;
3434
- 对于一些主观的样式、交互逻辑调整:如颜色、图标的使用,某些预设配置的增减修改等,一般不予通过。但可以在 Discussions 中进行讨论;
3535
- 其他如简单的代码优化、文档修正等,只要修改合理都会被接受。

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525
```yaml
2626
- name: Deploy markdown.html
27-
uses: PJ-568/MARKDOWN.HTML@v1.10.1
27+
uses: PJ-568/MARKDOWN.HTML@v1
2828
with:
2929
target-dir: '.'
3030
file-name: 'index.html'
@@ -56,3 +56,7 @@
5656
|darkmode.js|[MIT license](//mit-license.org)|[Github](https://github.com/sandoche/Darkmode.js)|
5757
|MoOx/pjax|[MIT license](//mit-license.org)|[Github](https://github.com/MoOx/pjax)|
5858
|instant.page|[MIT license](//mit-license.org)|[Github](https://github.com/instantpage/instant.page)|
59+
60+
## 星
61+
62+
[![Stargazers over time](https://starchart.cc/PJ-568/MARKDOWN.HTML.svg?variant=adaptive)](https://starchart.cc/PJ-568/MARKDOWN.HTML)

README_EN.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ This project aims to provide a low-dependency, simple deployment solution for re
2424

2525
```yaml
2626
- name: Deploy markdown.html
27-
uses: PJ-568/MARKDOWN.HTML@v1.10.1
27+
uses: PJ-568/MARKDOWN.HTML@v1
2828
with:
2929
target-dir: '.'
3030
file-name: 'index.html'
@@ -56,3 +56,7 @@ This project is licensed under the [CC BY-SA 4.0 International](https://creative
5656
|darkmode.js|[MIT license](//mit-license.org)|[Github](https://github.com/sandoche/Darkmode.js)|
5757
|MoOx/pjax|[MIT license](//mit-license.org)|[Github](https://github.com/MoOx/pjax)|
5858
|instant.page|[MIT license](//mit-license.org)|[Github](https://github.com/instantpage/instant.page)|
59+
60+
## Stargazers over time
61+
62+
[![Stargazers over time](https://starchart.cc/PJ-568/MARKDOWN.HTML.svg?variant=adaptive)](https://starchart.cc/PJ-568/MARKDOWN.HTML)

index.min.html

Lines changed: 0 additions & 13 deletions
This file was deleted.

0 commit comments

Comments
 (0)