Pandoc Lua 过滤器 - pandoc.format 模块

这是关于 Pandoc 支持的格式的信息模块。

Functions

all_extensions

all_extensions (format)

返回指定格式的所有有效扩展名列表。此功能不区分输入和输出;某些扩展名可能仅在读取格式时生效而写入时无效,反之亦然。

参数 描述
format 格式名称( string

返回:

  • 所有受支持的format扩展名 (FormatExtensions)

自版本: 3.0

default_extensions

default_extensions (format)

返回给定格式的默认扩展名列表;此功能不会检查该格式是否被支持,对于未知格式也会返回一组默认扩展名。

参数 描述
format 格式名称( string

返回:

  • format启用的默认扩展名 (FormatExtensions)

自版本: 3.0

extensions

extensions (format)

返回给定格式的扩展名配置。配置表示为一个表格,其中所有支持的扩展名作为键,其默认状态作为值,true 表示该扩展名默认已启用,而 false 表示支持但未启用的扩展名。

此功能可用于在自定义读取器和写入器中设置 Extensions 全局变量。

参数 描述
format 格式标识符( string

返回:

  • 扩展名配置(表格)

自版本: 3.0

from_path

from_path (path)
参数 描述
path 文件路径或路径列表(string | {string, ...}

返回:

  • 通过启发式确定的格式( string | nil

自版本: 3.1.2

在本文档中