Question

我想对Jekyll Only First Paragraph plugin进行更改，以便将'read more'链接生成为可配置选项。

要做到这一点，我需要能够访问插件AssetFilter中的Jekyll站点配置。有了可用的配置，我可以进行更改。我不知道如何使插件可以使用网站配置。

下面的代码演示了我希望site.config可用的位置：

require 'nokogiri'

module Jekyll
  module AssetFilter
    def only_first_p(post)
      # site.config needs to be available here to modify the output based on the configuration

      output = "<p>"
      output << Nokogiri::HTML(post["content"]).at_css("p").inner_html
      output << %{</p><a class="readmore" href="#{post["url"]}">Read more</a>}

      output
    end
  end
end

Liquid::Template.register_filter(Jekyll::AssetFilter)

这可以实现吗？

Answer 1

概述

您可以使用以下命令访问插件中的Jekyll配置选项：

Jekyll.configuration({})['KEY_NAME']

如果配置密钥包含嵌套级别，则格式为：

Jekyll.configuration({})['KEY_LEVEL_1']['KEY_LEVEL_2']

实施例

如果_config.yml包含：

testvar: new value

custom_root:
    second_level: sub level data

简单输出这些值的基本示例如下所示：

require 'nokogiri'

module Jekyll
  module AssetFilter
    def only_first_p(post)

      @c_value = Jekyll.configuration({})['testvar']
      @c_value_nested = Jekyll.configuration({})['custom_root']['second_level']

      output = "<p>"

      ### Confirm you got the config values
      output << "<br />"
      output << "c_value: " + @c_value + "<br />"
      output << "c_value_nested: " + @c_value_nested + "<br />"
      output << "<br />"
      ###

      output << Nokogiri::HTML(post["content"]).at_css("p").inner_html
      output << %{</p><a class="readmore" href="#{post["url"]}">Read more</a>}

      output
    end
  end
end

Liquid::Template.register_filter(Jekyll::AssetFilter)

当然，您可能希望在尝试使用它们之前验证是否已定义配置键/值。这是留给读者的练习。

另一种可能的选择

Jekyll Plugins Wiki Page的“液体过滤器”部分包含以下内容：

在Jekyll中，您可以通过寄存器访问站点对象。例如，您可以像这样访问全局配置（_config.yml）：@ context.registers [：site] .config ['cdn']。

我没有花时间让它工作，但也可能值得一试。

Answer 2

Jekyll.configuration({})['KEY_NAME']将中断--config命令行选项，因为它将始终从_config.yml文件加载配置。另一个不好的副作用是它会再次读取_config.yml文件。

context.registers[:site].config['KEY_NAME']是正确的答案，因为它将从Jekyll已经加载的配置中获取密钥。

Answer 3

如果您正在使用Generators（也是插件），可以获得如下配置：

class MyPlugin < Jekyll::Generator
  def generate(site)
    puts site.config["max_posts"] # max_posts as defined in _config.yml

您将该网站作为参数，并且.config可以作为哈希值访问。

获取Jekyll配置内插件

3 个答案:

概述

实施例

另一种可能的选择