mirror of
https://github.com/infiniflow/ragflow.git
synced 2025-12-22 14:16:42 +08:00
46 lines
2.6 KiB
Markdown
46 lines
2.6 KiB
Markdown
# Chrome Extension
|
||
```
|
||
chrome-extension/
|
||
│
|
||
├── manifest.json # Main configuration file for the extension
|
||
├── popup.html # Main user interface of the extension
|
||
├── popup.js # Script for the main interface
|
||
├── background.js # Background script for the extension
|
||
├── content.js # Script to interact with web pages
|
||
├── styles/
|
||
│ └── popup.css # CSS file for the popup
|
||
├── icons/
|
||
│ ├── icon16.png # 16x16 pixel icon
|
||
│ ├── icon48.png # 48x48 pixel icon
|
||
│ └── icon128.png # 128x128 pixel icon
|
||
├── assets/
|
||
│ └── ... # Directory for other assets (images, fonts, etc.)
|
||
├── scripts/
|
||
│ ├── utils.js # File containing utility functions
|
||
│ └── api.js # File containing API call logic
|
||
└── README.md # Instructions for using and installing the extension
|
||
```
|
||
|
||
# Installation
|
||
1. Open chrome://extensions/.
|
||
2. Enable Developer mode.
|
||
3. Click Load unpacked and select the project directory.
|
||
# Features
|
||
1. Interact with web pages.
|
||
2. Run in the background to handle logic.
|
||
# Usage
|
||
- Click the extension icon in the toolbar.
|
||
- Follow the instructions in the interface.
|
||
# Additional Notes
|
||
- **manifest.json**: This file is crucial as it defines the extension's metadata, permissions, and entry points.
|
||
- **background.js**: This script runs independently of any web page and can perform tasks such as listening for browser events, making network requests, and storing data.
|
||
- **content.js**: This script injects code into web pages to manipulate the DOM, modify styles, or communicate with the background script.
|
||
- **popup.html/popup.js**: These files create the popup that appears when the user clicks the extension icon.
|
||
icons: These icons are used to represent the extension in the browser's UI.
|
||
More Detailed Explanation
|
||
- **manifest.json**: Specifies the extension's name, version, permissions, and other details. It also defines the entry points for the background script, content scripts, and the popup.
|
||
- **background.js**: Handles tasks that need to run continuously, such as syncing data, listening for browser events, or controlling the extension's behavior.
|
||
- **content.js**: Interacts directly with the web page's DOM, allowing you to modify the content, style, or behavior of the page.
|
||
- **popup.html/popup.js**: Creates a user interface that allows users to interact with the extension.
|
||
Other files: These files can contain additional scripts, styles, or assets that are used by the extension.
|