将`icons`属性设置为`image`(或将其留空)指示AsciiDoc处理器使用图像作为图标。此页面默认定义了处理器在哪里查找这些图像文件,它会附加哪种图像文件扩展名,以及如何配置这两者。
启用基于图像的图标
要启用基于图像的图标,您需要在文档头部设置`icons`属性的值为`image`。
= 文档标题
图标:图片
这个设置不会影响对AsciiDoc文档的解析。它只影响转换器生成的输出。
默认图标目录和类型
默认情况下,AsciiDoc 处理器会根据 imagesdir
属性的值,在相对的 icons 目录中查找图标。如果你没有配置这些属性,那么该路径解析为 ./images/icons.
处理器不会寻找任何类型(即格式)的图标。相反,它会寻找具有 .png 文件扩展名的图标。
假设你的文档中有以下的NOTE警告块:
注意:记得买牛奶!
AsciiDoc处理器将把警告图标解析为路径[.path]./images/icons/note.png。
使用iconsdir配置图标目录
为了改变AsciiDoc处理器寻找图标的位置,你可以使用`iconsdir`属性指定一个不同的位置。
例如:
= 文档标题
:icons: image :iconsdir: icons
在转换此文档时,AsciiDoc处理器将在[.path]icons_目录中查找图像,而不是默认的[.path]./images/icons_目录。
使用icontype配置图标类型
如果图标路径是派生的,比如用于警示图标,或者图标宏的目标没有文件扩展名,AsciiDoc处理器将使用`icontype`属性来确定要查找的图像类型(即,格式)。默认情况下,该属性的值为`png`,因此处理器将寻找一个具有文件扩展名`.png`的图像。
你可以使用`icontype`文档属性来配置默认图标类型。
例如:
= 文档标题
:icons: image :icontype: svg
对于NOTE警告,AsciiDoc处理器现在会在`iconsdir`中寻找图片[.path]note.svg,而不是[.path]note.png。
如果目标具有文件扩展名,则会忽略图标宏的 icontype
属性值。只有在必须推断图标类型时才使用它。