GitHub Dashboard 项目使用教程

GitHub Dashboard 项目使用教程

【免费下载链接】github-dashboard [Web extension] Filter events on github.com activity dashboard. 项目地址: https://gitcode.com/gh_mirrors/gi/github-dashboard

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

GitHub Dashboard 项目的目录结构如下：

github-dashboard/
├── chrome/
│   ├── background.js
│   ├── content.js
│   ├── manifest.json
│   └── popup.html
├── firefox/
│   ├── background.js
│   ├── content.js
│   ├── manifest.json
│   └── popup.html
├── scripts/
│   ├── build.sh
│   └── deploy.sh
├── LICENSE
├── README.md
├── dashboard.css
└── dashboard.js

目录结构介绍

• chrome/: 包含适用于 Chrome 浏览器的扩展文件。

  • background.js: 后台脚本文件。
  • content.js: 内容脚本文件。
  • manifest.json: Chrome 扩展的配置文件。
  • popup.html: 弹出窗口的 HTML 文件。

• firefox/: 包含适用于 Firefox 浏览器的扩展文件。

  • background.js: 后台脚本文件。
  • content.js: 内容脚本文件。
  • manifest.json: Firefox 扩展的配置文件。
  • popup.html: 弹出窗口的 HTML 文件。

• scripts/: 包含构建和部署脚本。

  • build.sh: 构建脚本。
  • deploy.sh: 部署脚本。

• LICENSE: 项目的开源许可证文件。

• README.md: 项目的介绍和使用说明。

• dashboard.css: 项目的样式文件。

• dashboard.js: 项目的主要逻辑文件。

2. 项目的启动文件介绍

项目的启动文件主要是 dashboard.js 和 dashboard.css。

dashboard.js

dashboard.js 是项目的主要逻辑文件，负责处理 GitHub 活动仪表盘的过滤功能。它通过监听用户的操作，动态更新仪表盘的内容，实现事件的过滤和展示。

dashboard.css

dashboard.css 是项目的样式文件，定义了仪表盘的外观和布局。它包含了各种样式规则，确保仪表盘在不同浏览器和设备上都能正常显示。

3. 项目的配置文件介绍

项目的配置文件主要是 manifest.json，分别位于 chrome/ 和 firefox/ 目录下。

manifest.json

manifest.json 是浏览器扩展的配置文件，定义了扩展的基本信息、权限、背景脚本、内容脚本等。以下是 manifest.json 的主要内容：

{
  "manifest_version": 2,
  "name": "GitHub Dashboard",
  "version": "1.0",
  "description": "Filter events on GitHub activity dashboard",
  "permissions": [
    "https://github.com/*"
  ],
  "background": {
    "scripts": ["background.js"]
  },
  "content_scripts": [
    {
      "matches": ["https://github.com/*"],
      "js": ["content.js"]
    }
  ],
  "browser_action": {
    "default_popup": "popup.html"
  }
}

配置文件介绍

• manifest_version: 指定 manifest 文件的版本，通常为 2 或 3。
• name: 扩展的名称。
• version: 扩展的版本号。
• description: 扩展的描述。
• permissions: 扩展所需的权限，例如访问 GitHub 的权限。
• background: 定义后台脚本文件。
• content_scripts: 定义内容脚本文件及其匹配的 URL。
• browser_action: 定义浏览器动作的默认弹出窗口。

通过以上配置，扩展能够在 GitHub 活动仪表盘上运行，并实现事件的过滤功能。

【免费下载链接】github-dashboard [Web extension] Filter events on github.com activity dashboard. 项目地址: https://gitcode.com/gh_mirrors/gi/github-dashboard