Generate LLM-Friendly Documentation

Automatically generate `llms.txt` files and markdown versions of all MDX/MD content files for LLM consumption, following the [llms.txt specification](https://llmstxt.org/).

What This Skill Does

This skill uses the `get-llms-txt` npm package to:

1. Scan a content directory for `.mdx` and `.md` files

2. Extract metadata (title, description, tags) from files

3. Convert MDX files to plain markdown (removes JSX components)

4. Generate individual `.md` files in an output directory

5. Create a high-level `llms.txt` index file with categorized content

The resulting files make your documentation easily consumable by LLMs.

Instructions

When the user requests to generate LLM-friendly documentation or create an `llms.txt` file:

Step 1: Check if the package is installed

First, check if `get-llms-txt` is already installed in the project:

```bash

npm list get-llms-txt

```

If not installed, install it as a dev dependency:

```bash

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

```

Step 2: Identify the content directory

Ask the user or search the project to identify where markdown/MDX content files are located. Common locations:

If unclear, ask the user: "Where are your markdown/MDX content files located?"

Step 3: Determine the output directory

Identify or ask where the generated files should go:

Step 4: Run the generator

Execute the command with appropriate options:

**Basic usage:**

```bash

npx get-llms-txt --content-dir ./content --output-dir ./public

```

**With base URL (recommended for production):**

```bash

npx get-llms-txt --content-dir ./content --output-dir ./out --base-url https://example.com

```

**With custom project metadata:**

```bash

npx get-llms-txt --content-dir ./docs --output-dir ./public --project-name "My Docs" --project-description "Technical documentation for My Project"

```

Step 5: Verify output

After running, verify that files were created:

1. Check for `llms.txt` in the output directory

2. Check for `md/` subdirectory with converted markdown files

3. Report to the user what was generated

Step 6: Integrate with build process (optional)

If the user wants this automated, add it to their build scripts in `package.json`:

```json

{

"scripts": {

"build": "next build && npx get-llms-txt --output-dir ./out",

"build:prod": "next build && npx get-llms-txt --output-dir ./out --base-url https://example.com"

}

}

```

CLI Options Reference

Supported File Formats

The tool handles:

Output Structure

```

<output-dir>/

├── llms.txt # Main index file

└── md/ # Converted markdown files

├── blog/

├── docs/

└── ...

```

Example Interactions

**User:** "Generate llms.txt for my Next.js blog"

**Response:**

1. Check if `get-llms-txt` is installed

2. Identify content directory (e.g., `./content`)

3. Run: `npx get-llms-txt --content-dir ./content --output-dir ./public --project-name "My Blog"`

4. Report: "Generated llms.txt and 15 markdown files in ./public/md/"

**User:** "Add this to my build process"

**Response:**

1. Edit `package.json`

2. Add to build script: `&& npx get-llms-txt --output-dir ./out`

3. Confirm the change

Constraints

Notes