Linkding Injector 项目教程
1. 项目的目录结构及介绍
Linkding Injector 项目的目录结构如下:
linkding-injector/
├── docs/
├── icons/
├── options/
├── scss/
├── src/
├── styles/
├── .gitignore
├── CHANGELOG.md
├── LICENSE
├── README.md
├── build.ps1
├── build.sh
├── manifest.json
├── package-lock.json
├── package.json
└── rollup.config.js
目录介绍
- docs: 存放项目文档。
- icons: 存放扩展图标。
- options: 存放选项页面的相关文件。
- scss: 存放 SCSS 样式文件。
- src: 存放源代码文件。
- styles: 存放编译后的 CSS 文件。
- .gitignore: Git 忽略文件配置。
- CHANGELOG.md: 项目更新日志。
- LICENSE: 项目许可证。
- README.md: 项目说明文档。
- build.ps1: Windows 平台构建脚本。
- build.sh: Linux/Mac 平台构建脚本。
- manifest.json: Chrome 扩展的清单文件。
- package-lock.json: npm 依赖锁定文件。
- package.json: npm 项目配置文件。
- rollup.config.js: Rollup 构建配置文件。
2. 项目的启动文件介绍
Linkding Injector 项目的启动文件主要是 manifest.json
和 src
目录下的入口文件。
manifest.json
manifest.json
是 Chrome 扩展的清单文件,包含了扩展的基本信息和配置。以下是关键部分:
{
"manifest_version": 2,
"name": "linkding injector",
"version": "1.0",
"description": "Injects search results from the linkding bookmark service into search pages like google and duckduckgo",
"icons": {
"16": "icons/icon16.png",
"48": "icons/icon48.png",
"128": "icons/icon128.png"
},
"permissions": [
"activeTab",
"storage",
"https://*/*"
],
"background": {
"scripts": ["src/background.js"],
"persistent": false
},
"content_scripts": [
{
"matches": ["https://*/*"],
"js": ["src/content.js"]
}
],
"options_ui": {
"page": "options/options.html",
"open_in_tab": true
},
"browser_action": {
"default_icon": "icons/icon16.png",
"default_popup": "options/options.html"
}
}
src 目录
src
目录包含了主要的 JavaScript 文件,其中 background.js
和 content.js
是关键的启动文件。
- background.js: 后台脚本,处理扩展的后台逻辑。
- content.js: 内容脚本,注入到网页中执行。
3. 项目的配置文件介绍
Linkding Injector 项目的配置文件主要是 manifest.json
和 options
目录下的配置页面。
manifest.json
如上所述,manifest.json
包含了扩展的基本信息和权限配置。
options 目录
options
目录包含了扩展的配置页面 options.html
和相关的 JavaScript 文件 options.js
。
- options.html: 配置页面的 HTML 文件。
- options.js: 配置页面的 JavaScript 文件,处理用户输入和存储配置。
通过这些配置文件和页面,用户可以配置 Linkding Injector 扩展,连接到他们的 Linkding 实例,并进行相应的设置。