Obsidian Global Proxy 使用教程

Obsidian Global Proxy 使用教程

obsidian-global-proxy 🚀 Obsidian Global Proxy is an Obsidian plugin that makes it easy to configure web proxies and use proxies throughout Obsidian. 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-global-proxy

1. 项目目录结构及介绍

Obsidian Global Proxy 插件的目录结构相对简单，主要包括以下几个部分：

• assets/：存放与插件相关的静态资源文件。
• LICENSE：插件的许可文件，采用 MIT 许可协议。
• README.md：插件的说明文档，详细介绍插件的功能和使用方法。
• main.js：插件的主执行文件，包含插件的逻辑代码。
• manifest.json：插件的配置文件，定义了插件的元数据和权限。

2. 项目的启动文件介绍

main.js 是 Obsidian Global Proxy 插件的主要执行文件。以下是该文件的基本结构：

// 引入需要的模块和API

// 插件的初始化函数
function initialize() {
  // 初始化代码
}

// 插件的启动函数
function activate() {
  // 启动代码
}

// 插件的停用函数
function deactivate() {
  // 停用代码
}

// 注册插件
app.plugins.register({
  id: 'obsidian-global-proxy',
  name: 'Obsidian Global Proxy',
  description: 'Obsidian 插件，用于配置和代理网络请求',
  version: '1.0.4',
  activate,
  deactivate
});

// 执行初始化
initialize();

在这个文件中，定义了插件的初始化、激活和停用逻辑。通过注册插件，Obsidian 会在启动时自动调用 activate 函数，停用时调用 deactivate 函数。

3. 项目的配置文件介绍

manifest.json 文件是插件的配置文件，它定义了插件的元数据和权限。以下是配置文件的一个基本示例：

{
  "id": "obsidian-global-proxy",
  "name": "Obsidian Global Proxy",
  "description": "Obsidian 插件，用于配置和代理网络请求",
  "version": "1.0.4",
  "author": "windingblack",
  "url": "https://github.com/windingblack/obsidian-global-proxy",
  "minAppVersion": "0.12.0",
  "maxAppVersion": "1.0.0",
  "permissions": ["network", "config"],
  "icons": {
    "16": "icons/icon16.png",
    "32": "icons/icon32.png",
    "48": "icons/icon48.png",
    "64": "icons/icon64.png"
  },
  "activate": "main.js",
  "deactivate": "main.js"
}

在这个配置文件中，定义了插件的唯一标识符、名称、描述、版本、作者、URL、支持的 Obsidian 版本范围、权限、图标以及激活和停用脚本路径等信息。这些配置项是插件正常运行的关键。

obsidian-global-proxy 🚀 Obsidian Global Proxy is an Obsidian plugin that makes it easy to configure web proxies and use proxies throughout Obsidian. 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-global-proxy