Git History Browser Extension 使用教程

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

Git History Browser Extension 项目的主要目录结构如下：

git-history-browser-extension/
├── extension/           # 存放浏览器扩展的相关文件
│   ├── background.js    # 后台脚本
│   ├── content.js       # 内容脚本
│   ├── popup.html       # 弹窗HTML文件
│   ├── popup.js         # 弹窗脚本
│   └── ...
├── img/                 # 存放项目所需的图片资源
├── .gitignore           # 指定git忽略的文件和目录
├── LICENSE              # 项目的开源协议文件
├── README.md            # 项目说明文件
└── ...

• extension/ 目录包含了扩展的核心代码，包括背景脚本、内容脚本、弹窗界面及其脚本等。
• img/ 目录包含了项目所需的图片资源，如扩展图标等。
• .gitignore 文件用于配置Git忽略规则，避免将不必要的文件提交到仓库中。
• LICENSE 文件说明了项目的开源协议，本项目采用MIT协议。
• README.md 文件提供了项目的基本信息和使用说明。

2. 项目的启动文件介绍

项目的启动主要依赖于浏览器扩展的加载机制。以下是一些主要的启动文件及其作用：

• background.js：后台脚本负责监听扩展的安装、更新等事件，以及在扩展被用户激活时执行相关操作。
• content.js：内容脚本注入到GitHub页面中，负责在文件界面上添加用于查看历史记录的按钮。
• popup.html 和 popup.js：弹窗HTML文件和对应的脚本用于创建和管理扩展的弹出界面。

在扩展安装后，浏览器会自动加载 background.js。当用户访问GitHub的文件界面时，content.js 会被注入到页面中，并在相应的位置添加按钮。

3. 项目的配置文件介绍

本项目没有专门的配置文件。扩展的行为和外观主要通过各种注释在代码中定义。如果需要修改扩展的行为，比如修改按钮的样式或功能，需要直接编辑 content.js 和相关的HTML文件。

对于扩展的设置和配置，开发者通常会在扩展中添加一个选项页面，用户可以通过这个页面来配置扩展的行为。本项目是一个简单的示例，没有包含这样的高级特性。如果需要添加配置功能，可以在项目中添加一个选项页面，并在 manifest.json 文件中声明该页面。