README

基于第一段内容创建摘要，最多包含指定数量的单词。

安装

推荐使用Composer进行安装。

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

配置

插件配置非常简单

## Configuração do plugin resumizer

plugins:
  Resumizer:
    # Caminho relativo/absoluto para o inicializador do plugin.
    source: "./vendor/meduza-static-site-generator/meduza-plugin-resumizer/Resumizer.php"
    # Número máximo de palavras do resumo
    maxWords: 30

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

使用

Resumizer通过复制第一段markdown内容，创建摘要或描述，直到达到在maxWords中定义的单词限制，并将其提供给主题（前提是主题支持）。

基本上，插件为每个页面的frontmatter添加了关键字resume、description和summary（如果尚未存在），它们包含页面的第一段内容（限制在maxWords内）。

插件的工作原理

它将markdown分割成一个数组，每行一对换行符，然后取数组的第一个元素，并限制它的长度为maxWords。

如何贡献

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

创建一个fork；
克隆fork并创建一个新的branch用于您的贡献；
将您的更改提交到fork；
创建一个pull request。

创建一个在官方仓库中的issue来记录您的更改，并在您的branch名称和commits中引用它。同时，在issue中引用您的pull request。这将加快您贡献的分析速度。

许可证

Resumizer采用MIT许可证

meduza-static-site-generator / meduza-plugin-resumizer

维护者

详细信息

README

安装

配置

使用

插件的工作原理

如何贡献

许可证