Obsidian Local Images 插件使用教程

Obsidian Local Images 插件使用教程

项目目录结构及介绍

Obsidian Local Images 插件的目录结构如下：

obsidian-local-images/
├── .github/
│   └── workflows/
│       └── ci.yml
├── .obsidian/
│   └── plugins/
│       └── local-images/
│           ├── main.js
│           ├── manifest.json
│           └── styles.css
├── .gitignore
├── LICENSE
├── README.md
├── package.json
└── tsconfig.json

• .github/workflows/ci.yml: GitHub Actions 的 CI 配置文件。
• .obsidian/plugins/local-images/: 插件的核心文件夹，包含插件的主要逻辑和样式。
  • main.js: 插件的主文件，包含插件的主要逻辑。
  • manifest.json: 插件的清单文件，包含插件的基本信息。
  • styles.css: 插件的样式文件，定义插件的外观。
• .gitignore: Git 忽略文件列表。
• LICENSE: 项目的许可证。
• README.md: 项目的说明文档。
• package.json: 项目的依赖管理文件。
• tsconfig.json: TypeScript 配置文件。

项目的启动文件介绍

插件的启动文件是 .obsidian/plugins/local-images/main.js。这个文件包含了插件的主要逻辑，负责处理图片的本地化等功能。

项目的配置文件介绍

插件的配置文件是 .obsidian/plugins/local-images/manifest.json。这个文件包含了插件的基本信息，如插件的 ID、名称、版本等。

{
  "id": "obsidian-local-images",
  "name": "Local Images",
  "version": "1.0.0",
  "minAppVersion": "0.12.0",
  "description": "Automatically find and embed local images for your notes.",
  "author": "Aleksey Rezvov",
  "authorUrl": "https://github.com/aleksey-rezvov",
  "isDesktopOnly": false
}

• id: 插件的唯一标识符。
• name: 插件的名称。
• version: 插件的版本号。
• minAppVersion: 插件支持的最低 Obsidian 版本。
• description: 插件的描述。
• author: 插件的作者。
• authorUrl: 作者的链接。
• isDesktopOnly: 是否仅支持桌面版 Obsidian。