Neat URL 项目教程

Neat URL 项目教程

Neat-URL Neat URL cleans URLs, removing parameters such as Google Analytics' utm parameters. 项目地址: https://gitcode.com/gh_mirrors/ne/Neat-URL

1. 项目目录结构及介绍

Neat URL 项目目录结构如下：

Neat-URL/
├── .github/
│   └── workflows/
├── css/
├── data/
├── icons/
├── images/
├── web-ext-artifacts/
├── CHANGELOG.md
├── LICENSE.md
├── MOZILLA.md
├── README.md
├── TODO.md
├── background.js
├── browser-polyfill.min.js
├── build.sh
├── manifest.json
├── neaturl.js
├── options.html
├── options.js
├── package.json
├── shared.js
└── toolbaricon.js

• .github/workflows/: 存放 GitHub Actions 工作流的配置文件。
• css/: 存放项目的样式文件。
• data/: 存放项目所需的数据文件。
• icons/: 存放项目所需的小图标文件。
• images/: 存放项目所需的图片文件。
• web-ext-artifacts/: 存放构建产物的目录。
• CHANGELOG.md: 记录项目的更新日志。
• LICENSE.md: 项目所使用的开源协议文件。
• MOZILLA.md:可能与项目相关的Mozilla信息。
• README.md: 项目的说明文件。
• TODO.md: 记录项目待办事项。
• background.js: 扩展的背景脚本文件。
• browser-polyfill.min.js: 用于兼容旧版浏览器。
• build.sh: 构建脚本文件。
• manifest.json: 扩展的配置文件。
• neaturl.js: 核心功能实现脚本。
• options.html: 扩展的选项页面。
• options.js: 选项页面的JavaScript文件。
• package.json: 项目包配置文件。
• shared.js: 公共JavaScript函数文件。
• toolbaricon.js: 工具栏图标相关的脚本。

2. 项目的启动文件介绍

项目的启动主要是通过浏览器扩展的形式，用户在浏览器中安装该扩展后，可以通过以下步骤启动：

1. 打开浏览器的扩展页面。
2. 点击“加载已解压的扩展”。
3. 选择包含manifest.json文件的Neat URL项目文件夹。
4. 浏览器将加载扩展，此时扩展的背景脚本background.js将会自动运行。

manifest.json 文件是扩展的启动文件，它定义了扩展的基本信息和权限，例如：

{
  "manifest_version": 2,
  "name": "Neat URL",
  "version": "1.0",
  "description": "Clean URLs by removing parameters such as Google Analytics' utm parameters.",
  // 其他配置...
}

3. 项目的配置文件介绍

项目的配置主要通过manifest.json文件进行。以下是manifest.json的一些基本配置项：

• manifest_version: 指定了扩展使用的manifest版本。
• name: 扩展的名称。
• version: 扩展的版本号。
• description: 扩展的描述。
• permissions: 扩展需要的权限列表。
• background: 背景脚本的配置，可以是脚本文件或对象。
• options_page: 扩展的选项页面。

另外，项目的配置也可以通过扩展的选项页面进行，用户可以在options.html页面中设置自定义的URL参数过滤规则。options.js文件用于处理选项页面的逻辑，如读取和保存用户的配置。

这些配置文件是项目运行的基础，确保扩展能够按照用户的需求正常工作。

Neat-URL Neat URL cleans URLs, removing parameters such as Google Analytics' utm parameters. 项目地址: https://gitcode.com/gh_mirrors/ne/Neat-URL