Skip to content

Commit 1bb8179

Browse files
author
wujiancheng
committed
更新 README
1 parent 9130ce1 commit 1bb8179

File tree

2 files changed

+14
-10
lines changed

2 files changed

+14
-10
lines changed

‎README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# docusaurus-blogs-changes-to-workwechat-action
22

3+
[English](./README.md) | [中文](./README_CN.md)
4+
35
A GitHub Action to detect changes in Docusaurus blog posts and send notifications to a Work-WeChat robot. This action is specifically designed for projects using Docusaurus with blogs stored in a specified directory (default: `blog`).
46

57
---
@@ -39,7 +41,7 @@ Here is how you should configure `actions/checkout@v3` in your workflow:
3941
| **Input Name** | **Description** | **Required** | **Default** |
4042
|----------------------|---------------------------------------------------------------------------------------------|--------------|---------------------------------------------------------------------------------------------------|
4143
| `wechat_webhook` | The webhook URL for your Work-WeChat robot. | ✅ Yes | N/A |
42-
| `base_url` | The base URL of your GitHub Pages site (e.g., `https://yourusername.github.io/yourrepo`). | ✅ Yes | N/A |
44+
| `base_url` | The base URL of your GitHub Pages site (e.g., `https://<yourusername>.github.io/<yourrepo>`). | ✅ Yes | N/A |
4345
| `blog_dir` | The directory where your blog posts are stored. | ❌ No | `blog` |
4446
| `message_template` | The template of the message to send. Supports placeholders for `addedBlogs`, `updatedBlogs`, `github.*` variables. | ❌ No | **See default template below.** |
4547

@@ -86,7 +88,7 @@ jobs:
8688
fetch-depth: 2 # Ensure we can compare HEAD with HEAD^
8789
8890
- name: Detect blog changes and send notifications
89-
uses: your-username/docusaurus-blogs-changes-to-workwechat-action@v1
91+
uses: TinyFunction/docusaurus-blogs-changes-to-workwechat-action@v1
9092
with:
9193
wechat_webhook: ${{ secrets.WECHAT_WEBHOOK }}
9294
base_url: "https://yourusername.github.io/yourrepo"
@@ -135,7 +137,7 @@ If something goes wrong, the following steps can help:
135137

136138
We welcome contributions! Here’s how you can get involved:
137139

138-
1. **Report Bugs**: If you encounter any issues, please open an issue in the [GitHub repository](https://github.com/your-username/docusaurus-blogs-changes-to-workwechat-action/issues).
140+
1. **Report Bugs**: If you encounter any issues, please open an issue in the [GitHub repository](https://github.com/TinyFunction/docusaurus-blogs-changes-to-workwechat/issues).
139141
2. **Suggest Features**: Have an idea to improve this action? Open a feature request in the Issues section.
140142
3. **Submit Pull Requests**:
141143
- Fork the repository.
@@ -146,8 +148,8 @@ We welcome contributions! Here’s how you can get involved:
146148

147149
1. Clone the repository:
148150
```bash
149-
git clone https://github.com/your-username/docusaurus-blogs-changes-to-workwechat-action.git
150-
cd docusaurus-blogs-changes-to-workwechat-action
151+
git clone https://github.com/TinyFunction/docusaurus-blogs-changes-to-workwechat.git
152+
cd docusaurus-blogs-changes-to-workwechat
151153
```
152154

153155
2. Install dependencies:

‎README_CN.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# docusaurus-blogs-changes-to-workwechat-action
22

3+
[English](./README.md) | [中文](./README_CN.md)
4+
35
一个用于检测 Docusaurus 博客文章变化并通过企业微信机器人发送通知的 GitHub Action。该插件专为使用 Docusaurus 的博客项目设计，支持检测新增和更新的博客文章，并发送自定义格式的消息到企业微信。
46

57
---
@@ -39,7 +41,7 @@ Initial commit detected. Skipping blog change detection.
3941
| **参数名称** | **描述** | **是否必填** | **默认值** |
4042
|----------------------|---------------------------------------------------------------------------------------|--------------|---------------------------------------------------------------------------------------------------|
4143
| `wechat_webhook` | 企业微信机器人 Webhook 地址。 | ✅ 是 | 无 |
42-
| `base_url` | GitHub Pages 的基础 URL（例如 `https://yourusername.github.io/yourrepo`）。 | ✅ 是 | 无 |
44+
| `base_url` | GitHub Pages 的基础 URL（例如 `https://<yourusername>.github.io/<yourrepo>`）。 | ✅ 是 | 无 |
4345
| `blog_dir` | 博客文章的存储目录。 | ❌ 否 | `blog` |
4446
| `message_template` | 自定义的消息模板，支持占位符（如 `${addedBlogs}`、`${updatedBlogs}`、`${github.*}`）。 | ❌ 否 | **见下方默认模板** |
4547

@@ -86,7 +88,7 @@ jobs:
8688
fetch-depth: 2 # 确保拉取最近两次提交
8789
8890
- name: Detect blog changes and send notifications
89-
uses: your-username/docusaurus-blogs-changes-to-workwechat-action@v1
91+
uses: TinyFunction/docusaurus-blogs-changes-to-workwechat-action@v1
9092
with:
9193
wechat_webhook: ${{ secrets.WECHAT_WEBHOOK }}
9294
base_url: "https://yourusername.github.io/yourrepo"
@@ -133,7 +135,7 @@ jobs:
133135
我们欢迎所有形式的贡献！以下是一些参与方式：
134136
135137
### 1. 报告问题
136-
如果你在使用中遇到任何问题，请通过 [GitHub Issues](https://github.com/your-username/docusaurus-blogs-changes-to-workwechat-action/issues) 提交。
138+
如果你在使用中遇到任何问题，请通过 [GitHub Issues](https://github.com/your-username/docusaurus-blogs-changes-to-workwechat/issues) 提交。
137139
138140
### 2. 提出功能建议
139141
如果你有改进插件的建议或新功能需求，可以在 Issues 中提交功能请求。
@@ -149,8 +151,8 @@ jobs:
149151
150152
1. 克隆项目：
151153
```bash
152-
git clone https://github.com/your-username/docusaurus-blogs-changes-to-workwechat-action.git
153-
cd docusaurus-blogs-changes-to-workwechat-action
154+
git clone https://github.com/your-username/docusaurus-blogs-changes-to-workwechat.git
155+
cd docusaurus-blogs-changes-to-workwechat
154156
```
155157

156158
2. 安装依赖：

0 commit comments

Comments
 (0)