树叶的元数据。

foliantcontrib.meta的Python项目详细描述


树叶的元数据

此扩展名将meta generate命令添加到foliant中,后者将生成带有项目元数据的yaml文件。它还允许添加使用生成的元数据的其他元命令meta <command>

它还添加了预处理器meta,它在生成之前从文档中删除元数据块,并允许根据特定的元数据键在元块的位置插入格式化字符串。

安装

$ pip install foliantcontrib.meta

指定元数据

元数据可以在标记文件的开头使用YAML Front Matter格式指定:

---id:MAIN_DOCtitle:Description of the productkey:value---

meta generate命令

使用量

要生成元文件,请运行meta generate命令:

$ foliant meta generate

文档的元数据将出现在meta.yml文件中。

配置

meta generate命令现在只有一个选项。它在配置中的meta部分下指定:

meta:filename:meta.yml

filename :具有生成的项目元数据的yaml文件的名称。

meta预处理器

meta预处理器允许您在生成之前从标记源文件中删除元数据。如果某些后端不接受yaml前端语法,则可能需要这样做。

这个预处理器还为您提供了一个功能,我们称之为seeds

种子是一些小的字符串模板,如果元数据中提到了特定的键,则可以使用这些模板在结果文档中的元数据块之后添加一些文本。详细信息请参见seeds部分。

使用量

meta预处理器添加到foliant.yml的preprocessors部分,并指定所有种子:

preprocessors:-meta:delete_meta:trueseeds:section:'*Section"{value}"*'id:<anchor>{value}</anchor>

delete_meta :如果设置为true-将在生成之前从文档中删除元数据块。默认值:false

seeds :种子字典。详情见下一节。

种子

种子允许您根据元数据块中提到的特定键添加小块文本。例如,如果希望在文档的开头添加一个子选项(该子选项将使用此文档的标题),请添加title种子:

preprocessors:-meta:seeds:title:'*Section"{value}"*'

如果文档中有这样的元块:

---ID:legal_inforelates:index.mdtitle:Legal information---# Terms of use

预处理器将注意到在元块中使用了title键,并将添加种子,其中{value}占位符替换为title字段的值:

*Section "Legal information"

# Terms of use

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java如何通过InjectMocks注释注入真实对象   多线程如何减少Java parallelStream中的#个线程?   java检测所有安卓摄像头   java中多个构造函数的参数   Spark SQL load json抛出错误java。lang.NoClassDefFoundError:scala/collection/GenTraversableOnce$class   java如何在ServerSocket中获得挂起的请求数或接受请求而不阻塞?   java JaxWsPortProxyFactoryBean查询超时   java Spring MVC LightAdmin配置   java类类型列表不一致性   安卓自定义视图,以在Java中动态插入到布局中   如果我使用安卓,java如何使用replace()方法。支持v4。应用程序。碎片   为什么Java中的数组不能使用类型擦除?   基于java JBoss EJB的Web服务日期格式   如何在java中实现负载均衡器   java OSGI OBR存储库托管?