0.0
No release in over 3 years
Generates llms.txt and Markdown sidecars for Jekyll pages and posts.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 5.0
~> 0.16
~> 13.0
~> 0.22

Runtime

>= 4.0, < 5.0
 Project Readme

jekyll-llms

Jekyll plugin that produces LLM-friendly formats alongside a regular website.

Namely: llms.txt, Markdown sidecars, and HTML alternate links to sidecars.

Installation

Add to Gemfile and run bundle install

group :jekyll_plugins do
  gem "jekyll-llms"
end

Add to _config file:

plugins:
  - jekyll-llms

Output

  • /llms.txt: Markdown index of included entries.
  • *.md: source-body sidecars for included Markdown-source entries.
  • HTML <link rel="alternate" type="text/markdown" href="..."> tags pointing to sidecars.

Sidecars are source bodies, not HTML-to-Markdown conversions. Front matter is removed. Liquid is rendered unless render_with_liquid: false is set. HTML-source entries stay linked by their original URLs.

Configuration

llms:
  markdown: true
  llms_txt: true
  include:
    - pages
    - posts
  exclude:
    - /README.md
    - /CHANGELOG.md
    - /404.html
    - /assets/**
  • markdown: generate sidecars for Markdown sources, link llms.txt to those sidecars, and add HTML alternate links. Default: true.
  • llms_txt: generate /llms.txt. Default: true.
  • include: pages, posts, and output collection names. Default: [pages, posts].
  • exclude: URL, Markdown path, or source path globs. Default: [/README.md, /CHANGELOG.md].

Per-entry opt-out:

llms: false

License

MIT. See LICENSE.txt.