Module: JekyllAeo::Generators::LlmsTxt

Defined in:
lib/jekyll-aeo/generators/llms_txt.rb

Class Method Summary collapse

Class Method Details

.build_sections(eligible, llms_config) ⇒ Object 



54
55
56
57
58
59
60
61
62
 
# File 'lib/jekyll-aeo/generators/llms_txt.rb', line 54

def self.build_sections(eligible, llms_config)
  custom_sections = llms_config["sections"]

  if custom_sections
    build_custom_sections(eligible, custom_sections)
  else
    build_auto_sections(eligible)
  end
end

.collect_eligible(site, config) ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/jekyll-aeo/generators/llms_txt.rb', line 22

def self.collect_eligible(site, config)
  items = []

  site.documents.each do |doc|
    next unless JekyllAeo::Utils::IncludeLogic.include?(doc, site, config)

    items << {
      obj: doc,
      title: title_for(doc),
      description: doc.data["description"] || "",
      url: doc.url,
      collection: doc.collection&.label,
      dest_md: md_dest_path(doc, site)
    }
  end

  site.pages.each do |page|
    next unless JekyllAeo::Utils::IncludeLogic.include?(page, site, config)

    items << {
      obj: page,
      title: title_for(page),
      description: page.data["description"] || "",
      url: page.url,
      collection: nil,
      dest_md: md_dest_path(page, site)
    }
  end

  items
end

.generate(site) ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/jekyll-aeo/generators/llms_txt.rb', line 8

def self.generate(site)
  config = JekyllAeo::Config.from_site(site)
  return if config["enabled"] == false

  llms_config = config["llms_txt"] || {}
  return if llms_config["enabled"] == false

  eligible = collect_eligible(site, config)
  sections = build_sections(eligible, llms_config)

  llms_txt = build_llms_txt(site, sections, llms_config, config)
  File.write(File.join(site.dest, "llms.txt"), llms_txt)
end

.md_dest_path(obj, site) ⇒ Object 



64
65
66
 
# File 'lib/jekyll-aeo/generators/llms_txt.rb', line 64

def self.md_dest_path(obj, site)
  JekyllAeo::Utils::MdUrl.dest_path(obj, site)
end

.md_url(url, baseurl = "") ⇒ Object 



68
69
70
 
# File 'lib/jekyll-aeo/generators/llms_txt.rb', line 68

def self.md_url(url, baseurl = "")
  JekyllAeo::Utils::MdUrl.for(url, baseurl)
end