【亲测免费】 Obsidian Image Auto Upload 插件使用教程

Obsidian Image Auto Upload 插件使用教程

项目的目录结构及介绍

Obsidian Image Auto Upload 插件的目录结构如下：

obsidian-image-auto-upload-plugin/
├── .github/
│   └── workflows/
├── src/
├── .gitignore
├── .prettierrc.json
├── CHANGELOG.md
├── LICENSE
├── LICENSE.txt
├── README.md
├── manifest.json
├── package-lock.json
├── package.json
├── readme-zh.md
├── rollup.config.js
├── tsconfig.json
├── versions.json
└── workspace.code-workspace

目录结构介绍

• .github/workflows: 包含 GitHub Actions 的工作流配置文件。
• src: 插件的源代码目录。
• .gitignore: Git 忽略文件配置。
• .prettierrc.json: Prettier 代码格式化配置文件。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证文件。
• LICENSE.txt: 项目许可证文本文件。
• README.md: 项目说明文档。
• manifest.json: Obsidian 插件的清单文件。
• package-lock.json: npm 依赖锁定文件。
• package.json: npm 项目配置文件。
• readme-zh.md: 中文项目说明文档。
• rollup.config.js: Rollup 打包配置文件。
• tsconfig.json: TypeScript 配置文件。
• versions.json: 版本信息文件。
• workspace.code-workspace: VS Code 工作区配置文件。

项目的启动文件介绍

Obsidian Image Auto Upload 插件的启动文件主要是 src 目录下的文件。具体启动逻辑在 src 目录中的入口文件中定义。

项目的配置文件介绍

manifest.json

manifest.json 是 Obsidian 插件的清单文件，包含插件的基本信息和配置。示例如下：

{
  "id": "obsidian-image-auto-upload-plugin",
  "name": "Image Auto Upload Plugin",
  "version": "1.0.0",
  "minAppVersion": "0.12.0",
  "description": "This plugin can help you to auto upload image by PicGo, PicGo-Core, PicList.",
  "author": "renmu123",
  "authorUrl": "https://github.com/renmu123",
  "isDesktopOnly": false
}

package.json

package.json 是 npm 项目的配置文件，包含项目的依赖、脚本等信息。示例如下：

{
  "name": "obsidian-image-auto-upload-plugin",
  "version": "1.0.0",
  "description": "This plugin can help you to auto upload image by PicGo, PicGo-Core, PicList.",
  "main": "main.js",
  "scripts": {
    "build": "rollup -c rollup.config.js",
    "dev": "rollup -c rollup.config.js --watch"
  },
  "author": "renmu123",
  "license": "MIT",
  "dependencies": {
    "obsidian": "^0.12.0"
  },
  "devDependencies": {
    "@rollup/plugin-commonjs": "^17.0.0",
    "@rollup/plugin-node-resolve": "^11.0.0",
    "rollup": "^2.3.4",
    "typescript": "^4.1.3"
  }
}

tsconfig.json

tsconfig.json 是 TypeScript 项目的配置文件，包含 TypeScript 编译选项。示例如下：

{
  "compilerOptions": {
    "target": "ES2018",
    "module": "ESNext",
    "outDir": "./dist",
    "rootDir": "./src",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["src/**/*"]