在编写技术文档时,AsciiDoc以其简洁和高效的语法而受到广泛欢迎,特别是在程序员和技术作家中。然而,如何在文档中添加自定义图标,如警告、注意、提示等,常常成为初学者面临的挑战。本文将通过一个实际的例子,介绍如何在AsciiDoc文档中使用自定义图标。
背景介绍
在使用Visual Studio Code的AsciiDoc扩展时,我尝试为文档添加带有图标的admonition(告诫)。根据文档和示例,仅仅在文档头部添加:icons:
是不够的,因为我的工作目录中没有相关的图片文件。
解决方案
使用:iconsdir:
和:icontype:
首先,我们需要设置两个关键的文档属性:
:iconsdir:
:指定图标文件所在的目录。:icontype:
:指定图标的类型(如PNG、SVG等)。
在文档的顶部,我们可以这样配置: