Pelican YAML Metadata

此Pelican插件允许使用Markdown编写的文章通过YAML标题定义元数据。此格式与Jekyll或Hugo等其他流行的静态站点生成器兼容。

它与默认的元数据解析完全向后兼容。

安装

此插件可以通过

python -m pip install pelican-yaml-metadata

只要您没有明确地将PLUGINS设置添加到Pelican配置文件中，新安装的插件应自动检测并启用。否则，您必须将yaml_metadata添加到现有的PLUGINS列表中。有关更多信息，请参阅如何使用插件文档。

用法

此插件旨在保持简单。安装并启用它后，任何Markdown文件都将可以选择使用YAML头定义元数据，而不是使用标准的键/值对。

为了使用YAML指定元数据，请将其括在---行内。

示例

---
title: Some title
author: Some person
tags:
  - tag 1
  - tag 2
date: 2014-12-25 00:00
summary: The article summary will be __parsed__ as markdown
---

This is some article text.

如果找不到YAML块，将使用正常的Markdown元数据语法解析元数据。

贡献

欢迎并非常感谢贡献。每一份努力都很重要。您可以通过改进文档、添加缺失的功能和修复错误来做出贡献。您还可以通过审阅和评论现有问题来提供帮助。

要开始为此插件做出贡献，请审阅为Pelican做出贡献文档，从代码贡献部分开始。

许可

本项目采用MIT许可证。