@loopstates/vitepress-plugin-linten

@loopstates/vitepress-plugin-linten

The official VitePress plugin for automated llms.txt Spec v2 auditing, link reachability checks, and companion llms-full.txt compilation during static site generation.

Engineered by Loopstates and powered by the Linten Cloud Engine.

Quickstart

Install the plugin via npm:

npm install -D @loopstates/vitepress-plugin-linten @loopstates/linten

Wrap your configuration in .vitepress/config.js (or .vitepress/config.ts):

import { defineConfig } from 'vitepress';
import { withLinten } from '@loopstates/vitepress-plugin-linten';

export default withLinten(
  defineConfig({
    title: 'My Project Docs',
    description: 'Documentation powered by VitePress'
  }),
  {
    checkLinks: true,      // Probes declared URLs for reachability
    generateFull: true,    // Compiles companion llms-full.txt into .vitepress/dist/
    failOnBrokenLinks: false
  }
);

Or attach the buildEnd hook directly:

import { defineConfig } from 'vitepress';
import { lintenBuildEnd } from '@loopstates/vitepress-plugin-linten';

export default defineConfig({
  title: 'My Project Docs',
  buildEnd: lintenBuildEnd({
    checkLinks: true,
    generateFull: true
  })
});

Whenever you run vitepress build, Linten validates your manifest and writes the companion llms-full.txt file directly into your deployment bundle.

Configuration Options

{
  // Path override (auto-detects in .vitepress/dist/llms.txt or public/llms.txt)
  manifestPath: 'public/llms.txt',

  // Concurrently probe declared links for 404s and redirect loops
  checkLinks: true,

  // Automatically compile companion llms-full.txt archive into build output
  generateFull: true,

  // Fail the VitePress build if dead documentation links are found
  failOnBrokenLinks: false,

  // Fail the VitePress build on Spec v2 syntax violations
  failOnError: true
}

Community & Support

• Organization: Loopstates
• Web App: Linten Cloud
• GitHub Repository: Loopstates/linten-packages

License

Distributed under the MIT License. Copyright (c) 2026 Loopstates.