BindFigma

BindFigma 是一个预处理器，可以从Figma下载设计布局图像并选择调整其大小，并将这些图像与文档项目绑定。

预处理器使用Figma REST API来获取要下载的图像的 URL。要使用预处理器，您应该通过您的 Figma 帐户获取它的访问令牌。

如果您需要调整下载图像的大小，您应该安装ImageMagick。

安装

$ pip install foliantcontrib.bindfigma

配置

要启用预处理器，请添加bindfigma到preprocessors项目配置中的部分：

preprocessors:
    - bindfigma

预处理器有许多具有以下默认值的选项：

preprocessors:
    - bindfigma:
        cache_dir: !path .bindfigmacache
        api_caching: disabled
        convert_path: convert
        caption: ''
        hyperlinks: true
        multi_delimeter: '\n\n'
        resize: null
        access_token: null
        file_key: null
        ids: null
        scale: null
        format: null
        svg_include_id: null
        svg_simplify_stroke: null
        use_absolute_bounds: null
        version: null

项目配置中指定的某些选项值可能会被标签属性覆盖，见下文。

cache_dir ：存储缓存的 API 响应、下载和调整大小的图像的目录。

api_caching : API 响应缓存模式。可用值：disabled— 无条件关闭；enabled——无条件开启；env— 仅在FOLIANT_FIGMA_CACHING设置环境变量时打开，否则关闭。如果打开此模式，预处理器会在本地缓存 Figma API 响应并使用缓存数据而不是执行 API 请求。在这种情况下，不更改 API URL 的 Figma 节点更新可能不会生效。

convert_path : 二进制路径convert，ImageMagick 的一部分。如果不需要调整大小，则不会使用 ImageMagick。

caption : 图片说明。标题中的{{image_id}}占位符将替换为 Figma 节点 ID。

hyperlinks ：告诉预处理器将图像引用包装到相关 Figma URL 的超链接中的标志。

multi_delimeter : 应该分隔多个图像引用的字符串。

resize ：结果图像的宽度（以像素为单位）。如果未指定，则不执行调整大小。

access_token ：您可以在 Figma 帐户中生成的访问令牌。

file_key : Figma 文件的 ID。

ids : Figma 文件中节点的一个或多个 ID。可以指定为列表或逗号分隔的字符串。

scale, format, svg_include_id, svg_simplify_stroke, use_absolute_bounds, version : 在 Figma API 请求中使用的查询参数，参见Figma API 文档中的描述。

用法

要将 Figma 中的设计布局图像插入到文档中，请<<figma>...</figma>在 Markdown 源代码中使用标签：

Here’s an image from Figma:

<<figma caption="An optional caption" resize="300" file_key="ABC" ids="node1,node2,node3"></figma>

您可以使用标签属性来覆盖具有相同名称的项目配置选项的值。除cache_dir,api_caching和之外的所有选项convert_path都可以通过这种方式覆盖。

BindFigma 预处理器将使用本地图像引用替换此类语句。如果ids引用多个图像，将生成一组图像引用。多个图像引用将使用指定为 的字符串分隔multi_delimeter。