Skip to content

Commit 3a3cb46

Browse files
committed
docs: remove emojis from all markdown docs; RMinte already uses ®
1 parent 5eeb663 commit 3a3cb46

4 files changed

Lines changed: 58 additions & 58 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,30 @@ labels: bug
66
assignees: ''
77
---
88

9-
## 🐛 Bug Description
9+
## Bug Description
1010

1111
<!-- A clear and concise description of what the bug is -->
1212

13-
## 📋 Steps to Reproduce
13+
## Steps to Reproduce
1414

1515
1. Go to '...'
1616
2. Click on '...'
1717
3. Scroll down to '...'
1818
4. See error
1919

20-
## Expected Behavior
20+
## Expected Behavior
2121

2222
<!-- What you expected to happen -->
2323

24-
## Actual Behavior
24+
## Actual Behavior
2525

2626
<!-- What actually happened -->
2727

28-
## 📸 Screenshots
28+
## Screenshots
2929

3030
<!-- If applicable, add screenshots to help explain your problem -->
3131

32-
## 🖥️ Environment
32+
## Environment
3333

3434
**Desktop/Mobile**:
3535
- OS: [e.g. Windows 10, macOS 14, iOS 17]
@@ -41,19 +41,19 @@ assignees: ''
4141
- [ ] Source code
4242
- [ ] Other: _____
4343

44-
## 📝 Logs
44+
## Logs
4545

4646
<!-- If applicable, paste relevant error logs -->
4747

4848
```
4949
Paste logs here
5050
```
5151

52-
## 🔍 Additional Context
52+
## Additional Context
5353

5454
<!-- Add any other context about the problem here -->
5555

56-
## ✔️ Checklist
56+
## Checklist
5757

5858
- [ ] I have searched existing issues to ensure this is not a duplicate
5959
- [ ] I have provided all requested information

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,30 @@ labels: enhancement
66
assignees: ''
77
---
88

9-
## 💡 Feature Description
9+
## Feature Description
1010

1111
<!-- A clear and concise description of the feature you'd like -->
1212

13-
## 🎯 Use Case
13+
## Use Case
1414

1515
<!-- Describe the problem this feature would solve -->
1616

1717
**Is your feature request related to a problem? Please describe.**
1818
<!-- e.g. I'm always frustrated when... -->
1919

20-
## 📝 Proposed Solution
20+
## Proposed Solution
2121

2222
<!-- Describe how you envision this feature working -->
2323

24-
## 🔄 Alternatives Considered
24+
## Alternatives Considered
2525

2626
<!-- Describe any alternative solutions or features you've considered -->
2727

28-
## 📸 Mockups/Examples
28+
## Mockups/Examples
2929

3030
<!-- If applicable, add mockups, diagrams, or examples from other projects -->
3131

32-
## 📋 Implementation Checklist
32+
## Implementation Checklist
3333

3434
<!-- For maintainers - leave blank if you're not implementing -->
3535

@@ -39,11 +39,11 @@ assignees: ''
3939
- [ ] Documentation updates needed
4040
- [ ] Breaking changes
4141

42-
## 🤔 Additional Context
42+
## Additional Context
4343

4444
<!-- Add any other context, links, or references about the feature request -->
4545

46-
## 👥 Who Would Benefit?
46+
## Who Would Benefit?
4747

4848
<!-- Who would benefit from this feature? -->
4949

@@ -53,7 +53,7 @@ assignees: ''
5353
- [ ] System administrators
5454
- [ ] Everyone
5555

56-
## ⚖️ Priority
56+
## Priority
5757

5858
<!-- How important is this feature to you? -->
5959

@@ -62,7 +62,7 @@ assignees: ''
6262
- [ ] Medium (nice to have)
6363
- [ ] Low (minor improvement)
6464

65-
## 🙋 I'm Willing To Help
65+
## I'm Willing To Help
6666

6767
- [ ] I would like to implement this feature
6868
- [ ] I can provide testing

