vite-plugin-llms

1.0.2 verified Mon Apr 27 auth: no javascript

Vite plugin (v1.0.2) implementing the llms.txt specification for serving simplified markdown content to large language models. Framework-agnostic, works with Vue, React, Svelte, Astro. Differentiates by providing a declarative directory-based approach vs manual route configuration. Actively maintained, monthly releases.

Common errors

error Error: Cannot find module 'vite-plugin-llms' ↓

cause Plugin not installed as dev dependency.

fix

npm install vite-plugin-llms --save-dev

error TypeError: plugin.apply is not a function ↓

cause Plugin imported incorrectly as default export but using named import.

fix

Use default import: import llms from 'vite-plugin-llms'

error Module '"vite-plugin-llms"' has no exported member 'LlmsOptions'. Did you mean to use 'import LlmsOptions from "vite-plugin-llms"'? ↓

cause LlmsOptions is a type and not a runtime export.

fix

Use import type { LlmsOptions } from 'vite-plugin-llms'

Warnings

gotcha Markdown files must be placed in the configured llmsDir (default 'llms'), not in the src directory. Files outside this folder are not served. ↓

fix Create a 'llms' folder in project root and move markdown files there.

gotcha The plugin does not inject a link to llms.txt into your HTML. You must manually add a <link> tag if desired. ↓

fix Add <link rel="llms-txt" href="/llms.txt"> to your HTML <head>.

deprecated Options type may change in future versions. Currently only 'llmsDir' is supported. ↓

fix Check plugin documentation for any new options before upgrading.

Install

npm install vite-plugin-llms

yarn add vite-plugin-llms

pnpm add vite-plugin-llms

Imports

default

wrong

const llms = require('vite-plugin-llms')

correct

import llms from 'vite-plugin-llms'

ESM-only; CommonJS require not supported.

defineConfig

wrong

import { defineConfig } from 'vite-plugin-llms'

correct

import { defineConfig } from 'vite'

defineConfig is from Vite, not this plugin.

LlmsOptions

wrong

import { LlmsOptions } from 'vite-plugin-llms'

correct

import type { LlmsOptions } from 'vite-plugin-llms'

LlmsOptions is a TypeScript type; use import type or inline.

Quickstart

Basic setup of vite-plugin-llms with custom directory. Creates route /llms.txt and .md endpoints.

// vite.config.ts
import { defineConfig } from 'vite'
import llms from 'vite-plugin-llms'

export default defineConfig({
  plugins: [
    llms({
      llmsDir: 'llms'
    })
  ]
})