开源项目启动与配置教程

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

开源项目 google-cn-devsites-extension 的目录结构如下：

google-cn-devsites-extension/
├── chrome/
│   ├── background.js
│   ├── content.js
│   ├── manifest.json
│   └── popup.html
├── images/
│   └── icon.png
├── README.md
└── package.json

目录说明：

• chrome/：存放Chrome扩展程序的主要文件。

  • background.js：扩展程序的背景脚本，负责处理后台逻辑。
  • content.js：扩展程序的内容脚本，用于操作网页内容。
  • manifest.json：扩展程序的配置文件，定义了扩展程序的基本信息和权限。
  • popup.html：扩展程序弹出窗口的HTML文件。

• images/：存放扩展程序所需的图片资源。

  • icon.png：扩展程序在Chrome工具栏中显示的图标。

• README.md：项目的说明文档，通常包含了项目的基本信息、安装步骤和使用说明。

• package.json：Node.js项目的配置文件，本项目中的此文件主要用于定义项目依赖和脚本。

2. 项目的启动文件介绍

项目的启动主要依赖于Chrome扩展程序的配置文件 manifest.json。以下是该文件的基本内容：

{
  "manifest_version": 2,
  "name": "Google CN DevSites Extension",
  "version": "1.0",
  "description": "A Chrome extension for DevSites.",
  "permissions": [
    "activeTab"
  ],
  "background": {
    "scripts": ["background.js"],
    "persistent": false
  },
  "content_scripts": [
    {
      "matches": ["<all_urls>"],
      "js": ["content.js"]
    }
  ],
  "browser_action": {
    "default_popup": "popup.html",
    "default_icon": {
      "16": "images/icon.png"
    }
  },
  "icons": {
    "16": "images/icon.png"
  }
}

启动步骤：

1. 将整个项目文件夹拖拽到Chrome扩展程序的加载已解压的扩展程序页面。
2. 打开Chrome浏览器，进入 chrome://extensions/ 页面，开启开发者模式。
3. 点击“加载已解压的扩展程序”，选择项目文件夹。

3. 项目的配置文件介绍

项目的配置文件是 manifest.json，它是Chrome扩展程序的核心文件，定义了扩展程序的行为、权限和用户界面元素。

配置文件内容：

• manifest_version：定义了manifest文件格式的版本。
• name：扩展程序的名称。
• version：扩展程序的版本号。
• description：扩展程序的描述。
• permissions：扩展程序需要的权限列表。
• background：定义了扩展程序的背景脚本。
• content_scripts：定义了扩展程序的内容脚本。
• browser_action：定义了扩展程序的浏览器操作，如弹出窗口和图标。
• icons：定义了扩展程序的图标。

通过修改 manifest.json 文件，可以调整扩展程序的名称、描述、权限和功能等。