Obsidian本地图片插件使用手册

Obsidian本地图片插件使用手册

obsidian-local-images 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-local-images

概览

Obsidian本地图片插件是专为Obsidian桌面版设计的一款工具，它自动检测笔记中的外部图片链接，下载这些图片并保存至本地，随后更新笔记中的链接指向本地存储的图片。这样一来，即使原始网络图片丢失，您的笔记仍然保持完整。

安装指南

通过Obsidian社区插件库安装

1. 打开Obsidian。
2. 转到左侧边栏的设置页面。
3. 点击“社区插件”选项卡。
4. 在搜索框中输入“Obsidian Local Images”，找到该插件。
5. 点击插件旁的安装按钮进行安装。
6. 插件安装完成后重启Obsidian以激活。

开发环境搭建（仅适用于开发者）

如果您希望修改或贡献代码：

1. 克隆本仓库到本地。
2. 进入项目目录，运行npm install来安装依赖。
3. 使用命令npm run dev启动观察模式，插件将在改动时自动重新编译。
4. 创建一个符号链接指向您的Obsidian插件目录以方便测试：

   ln -s /path/to/your/plugin/folder /path/to/your/notes/dev/.obsidian/plugins/local-images
   

项目使用说明

基本操作

• 下载当前页面图片: 直接使用插件提供的命令处理当前正在查看的笔记页面上的所有外部图片。
• 批量下载全部图片: 对整个知识库中符合条件的所有页面执行此操作，您需要在插件设置里配置Include参数来指定哪些页面参与处理。

设置自动化

您可以开启插件设置中的选项，实现每当粘贴外部图片链接到活跃页面时自动下载图片，确保您的资源即时保存。

项目API使用文档

目前，这款插件主要是通过内部接口与Obsidian交互，并未直接向用户提供公开API。它的功能主要通过Obsidian的内置命令调用来实现，如需扩展或集成特定功能，可以探索其源码结构，利用Obsidian插件API进行定制开发。

注意事项

• 请在首次使用前备份您的知识库，以防万一。
• 此插件未经全面测试在移动设备上运行，但理论上可能兼容。
• 图片将被保存在每个笔记所在的知识库的media子目录下。
• 外部图片转换为本地存储后，确保您拥有必要的版权或许可，遵循适当的使用规范。

以上即是Obsidian本地图片插件的详尽使用手册，通过遵循上述步骤，您可以有效地管理并保护您的笔记中包含的图像资源。

obsidian-local-images 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-local-images