Shiori Web Extension 使用教程

Shiori Web Extension 使用教程

shiori-web-ext项目地址:https://gitcode.com/gh_mirrors/sh/shiori-web-ext

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

Shiori Web Extension 是一个用于在 Firefox 和 Chrome 浏览器中管理书签的扩展。以下是其目录结构的详细介绍：

shiori-web-ext/
├── css/
├── docs/
├── icons/
├── js/
├── less/
├── view/
├── .gitignore
├── LICENSE
├── Makefile
├── README.md
├── manifest.json
└── updates.json

• css/: 包含扩展使用的 CSS 文件。
• docs/: 包含项目的文档文件。
• icons/: 包含扩展使用的图标文件。
• js/: 包含扩展使用的 JavaScript 文件。
• less/: 包含扩展使用的 LESS 文件。
• view/: 包含扩展的视图文件。
• .gitignore: Git 忽略文件。
• LICENSE: 项目的许可证文件。
• Makefile: 用于构建项目的 Makefile。
• README.md: 项目的说明文档。
• manifest.json: 扩展的清单文件。
• updates.json: 扩展的更新文件。

2. 项目的启动文件介绍

Shiori Web Extension 的启动文件主要是 manifest.json。这个文件定义了扩展的基本信息和启动配置。以下是 manifest.json 的主要内容：

{
  "manifest_version": 2,
  "name": "Shiori Web Extension",
  "version": "1.0",
  "description": "A simple extension for managing bookmarks using Shiori.",
  "icons": {
    "48": "icons/shiori-48.png"
  },
  "browser_action": {
    "default_icon": "icons/shiori-48.png",
    "default_title": "Shiori",
    "default_popup": "view/popup.html"
  },
  "permissions": [
    "activeTab",
    "storage"
  ],
  "background": {
    "scripts": ["js/background.js"]
  }
}

• manifest_version: 指定清单文件的版本。
• name: 扩展的名称。
• version: 扩展的版本号。
• description: 扩展的描述。
• icons: 扩展的图标。
• browser_action: 定义浏览器动作，包括图标、标题和弹出窗口。
• permissions: 扩展所需的权限。
• background: 定义后台脚本。

3. 项目的配置文件介绍

Shiori Web Extension 的配置文件主要是 updates.json。这个文件定义了扩展的更新信息。以下是 updates.json 的主要内容：

[
  {
    "addons": {
      "shiori-web-ext@example.com": {
        "updates": [
          {
            "version": "1.0",
            "update_link": "https://example.com/shiori-web-ext-1.0.xpi"
          }
        ]
      }
    }
  }
]

• addons: 包含扩展的更新信息。
• shiori-web-ext@example.com: 扩展的唯一标识符。
• updates: 包含扩展的更新列表。
• version: 更新的版本号。
• update_link: 更新的下载链接。

以上是 Shiori Web Extension 的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用这个扩展。

shiori-web-ext项目地址:https://gitcode.com/gh_mirrors/sh/shiori-web-ext