Tranquility Reader 项目教程

Tranquility Reader 项目教程

tranquility-reader-webextensionsTranquility Reader rewritten using Webextensions API项目地址:https://gitcode.com/gh_mirrors/tr/tranquility-reader-webextensions

1. 项目的目录结构及介绍

tranquility-reader-webextensions/
├── _locales/
├── icons/
├── src/
│   ├── background.js
│   ├── content.js
│   ├── options.html
│   ├── options.js
│   ├── popup.html
│   ├── popup.js
│   └── styles.css
├── manifest.json
├── PRIVACY.md
├── README.md
└── RELEASE-NOTES.md

• _locales/: 存放多语言支持的文件。
• icons/: 存放扩展图标。
• src/: 核心代码目录。
  • background.js: 后台脚本。
  • content.js: 内容脚本。
  • options.html: 选项页面。
  • options.js: 选项页面脚本。
  • popup.html: 弹出窗口页面。
  • popup.js: 弹出窗口脚本。
  • styles.css: 样式文件。
• manifest.json: 扩展的配置文件。
• PRIVACY.md: 隐私政策文件。
• README.md: 项目说明文件。
• RELEASE-NOTES.md: 发布说明文件。

2. 项目的启动文件介绍

• background.js: 这是扩展的后台脚本，负责处理扩展的生命周期事件和后台任务。
• content.js: 这是内容脚本，负责在网页上下文中执行代码，以实现对网页内容的修改和处理。

3. 项目的配置文件介绍

• manifest.json: 这是扩展的主要配置文件，包含了扩展的基本信息、权限声明、资源路径等。

{
  "manifest_version": 2,
  "name": "Tranquility Reader",
  "version": "3.0.7",
  "description": "Improves the readability of web articles by removing unnecessary elements",
  "icons": {
    "48": "icons/tranquility-48.png"
  },
  "permissions": [
    "activeTab",
    "storage"
  ],
  "background": {
    "scripts": ["src/background.js"]
  },
  "browser_action": {
    "default_icon": "icons/tranquility-48.png",
    "default_title": "Tranquility Reader",
    "default_popup": "src/popup.html"
  },
  "content_scripts": [
    {
      "matches": ["<all_urls>"],
      "js": ["src/content.js"],
      "css": ["src/styles.css"]
    }
  ],
  "options_ui": {
    "page": "src/options.html",
    "open_in_tab": true
  }
}

• PRIVACY.md: 详细说明了扩展的隐私政策，确保用户数据的安全和隐私。
• README.md: 提供了项目的详细介绍、安装步骤和使用说明。
• RELEASE-NOTES.md: 记录了每个版本的更新内容和改进点。

tranquility-reader-webextensionsTranquility Reader rewritten using Webextensions API项目地址:https://gitcode.com/gh_mirrors/tr/tranquility-reader-webextensions