feat(vitepress-theme): add vitepress-plugin-llms for auto llms.txt generation

Author: onmax

docs/vitepress-theme/features/copy-as-markdown.md

@@ -27,29 +27,35 @@ All options are enabled by default but can be controlled per-page using frontmat
 
 ## Generating llms.txt Files
 
-To generate `llms.txt` and `llms-full.txt` files in your repository root, use the mdream CLI after building your docs:
+The theme automatically generates `llms.txt` and `llms-full.txt` files during build when using `vitepress-plugin-llms` (enabled by default in `NimiqVitepressVitePlugin`).
+
+After building your docs:
 
 ```bash
-# Build the documentation
 pnpm docs:build
+```
+
+This automatically creates in `.vitepress/dist/`:
+
+- `llms.txt` - A sitemap of all documentation pages
+- `llms-full.txt` - Complete markdown content of all pages
+- `markdown/` directory - Individual markdown files for each page
+
+### Manual Generation (Alternative)
 
-# Generate llms.txt files in the root
+You can also generate llms.txt files manually using the mdream CLI:
+
+```bash
 pnpm dlx mdream llms "docs/.vitepress/dist/**/*.html" \
   --site-name "My Docs" \
   --description "My awesome documentation" \
   --origin "https://docs.example.com" \
   -o .
 ```
 
-This will create:
-
-- `llms.txt` - A sitemap of all documentation pages
-- `llms-full.txt` - Complete markdown content of all pages
-- `markdown/` directory - Individual markdown files for each page
-
 ## Configuration
 
-The markdown generation is automatically configured when you use the `NimiqVitepressVitePlugin`:
+The llms.txt generation is automatically configured when you use the `NimiqVitepressVitePlugin`:
 
 ```ts [vite.config.ts]
 import { NimiqVitepressVitePlugin } from 'nimiq-vitepress-theme/vite'
@@ -59,13 +65,13 @@ export default defineConfig({
     NimiqVitepressVitePlugin({
       repoURL: 'https://github.com/your-org/your-repo',
 
-      // LLM-friendly markdown generation
+      // LLMs.txt automatic generation (enabled by default)
       llms: {
-        domain: 'https://docs.example.com',
-        injectLLMHint: false
+        // Pass options to vitepress-plugin-llms
+        // See: https://github.com/okineadev/vitepress-plugin-llms#options
       }
 
-      // Or disable it entirely
+      // Or disable automatic llms.txt generation
       // llms: false
     })
   ]
@@ -74,9 +80,9 @@ export default defineConfig({
 
 ### Plugin Options
 
-| Option | Type                | Default | Description                                                    |
-| ------ | ------------------- | ------- | -------------------------------------------------------------- |
-| `llms` | `object \| boolean` | `true`  | LLM-friendly markdown generation options or `false` to disable |
+| Option | Type                | Default | Description                                                                                                                                                                                               |
+| ------ | ------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `llms` | `object \| boolean` | `true`  | Automatic llms.txt generation via `vitepress-plugin-llms`. Pass config object or `false` to disable. See [plugin docs](https://github.com/okineadev/vitepress-plugin-llms#options) for available options. |
 
 ## Per-Page Control
 

packages/nimiq-css/src/css/colors.css

@@ -79,7 +79,4 @@
   --colors-gold-gradient-darkened-from: light-dark(oklab(0.7143 0.0695 0.1390), oklab(0.8163 0.0458 0.1479));
   --colors-gold-gradient-darkened-to: light-dark(oklab(0.7575 0.0315 0.1515), oklab(0.8221 0.0167 0.1498));
   --colors-gold-gradient-darkened: radial-gradient(at 100% 100% in oklab, var(--colors-gold-gradient-darkened-from), var(--colors-gold-gradient-darkened-to));
-  --colors-purple-gradient-from: light-dark(oklab(0.3356 0.0227 -0.0760), oklab(0.3356 0.0227 -0.0760));
-  --colors-purple-gradient-to: light-dark(oklab(0.3414 0.0439 -0.0787), oklab(0.3414 0.0439 -0.0787));
-  --colors-purple-gradient: radial-gradient(at 100% 100% in oklab, var(--colors-purple-gradient-from), var(--colors-purple-gradient-to));
 }

packages/nimiq-vitepress-theme/package.json

@@ -99,6 +99,7 @@
     "unbuild": "catalog:build",
     "unocss": "catalog:style",
     "unocss-preset-animations": "catalog:style",
-    "unocss-preset-onmax": "catalog:style"
+    "unocss-preset-onmax": "catalog:style",
+    "vitepress-plugin-llms": "^1.8.1"
   }
 }

packages/nimiq-vitepress-theme/src/vite/index.ts

@@ -5,9 +5,11 @@ import path from 'node:path'
 import process from 'node:process'
 import { viteHtmlToMarkdownPlugin } from '@mdream/vite'
 import { GitChangelog } from '@nolebase/vitepress-plugin-git-changelog/vite'
+import llmstxt from 'vitepress-plugin-llms'
 import { groupIconVitePlugin } from '../code-groups/vite'
 
 type GitChangelogOptions = Parameters<typeof GitChangelog>[0]
+type LlmsPluginOptions = Parameters<typeof llmstxt>[0]
 
 export interface NimiqVitepressVitePluginOptions {
   /**
@@ -29,6 +31,14 @@ export interface NimiqVitepressVitePluginOptions {
    * Set to false to disable changelog
    */
   gitChangelog?: GitChangelogOptions | false
+
+  /**
+   * LLMs.txt plugin configuration
+   * Automatically generates llms.txt and llms-full.txt during build
+   * Set to false to disable (only mdream markdown generation will be used)
+   * @default true
+   */
+  llms?: LlmsPluginOptions | boolean
 }
 
 function getProjectVersion(rootDir: string = process.cwd()): string | undefined {
@@ -49,6 +59,7 @@ export function NimiqVitepressVitePlugin({
   repoURL,
   contentPath = '',
   gitChangelog,
+  llms = true,
 }: NimiqVitepressVitePluginOptions): Plugin[] {
   const { resolveId, configureServer, load, transform } = groupIconVitePlugin()
 
@@ -62,6 +73,12 @@ export function NimiqVitepressVitePlugin({
     }
   }
 
+  // Configure LLMs.txt plugin for automatic llms.txt generation
+  if (llms !== false) {
+    const llmsConfig = typeof llms === 'object' ? llms : {}
+    externalPlugins.push(llmstxt(llmsConfig))
+  }
+
   // Get project version from package.json
   const version = getProjectVersion()