README

根据 frontmatter 中的数据创建内容目录。

安装

推荐的安装方法是使用 Composer

composer require meduza-static-site-generator/meduza-plugin-catloger

配置

插件的配置非常简单

## Configuração do plugin catloger

plugins:
  Catloger:
    # Caminho relativo/absoluto para o inicializador do plugin.
    source: "./vendor/meduza-static-site-generator/meduza-plugin-catloger/Catloger.php"
    # Coleção de chaves do frontmatter que, se existirem, serão catalogadas.
    # Cada item de ```catalog``` corresponde a um par chave => valor, onde "chave" é a chave do frontmatter a ser catalogada 
    # e "valor" é o nome do catálogo em que essa chave será armazenada.
    catalog:
      layout: layout
      tag: tag
      tags: tag
      category: category
      categories: category
      categoria: category
      categorias: category
    

我们在项目的根目录提供了一个配置文件 catloger.yml，其中包含所有选项的文档。在您的配置文件中包含或使用 import 导入配置。

使用

Catloger 从 frontmatter 的键创建一个或多个内容目录。

考虑示例配置，将创建3个目录，分别称为 layout、tag 和 category。

layout 目录将包含基于 frontmatter 的 layout 值的一组内容。

tag 目录将包含基于 frontmatter 的 tag 和 tags 值的一组内容。

category 目录将包含基于 frontmatter 的 category、categories、categoria 和 categorias 值的一组内容。

也就是说，layout 目录将由所有在所有内容文件的 frontmatter 的 layout 属性中找到的“键”和“值”对组成，其中“值”是一个包含所有与“键”值相关联的内容（Meduza\Content\Content 类的实例）的数组。

任何其他配置的目录也是如此。

目录通过变量 plugins.data.catloger.catalog 提供给主题和模板。因此，要处理 layout 目录，模板将访问 plugins.data.catloger.catalog.layout。

如何贡献

要为项目做出贡献，请执行以下操作

• 创建一个 fork；
• 克隆 fork 并为您的贡献创建一个新 branch；
• 将您的更改发送到 fork；
• 创建一个 pull request。

创建一个在官方存储库中针对您的更改的 issue，并在您的 branch 名称和 commits 中引用它。还请在 issue 中引用您的 pull request。这将加快对您贡献的分析。

许可证

Resumizer 根据 MIT 许可证 许可。