叶用sympli集成预处理器。
foliantcontrib.bindsympli的Python项目详细描述
BindSympli
bind sympli是一个工具,可以使用特定的sympli帐户从Symplicdn下载设计布局图像,调整这些图像的大小,并将它们与文档项目绑定。
安装
在使用bindsympli之前,需要安装Node.js、Puppeteer、wget和ImageMagick。
bindsympli预处理器代码是用python编写的,但它使用javascript编写的外部脚本。此脚本在bindsmpli包中提供:
$ pip install foliantcontrib.bindsympli
配置
要启用预处理器,请将bindsympli
添加到项目配置中的preprocessors
部分:
preprocessors:-bindsympli
预处理器有许多具有以下默认值的选项:
preprocessors:-bindsympli:get_sympli_img_urls_path:get_sympli_img_urls.jswget_path:wgetconvert_path:convertcache_dir:!path.bindsymplicachesympli_login:''sympli_password:''image_width:800max_attempts:5
get_sympli_img_urls_path
:脚本get_sympli_img_urls.js
或启动脚本的替代命令(例如node some_another_script.js
)的路径。默认情况下,假设您在PATH
中拥有此命令和所有其他命令。
wget_path
:指向wget
二进制文件的路径。
convert_path
:指向convert
二进制文件(imagemagick的一部分)的路径。
cache_dir
:存储已下载和调整大小的图像的目录。
sympli_login
:sympli帐户中的用户名。
sympli_password
:sympli帐户中的密码。
image_width
:结果图像的宽度(像素)(原始图像太大)。
max_attempts
运行脚本的最大次数{{CD4}}失败。
用法
要将sympli中的设计布局图像插入到文档中,请使用标记源中的<<sympli>...</sympli>
标记:
Here’s an image from Sympli: <<sympli caption="An optional caption" width="400" url="https://app.sympli.io/app#!/designs/0123456789abcdef01234567/specs/assets"></sympli>
必须在url
属性中指定sympli设计布局页的url。
您可以在caption
属性中指定可选的标题,在width
属性中指定可选的自定义图像宽度。属性width
覆盖特定图像的image_width
配置选项。
bindsympli预处理器将用本地图像引用替换这些块。