Package Exports

gatsby-plugin-llms-txt
gatsby-plugin-llms-txt/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gatsby-plugin-llms-txt) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

gatsby-plugin-llms-txt

A Gatsby plugin that generates an llms.txt file from your CMS content or other source during the build process.

What is llms.txt?

The llms.txt file is a proposed standard for providing context and instructions to Large Language Models (LLMs) about your website. It's similar to robots.txt but designed specifically for AI consumption.

Installation

npm install gatsby-plugin-llms-txt

yarn add gatsby-plugin-llms-txt

Usage

Add the plugin to your gatsby-config.js:

module.exports = {
    plugins: [
        {
            resolve: 'gatsby-plugin-llms-txt',
            options: {
                query: `
                    query {
                        settings {
                        llmsTxt
                        }
                    }
                `,
                contentPath: 'settings.llmsTxt',
            },
        },
    ],
};

Configuration

The plugin requires two configuration options:

`query` (required)

A GraphQL query string that fetches your llms.txt content from your CMS or other source.

`contentPath` (required)

A dot-notation path to the field containing your llms.txt content within the GraphQL query result.

Examples

Basic Sanity CMS Setup

{
  resolve: 'gatsby-plugin-llms-txt',
  options: {
    query: `
      {
        settings {
          llmsTxt
        }
      }
    `,
    contentPath: 'settings.llmsTxt'
  }
}

Nested Content Path

{
  resolve: 'gatsby-plugin-llms-txt',
  options: {
    query: `
      {
        site {
          siteMetadata {
            llmsContent
          }
        }
      }
    `,
    contentPath: 'site.siteMetadata.llmsContent'
  }
}

How it Works

During the build process (onPostBuild hook), the plugin executes your GraphQL query
It extracts the content using the specified contentPath
If content is found, it writes it to public/llms.txt
If no content is found or the field is empty, it skips file creation
The resulting file is accessible at yoursite.com/llms.txt

Requirements

Gatsby v4, or v5
A GraphQL data source (Sanity, Contentful, etc.)

Error Handling

The plugin will:

Log an error if the query option is missing
Log an error if the contentPath option is missing
Log a warning if no content is found and skip file creation
Log errors if the GraphQL query fails

Contributing

Issues and pull requests are welcome! Please check the issues page before submitting.

License

MIT