Skip to content

Commit cdd2a6c

Browse files
committed
更新 README.md,添加英文文档链接,并删除 Tampermonkey 参考资料文档以简化项目结构。
1 parent 092da24 commit cdd2a6c

File tree

8 files changed

+7400
-60
lines changed

8 files changed

+7400
-60
lines changed

README.md

Lines changed: 2 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
![CheekyChimp](https://img.shields.io/badge/CheekyChimp-v0.1.0-green) ![Obsidian](https://img.shields.io/badge/Obsidian-v0.15.0+-blue) ![License](https://img.shields.io/badge/License-GPL--3.0-orange)
44

5+
[English Documentation](docs/README_EN.md)
6+
57
## 简介
68

79
CheekyChimp 是一个为 Obsidian 内置浏览器设计的用户脚本管理器插件,类似于浏览器中的 Tampermonkey 扩展。它允许您在 Obsidian 的内置浏览器中注入和运行自定义脚本,从而增强您的浏览体验。
@@ -44,38 +46,6 @@ CheekyChimp 是一个为 Obsidian 内置浏览器设计的用户脚本管理器
4446
1. **夜间模式助手** - 实现任意网站的夜间模式,支持网站白名单
4547
2. **Bilibili 视频速度控制** - 为 Bilibili 视频添加速度控制功能
4648

47-
## 开发指南
48-
49-
### 环境设置
50-
51-
1. 克隆项目
52-
2. 安装依赖: `npm install`
53-
3. 开发: `npm run dev`
54-
4. 构建: `npm run build`
55-
5. 清理: `npm run clean`
56-
57-
### 项目结构
58-
59-
```
60-
cheekychimp/
61-
├── src/ # 源代码目录
62-
│ ├── models/ # 数据模型定义
63-
│ ├── services/ # 业务逻辑服务
64-
│ ├── views/ # 视图组件
65-
│ ├── modals/ # 模态窗口
66-
│ ├── ui/ # UI组件
67-
│ └── main.ts # 主入口文件
68-
├── examples/ # 示例用户脚本
69-
├── tests/ # 测试代码
70-
├── docs/ # 文档
71-
│ └── reference/ # 参考资料
72-
├── main.js # 构建输出文件 (插件入口)
73-
├── styles.css # 插件样式
74-
├── manifest.json # 插件清单
75-
├── package.json # 项目配置
76-
└── tsconfig.json # TypeScript配置
77-
```
78-
7949
## 常见问题
8050

8151
### 跨域问题

docs/LICENSE

Lines changed: 674 additions & 0 deletions
Large diffs are not rendered by default.

docs/README_EN.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# CheekyChimp
2+
3+
![CheekyChimp](https://img.shields.io/badge/CheekyChimp-v0.1.0-green) ![Obsidian](https://img.shields.io/badge/Obsidian-v0.15.0+-blue) ![License](https://img.shields.io/badge/License-GPL--3.0-orange)
4+
5+
[中文文档](../README.md)
6+
7+
## Introduction
8+
9+
CheekyChimp is a user script manager plugin designed for Obsidian's built-in browser, similar to the Tampermonkey extension in web browsers. It allows you to inject and run custom scripts in Obsidian's built-in browser, enhancing your browsing experience.
10+
11+
## Demo
12+
13+
Here's a demonstration video of the plugin:
14+
15+
![Demo Video](../examples/demo.gif)
16+
17+
## Features
18+
19+
- Run user scripts in Obsidian's built-in browser
20+
- Manage scripts with add, delete, enable/disable operations
21+
- Implements GM_* API series functions similar to Tampermonkey
22+
- Provides persistent storage for script data
23+
- Supports Chinese script names and content
24+
- User-friendly interface for script management
25+
26+
## Installation
27+
28+
### Manual Installation
29+
30+
1. Download the latest release package
31+
2. Extract to your Obsidian plugins directory: `<vault>/.obsidian/plugins/`
32+
3. Restart Obsidian
33+
4. Enable the CheekyChimp plugin in settings
34+
35+
## Usage
36+
37+
1. After installation and enabling the plugin, you'll see the CheekyChimp icon in Obsidian's left sidebar
38+
2. Click the icon to open the CheekyChimp management panel
39+
3. Click the "Add Script" button to import new scripts
40+
4. When visiting relevant web pages in Obsidian's built-in browser, eligible scripts will run automatically
41+
42+
## Example Scripts
43+
44+
The plugin comes with several example scripts that you can find in the `examples` directory:
45+
46+
1. **Night Mode Assistant** - Implements night mode for any website with whitelist support
47+
2. **Bilibili Video Speed Control** - Adds speed control functionality to Bilibili videos
48+
49+
## Common Issues
50+
51+
### Cross-Origin Issues
52+
53+
Due to Obsidian's webview limitations, some cross-origin requests may not work properly and require special handling.
54+
55+
### Script Compatibility
56+
57+
Not all user scripts can run normally in Obsidian, as some scripts that depend on specific browser APIs may need modifications.
58+
59+
## Contributing
60+
61+
Pull requests and issues are welcome to help improve this project!
62+
63+
## License
64+
65+
This project is licensed under the [GPL-3.0](https://www.gnu.org/licenses/gpl-3.0.html) License.
66+
67+
---
68+
69+
**CheekyChimp** - Make your Obsidian browsing experience more colorful!

docs/reference/README.md

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

0 commit comments

Comments
 (0)