Skip to content
This repository was archived by the owner on Aug 28, 2025. It is now read-only.

ColdranAI/next-llms-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Next.js LLMS.TXT Generator

image

Generate LLM-friendly text files from Next.js applications

npm version TypeScript License: MIT

Automatically generates LLM-friendly content from Next.js applications by crawling sitemaps and extracting clean content.

Installation

npm install next-llms-generator

Basic Usage

Create a route handler:

// app/llms.txt/route.ts
export { GET } from "next-llms-generator/route";

Access your content at /llms.txt - that's it!

Advanced Usage

Custom Configuration

// app/llms.txt/route.ts
import { createGET } from "next-llms-generator/route";

export const GET = createGET({
  generatorOptions: {
    maxPages: 1000,
    excludePatterns: [/\/admin\//i, /\/api\//i],
    includePatterns: [/\/blog\//i, /\/docs\//i],
    stripSelectors: ['header', 'footer', 'nav'],
    headerTitle: 'My Site'
  },
  enableCache: true,
  cacheTtl: 60
});

Programmatic Usage

import { LLMSGenerator } from "next-llms-generator/generate";

const generator = new LLMSGenerator({
  siteUrl: 'https://example.com',
  maxPages: 1000
});

const content = await generator.generate();

CLI Usage

next-llms-generator
next-llms-generator --output dist/content.txt

Environment Variables

NEXT_PUBLIC_SITE_URL=https://example.com
LLMS_MAX_PAGES=1000

Key Options

  • maxPages: Maximum pages to crawl (default: 5000)
  • includePatterns: URL patterns to include (e.g., /\/blog\//i)
  • excludePatterns: URL patterns to exclude (e.g., /\/admin\//i)
  • stripSelectors: CSS selectors to remove (e.g., ['header', 'footer'])
  • enableCache: Enable response caching (default: true)
  • cacheTtl: Cache duration in minutes (default: 60)

Static Generation

Add this script in package.json.

{
  "scripts": {
    "postbuild": "next-llms-generator"
  }
}

Built with Love by Coldran