Plugins/README.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -343,10 +343,10 @@ For complex plugins that need full control over settings UI, use `customSettings
343343
const result = await verifyApiKey(input.value.trim());
344344

345345
if (result.success) {
346-
status.innerHTML = `<span style="color:var(--success-color);">${t('verifySuccess')}</span>`;
346+
status.innerHTML = `<span style="color:var(--success-color);">${t('verifySuccess')}</span>`;
347347
input.value = '';
348348
} else {
349-
status.innerHTML = `<span style="color:var(--error-color);">${t('verifyFailed')}</span>`;
349+
status.innerHTML = `<span style="color:var(--error-color);">${t('verifyFailed')}</span>`;
350350
}
351351
btn.textContent = t('verify');
352352
},
@@ -651,10 +651,10 @@ To distribute your plugin:
651651
- **Direct Download**: Host on GitHub releases or your website
652652
653653
5. **Common issues**:
654-
- Zip contains nested folders: `your-plugin.zip/your-plugin/your-plugin/manifest.json`
655-
- Correct structure: `your-plugin.zip/your-plugin/manifest.json`
656-
- Files outside plugin folder
657-
- All files inside single plugin folder
654+
- Wrong: Zip contains nested folders: `your-plugin.zip/your-plugin/your-plugin/manifest.json`
655+
- Correct structure: `your-plugin.zip/your-plugin/manifest.json`
656+
- Wrong: Files outside plugin folder
657+
- Correct: All files inside single plugin folder
658658
659659
### Advanced: Local Dependencies and CSS Loading
660660
@@ -747,13 +747,13 @@ ChatRawPlugin.hooks.register('after_receive', {
747747
11. **Always `await` async operations**: When calling async functions (like `saveSettings()`) in event handlers, always use `await` to ensure operations complete before proceeding:
748748
749749
```javascript
750-
// Wrong - data may not be saved
750+
// Wrong - data may not be saved
751751
button.onclick = () => {
752752
saveSettings(); // Missing await!
753753
renderUI();
754754
};
755755

