Skip to content

示例库

本页截图与代码均来自随插件发布的演示库,可直接打开对照。

下载中文演示库

参数语法 ​

所有参数都写在图片说明(alt)里,用 | 分隔。以 ag: 开头的字段是参数,第一个不以 ag: 开头的字段就是图注。

语法规则 ​

markdown
![图注|ag:layout=float|ag:side=right|ag:width=38%](assets/photo/11-shore.jpg)
规则说明
分隔符竖线 |,不能有空格以外的分隔
参数前缀必须以 ag: 开头,冒号后是键
赋值用 =,不用冒号
图注位置第一个非 ag: 字段,可以放在任意位置,但通常放最前
未知键保留不删,不报错;留给将来的版本
表格内竖线要写成 |,否则会被当成单元格分隔

十个参数 ​

参数取值作用生效范围
ag:layoutauto gallery float center覆盖自动布局单图
ag:sideleft right center指定方向,center 不浮动单图
ag:width10%–100%固定栏宽百分比,100% 等于满栏居中单图
ag:gap0–80(可省 px)浮动图与正文的间距仅浮动图
ag:cropW:H画幅比例,只显示其中一块单图、表格
ag:topx1:x2:y(各 0–100)裁剪框顶边的横向范围与纵向位置必须与 ag:crop 同写
ag:isolate标记 / =false把这张图移出画廊并切断前后分组任意
ag:exclude标记 / =false完全交回 Obsidian 原生渲染任意
ag:rows3,2手写行切分:从组内第一张开始每行几张,其余自动画廊
ag:group标记 / 正整数 / =false锁定整行绑定,相邻两行用不同 id画廊
同一个参数分别控制布局、宽度与浮动方向

同一个参数分别控制布局、宽度与浮动方向。

逐项说明 ​

ag:layout ​

覆盖自动判断。四个值:

  • auto;默认,交给宽度路由决定。
  • gallery;强制按画廊处理(即使只有一张)。
  • float;强制浮动,即使宽度超过 floatMax。
  • center;强制居中块,不浮动。

ag:side ​

指定水平位置。left / right 会浮动,center 等价于 ag:layout=center。模板的 floatAlignment 只决定「没写 side 时浮到哪边」,写了 side 就以它为准。

ag:width ​

固定栏宽百分比,合法区间 10%–100%。写了它,宽度路由不再计算,但浮动判断仍然生效;超过 floatMax 仍会居中。所以 ag:width=95% 得到的是一张居中的宽图,不是浮动图。

ag:gap ​

只影响浮动图与相邻正文的空隙,单位 px,可省略 px 后缀。它对画廊格间距无效;那个值在设置页里。

ag:crop ​

W:H 形式的画幅比例,例如 1:1、16:9、24:17。它只决定画框的形状,不决定位置;位置由 ag:top 给出。裁剪后的比例会参与宽度路由,所以裁剪会改变图片在页面上的宽度。

ag:top ​

x1:x2:y 三个数,各取 0–100:

字段含义
x1裁剪框左边界,占原图宽度的百分比
x2右边界
y上边界,占原图高度的百分比

只写一个纵坐标,是因为高度已经由 ag:crop 的比例推断出来。左右写反会自动交换,越界会自动夹紧。

没有 ag:crop 时,ag:top 会在下一次重写参数时被丢弃;这是一个高频坑。

ag:isolate ​

标记载荷,可以写 ag:isolate 也可以写 ag:isolate=true。效果:这张图移出当前画廊,并把它前后的分组切开(前面的图和后面的图不再合并)。图注保留,宽度仍由插件计算。

ag:exclude ​

完全交回 Obsidian:插件不设宽度、不加图注、不参与画廊。适合「这张图我要自己用 HTML 控制」的场景。

ag:rows ​

写在组内第一张上,逗号分隔的段长,例如 3,2。它只描述开头几行:段长按顺序消耗,最后一段在组内末尾截断,剩下的图片继续自动打包;六张图写 4,3,1 得到「四 + 二」,写 2,3 得到「二、三、一(自动)」。参数不会丢图,也不会由手势自动写入。指定的行会跳过最小行高限制,也不受「最大并列」约束。

ag:group ​

标记或正整数。同 id 的连续图片锁成一行;相邻两行必须用不同的 id,否则会被吞并。

已废弃的键 ​

fit、focus、top 这三个旧键不再有行为,但仍会被保留在源码里。新写法请用 ag:crop 与 ag:top。

参数生效范围速查 ​

参数画廊内单图列表表格Callout
ag:layout忽略是否否否
ag:width忽略是是否否
ag:side忽略是否否否
ag:gap忽略是否否否
ag:crop是是是是否
ag:top是是是是否
ag:isolate是是是否否
ag:exclude是是是是否
ag:rows是—否否否
ag:group是—否否否

下一步 ​

相关阅读 ​