`sh


Use default settings

`typescript
import {generateLlmsFiles} from 'get-llms-txt';

await generateLlmsFiles({
contentDir: './content',
outputDir: './out',
baseUrl: 'https://example.com',
projectName: 'My Next.js Project',
projectDescription: 'A collection of technical content',
});
`

🛠️ Installation

`sh
npm install --save-dev get-llms-txt
`

API

$3

Main function to generate llms.txt files.

Parameters:

- options.contentDir (string) - Content directory to scan
- options.outputDir (string) - Output directory for llms.txt and md files
- options.baseUrl? (string) - Base URL for links in llms.txt
- options.projectName? (string) - Project name for llms.txt
- options.projectDescription? (string) - Project description

$3

Process an MDX file and extract metadata and content.

$3

Process a Markdown file and extract metadata and content.

$3

Extract title from file metadata, first H1, or filename.

$3

Extract description from metadata or first paragraph.

What It Does

1. Scans Content Directory: Recursively finds all .mdx and .md files in the content directory
2. Extracts Metadata: Extracts title, description, and other metadata from MDX files
3. Converts to Markdown:
- Removes MDX metadata exports
- Strips JSX components
- Converts to plain markdown
4. Generates Individual .md Files: Creates markdown versions in /md/ directory
5. Generates llms.txt: Creates llms.txt file in the output directory with:
- Project name and description
- Content structure overview
- Categorized file lists with links

Output Structure

`
/
├── llms.txt
└── md/
├── blog/
│ ├── post1.md
│ └── ...
├── apps/
│ ├── app1.md
│ └── ...
└── research/
└── ...
`

File Processing

$3

The script supports two common metadata formats used in Next.js projects:

1. YAML Frontmatter (most common):

`mdx
---
title: My Post
description: A great post
tags: [blog, tech]
---

# My Post

Content here...
`

2. Export const metadata (Next.js MDX format):

`mdx
export const metadata = {
title: 'My Post',
description: 'A great post',
tags: ['blog', 'tech'],
};

# My Post

Content here...
`

The script automatically detects and handles both formats. It also:

- Removes React/JSX components
- Strips import statements
- Converts to plain markdown
- Preserves markdown structure

$3

- Extracts YAML frontmatter (if present)
- Preserves markdown content as-is

Integration with Build Process

For Next.js static export (or any static site generator), add to your build script:

`json
{
"scripts": {
"build": "next build && npx get-llms-txt --output-dir ./out",
"deploy:prod": "next build && npx get-llms-txt --output-dir ./out --base-url https://example.com && firebase deploy --only hosting"
}
}
`

Compatibility

✅ Optimized for Next.js projects using MDX/MD files, but also works with:

- ✅ Any static site generator (Gatsby, Astro, etc.)
- ✅ Documentation sites (Docusaurus, VitePress, etc.)
- ✅ Any project with markdown/MDX content files

Supported formats:

- ✅ YAML frontmatter (most common)
- ✅ export const metadata (Next.js MDX format)
- ✅ Mixed formats
- ✅ Files with no metadata (falls back to filename/H1 extraction)
- ✅ Any directory structure (recursively scans)
- ✅ Locale suffixes (.en, .ru, etc.) are handled automatically

Requirements:

- Node.js 22+
- MDX or MD files in a content directory (configurable)
- TypeScript support (for programmatic usage)

URL Generation

- Locale suffixes (.en, .ru) are removed from filenames
- All files are converted to .md` extension
- Directory structure is preserved
- URLs are relative to the base URL (if provided)
- Index files are handled specially (uses directory name)

License

MIT

[package-name]: get-llms-txt
[npm-url]: https://www.npmjs.com/package/get-llms-txt
[npm-image]: https://img.shields.io/npm/v/get-llms-txt
[github-license]: https://img.shields.io/github/license/romankurnovskii/get-llms-txt
[github-license-url]: https://github.com/romankurnovskii/get-llms-txt/blob/main/LICENSE
[npm-typescript]: https://img.shields.io/npm/types/get-llms-txt
[build-status]: https://github.com/romankurnovskii/get-llms-txt/workflows/CI/badge.svg
[build-status-url]: https://github.com/romankurnovskii/get-llms-txt
[install-size]: https://packagephobia.com/badge?p=get-llms-txt
[install-size-url]: https://packagephobia.com/result?p=get-llms-txt