756-
// Correct - wait for save to complete
756+
// Correct - wait for save to complete
757757
button.onclick = async () => {
758758
await saveSettings();
759759
renderUI();
@@ -811,12 +811,12 @@ Watch out for these common mistakes:
811811
1. **Wrong IIFE pattern**: Always use the parameter-passing pattern for cleaner code:
812812
813813
```javascript
814-
// Wrong - direct global access
814+
// Wrong - direct global access
815815
(function() {
816816
window.ChatRawPlugin.hooks.register(...);
817817
})();
818818
819-
// Correct - pass as parameter
819+
// Correct - pass as parameter
820820
(function(ChatRaw) {
821821
if (!ChatRaw || !ChatRaw.hooks) {
822822
console.error('[YourPlugin] ChatRawPlugin not available');
@@ -829,20 +829,20 @@ Watch out for these common mistakes:
829829
2. **Wrong API method names**: Use the correct method names:
830830
831831
```javascript
832-
// Wrong - getLang doesn't exist
832+
// Wrong - getLang doesn't exist
833833
const lang = ChatRaw.utils?.getLang?.() || 'en';
834834
835-
// Correct - use getLanguage
835+
// Correct - use getLanguage
836836
const lang = ChatRaw.utils?.getLanguage?.() || 'en';
837837
```
838838
839839
3. **Missing optional chaining**: Always use `?.` for potentially undefined methods:
840840
841841
```javascript
842-
// Risky - may throw error if utils is undefined
842+
// Risky - may throw error if utils is undefined
843843
ChatRaw.utils.showToast('Message', 'info');
844844
845-
// Safe - handles undefined gracefully
845+
// Safe - handles undefined gracefully
846846
ChatRaw.utils?.showToast?.('Message', 'info');
847847
```
848848
@@ -851,25 +851,25 @@ ChatRaw.utils?.showToast?.('Message', 'info');
851851
5. **Icon format for toolbar buttons**: Must use RemixIcon format (`ri-xxx-line` or `ri-xxx-fill`):
852852
853853
```javascript
854-
// Wrong - will be rejected
854+
// Wrong - will be rejected
855855
icon: 'fa-home' // FontAwesome
856856
icon: 'mdi-home' // Material Design Icons
857857
icon: 'icon-home' // Custom class
858858
859-
// Correct - RemixIcon format
859+
// Correct - RemixIcon format
860860
icon: 'ri-home-line' // Line style
861861
icon: 'ri-home-fill' // Fill style
862862
```
863863
864864
6. **Registering toolbar buttons in hook callbacks**: Buttons must be registered immediately when the script loads, not inside hooks:
865865
866866
```javascript
867-
// Wrong - hook callback runs after _currentLoadingPlugin is cleared
867+
// Wrong - hook callback runs after _currentLoadingPlugin is cleared
868868
ChatRaw.hooks.register('before_send', () => {
869869
ChatRaw.ui.registerToolbarButton({ ... }); // Will fail!
870870
});
871871
872-
// Correct - register immediately in IIFE
872+
// Correct - register immediately in IIFE
873873
(function(ChatRaw) {
874874
// Register buttons here, during script load
875875
ChatRaw.ui.registerToolbarButton({ ... }); // Works!
@@ -1219,10 +1219,10 @@ your-plugin/
12191219
const result = await verifyApiKey(input.value.trim());
12201220
12211221
if (result.success) {
1222-
status.innerHTML = `<span style="color:var(--success-color);">${t('verifySuccess')}</span>`;
1222+
status.innerHTML = `<span style="color:var(--success-color);">${t('verifySuccess')}</span>`;
12231223
input.value = '';
12241224
} else {
1225-
status.innerHTML = `<span style="color:var(--error-color);">${t('verifyFailed')}</span>`;
1225+
status.innerHTML = `<span style="color:var(--error-color);">${t('verifyFailed')}</span>`;
12261226
}
12271227
btn.textContent = t('verify');
12281228
},
@@ -1527,10 +1527,10 @@ const allData = ChatRaw.storage.getAll(PLUGIN_ID);
15271527
- **直接下载**:托管在 GitHub releases 或你的网站
15281528
15291529
5. **常见问题**:
1530-
- zip 包含嵌套文件夹:`your-plugin.zip/your-plugin/your-plugin/manifest.json`
1531-
- 正确结构:`your-plugin.zip/your-plugin/manifest.json`
1532-
- 文件在插件文件夹外
1533-
- 所有文件在单个插件文件夹内
1530+
- 错误:zip 包含嵌套文件夹:`your-plugin.zip/your-plugin/your-plugin/manifest.json`
1531+
- 正确结构:`your-plugin.zip/your-plugin/manifest.json`
1532+
- 错误:文件在插件文件夹外
1533+
- 正确:所有文件在单个插件文件夹内
15341534
15351535
### 进阶:本地依赖和 CSS 加载
15361536
@@ -1623,13 +1623,13 @@ ChatRawPlugin.hooks.register('after_receive', {
16231623
11. **异步操作必须 `await`**:在事件处理函数中调用异步函数(如 `saveSettings()`)时,必须使用 `await` 确保操作完成后再继续:
16241624
16251625
```javascript
1626-
// 错误 - 数据可能未保存
1626+
// 错误 - 数据可能未保存
16271627
button.onclick = () => {
16281628
saveSettings(); // 缺少 await!
16291629
renderUI();
16301630
};
16311631
1632-
// 正确 - 等待保存完成
1632+
// 正确 - 等待保存完成
16331633
button.onclick = async () => {
16341634
await saveSettings();
16351635
renderUI();
@@ -1687,12 +1687,12 @@ button.onclick = async () => {
16871687
1. **错误的 IIFE 模式**:始终使用参数传递模式以获得更清晰的代码:
16881688
16891689
```javascript
1690-
// 错误 - 直接访问全局变量
1690+
// 错误 - 直接访问全局变量
16911691
(function() {
16921692
window.ChatRawPlugin.hooks.register(...);
16931693
})();
16941694
1695-
// 正确 - 作为参数传递
1695+
// 正确 - 作为参数传递
16961696
(function(ChatRaw) {
16971697
if (!ChatRaw || !ChatRaw.hooks) {
16981698
console.error('[YourPlugin] ChatRawPlugin 不可用');
@@ -1705,20 +1705,20 @@ button.onclick = async () => {
17051705
2. **错误的 API 方法名**:请使用正确的方法名:
17061706
17071707
```javascript
1708-
// 错误 - getLang 方法不存在
1708+
// 错误 - getLang 方法不存在
17091709
const lang = ChatRaw.utils?.getLang?.() || 'en';
17101710
1711-
// 正确 - 使用 getLanguage
1711+
// 正确 - 使用 getLanguage
17121712
const lang = ChatRaw.utils?.getLanguage?.() || 'en';
17131713
```
17141714
17151715
3. **缺少可选链操作符**:对于可能未定义的方法,始终使用 `?.`:
17161716
17171717
```javascript
1718-
// 有风险 - 如果 utils 未定义会报错
1718+
// 有风险 - 如果 utils 未定义会报错
17191719
ChatRaw.utils.showToast('消息', 'info');
17201720
1721-
// 安全 - 优雅处理未定义情况
1721+
// 安全 - 优雅处理未定义情况
17221722
ChatRaw.utils?.showToast?.('消息', 'info');
17231723
```
17241724
@@ -1727,25 +1727,25 @@ ChatRaw.utils?.showToast?.('消息', 'info');
17271727
5. **工具栏按钮图标格式**:必须使用 RemixIcon 格式(`ri-xxx-line` 或 `ri-xxx-fill`):
17281728
17291729
```javascript
1730-
// 错误 - 会被拒绝
1730+
// 错误 - 会被拒绝
17311731
icon: 'fa-home' // FontAwesome
17321732
icon: 'mdi-home' // Material Design Icons
17331733
icon: 'icon-home' // 自定义类名
17341734
1735-
// 正确 - RemixIcon 格式
1735+
// 正确 - RemixIcon 格式
17361736
icon: 'ri-home-line' // 线条样式
17371737
icon: 'ri-home-fill' // 填充样式
17381738
```
17391739
17401740
6. **在 hook 回调中注册工具栏按钮**:按钮必须在脚本加载时立即注册,不能在 hook 中注册:
17411741
17421742
```javascript
1743-
// 错误 - hook 回调执行时 _currentLoadingPlugin 已被清除
1743+
// 错误 - hook 回调执行时 _currentLoadingPlugin 已被清除
17441744
ChatRaw.hooks.register('before_send', () => {
17451745
ChatRaw.ui.registerToolbarButton({ ... }); // 会失败!
17461746
});
17471747
1748-
// 正确 - 在 IIFE 中立即注册
1748+
// 正确 - 在 IIFE 中立即注册
17491749
(function(ChatRaw) {
17501750
// 在这里注册按钮,脚本加载期间
17511751
ChatRaw.ui.registerToolbarButton({ ... }); // 正常工作!

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ ChatRaw features a complete **plugin system** to extend functionality:
119119
| Desktop | Mobile |
120120
| :-------------------------------------------: | :------------------------------------------: |
121121
| ![Desktop Performance][perf-desktop] | ![Mobile Performance][perf-mobile] |
122-
| [📑 Lighthouse Report][perf-desktop-report] | [📑 Lighthouse Report][perf-mobile-report] |
122+
| [Lighthouse Report][perf-desktop-report] | [Lighthouse Report][perf-mobile-report] |
123123

124124
**Desktop**: Performance 100 | Accessibility 100 | Best Practices 100 | SEO 100
125125

@@ -397,7 +397,7 @@ ChatRaw 拥有完整的**插件系统**以扩展功能:
397397
- 自定义设置界面
398398
- 一键打包分发
399399

400-
📖 **插件开发指南**: [Plugins/README.md](Plugins/README.md)
400+
**插件开发指南**: [Plugins/README.md](Plugins/README.md)
401401

402402
---
403403

@@ -408,7 +408,7 @@ ChatRaw 拥有完整的**插件系统**以扩展功能:
408408
| 桌面端 | 移动端 |
409409
| :-------------------------------------------: | :-------------------------------------------: |
410410
| ![桌面端性能][perf-desktop] | ![移动端性能][perf-mobile] |
411-
| [📑 Lighthouse 测试报告][perf-desktop-report] | [📑 Lighthouse 测试报告][perf-mobile-report] |
411+
| [Lighthouse 测试报告][perf-desktop-report] | [Lighthouse 测试报告][perf-mobile-report] |
412412

413413
**桌面端**: 性能 100 | 无障碍 100 | 最佳做法 100 | SEO 100
414414

0 commit comments

Comments
 (0)