Obsidian 图片画廊插件安装与使用指南
1. 项目目录结构及介绍
Obsidian Image Gallery 是一个专为 Obsidian 设计的零配置图片画廊插件,它允许用户轻松创建美观的图片陈列效果,无需复杂设置。以下是该插件的基本目录结构示例:
obsidian-image-gallery/
│ ├── src # 源代码目录
│ ├── main.ts # 主入口文件,负责插件的核心逻辑
│ └── ... # 其他TypeScript源码文件
├── dist # 编译后的产出目录,包含实际在Obsidian中运行的JavaScript文件
│ └── index.js # 编译后的主执行文件
├── styles # 样式表目录,存放CSS文件用于美化画廊
│ └── index.css # 主样式表
├── package.json # Node.js项目的配置文件,记录依赖和脚本命令
└── README.md # 插件说明文档,包括安装和使用方法
2. 项目的启动文件介绍
这个插件不需要用户手动“启动”,它的激活和使用是在 Obsidian 笔记应用程序内部进行的。不过,从开发者的角度看,主要的启动流程由 src/main.ts
文件控制。当你在开发环境中修改了插件代码并重新构建时,变化会影响到插件的行为。对普通用户来说,只需通过Obsidian的插件管理界面安装即可开始使用。
3. 项目的配置文件介绍
虽然插件自身带有默认配置,并且用户可以不通过直接编辑文件来调整设置,但理解其背后的配置机制是有帮助的。用户可以通过在笔记中使用特定的语法来自定义画廊,例如:
```img-gallery path: Attachments/Folder type: horizontal```
这里的配置是通过Markdown代码块的形式实现的,其中:
- path:指定图片所在相对路径,这是用户自定义的。
- type(可选):设置画廊布局为水平(
horizontal
)或垂直(vertical
),默认为水平。
更深入地讲,用户也可以通过高级方式调整画廊的显示效果,但这通常不是通过一个单独的传统配置文件完成,而是利用插件提供的选项,在每张需要添加画廊的笔记内直接指定或者通过插件的设置页面进行调整。
这些选项覆盖了诸如图片之间的间距(gutter
)、图片边框圆角(radius
)以及排序依据(sortby
)等,而这些都可以在插件的设置界面找到详细的说明和定制选项,无需直接触碰项目源代码或额外的配置文件。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考