docusaurus-plugin-llms 0.1.3 → 0.1.5

package/README.md

@@ -2,6 +2,34 @@
 
 A Docusaurus plugin for generating LLM-friendly documentation following the [llmstxt standard](https://llmstxt.org/).
 
+## Features
+
+- ⚡️ Easy integration with Docusaurus
+- ✅ Zero config required, works out of the box
+- ⚙️ Highly customizable with multiple options
+- 📝 Creates `llms.txt` with section links
+- 📖 Produces `llms-full.txt` with all content in one file
+- 📋 Document ordering control for custom sequence
+- 🔄 Path transformation to customize URL construction
+- 📚 Option to include blog posts
+- 🧩 Custom LLM files for specific documentation sections
+- 🧹 Cleans HTML and normalizes content for optimal LLM consumption
+- 📊 Provides statistics about generated documentation
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Configuration Options](#configuration-options)
+- [Available Options](#available-options)
+- [Path Transformation Examples](#path-transformation-examples)
+- [Document Ordering Examples](#document-ordering-examples)
+- [Custom LLM Files](#custom-llm-files)
+- [How It Works](#how-it-works)
+- [Implementation Details](#implementation-details)
+- [Testing](#testing)
+- [Future Enhancements](#future-enhancements)
+- [License](#license)
+
 ## Installation
 
 ```bash
@@ -317,7 +345,7 @@ The generated files will include the version information under the description:
 
 Version: 1.0.0
 
-This file contains all documentation content in a single document following the llmtxt.org standard.
+This file contains all documentation content in a single document following the llmstxt.org standard.
 ```
 
 ## How It Works
@@ -330,19 +358,6 @@ This plugin automatically generates the following files during the build process
 
 These files follow the [llmstxt standard](https://llmstxt.org/), making your documentation optimized for use with Large Language Models (LLMs).
 
-## Features
-
-- ⚡️ Easy integration with Docusaurus
-- ✅ Zero config required, works out of the box
-- ⚙️ Highly customizable with multiple options
-- 📝 Creates `llms.txt` with section links
-- 📖 Produces `llms-full.txt` with all content in one file
-- 📋 Document ordering control for custom sequence
-- 🔄 Path transformation to customize URL construction
-- 📚 Option to include blog posts
-- 🧩 Custom LLM files for specific documentation sections
-- 🧹 Cleans HTML and normalizes content for optimal LLM consumption
-- 📊 Provides statistics about generated documentation
 
 ## Implementation Details
 
@@ -390,5 +405,5 @@ Planned features for future versions:
 - Specific content tags for LLM-only sections
 
 ## License
+This project is licensed under the MIT License.
 
-MIT 

package/lib/generator.js

@@ -84,7 +84,7 @@ ${doc.content}`;
 
 > ${fileDescription}${versionInfo}
 
-This file contains all documentation content in a single document following the llmtxt.org standard.
+This file contains all documentation content in a single document following the llmstxt.org standard.
 
 ${fullContentSections.join('\n\n---\n\n')}
 `;
@@ -101,7 +101,7 @@ ${fullContentSections.join('\n\n---\n\n')}
 
 > ${fileDescription}${versionInfo}
 
-This file contains links to documentation sections following the llmtxt.org standard.
+This file contains links to documentation sections following the llmstxt.org standard.
 
 ## Table of Contents
 

package/lib/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * @fileoverview Docusaurus plugin that generates LLM-friendly documentation following the llmtxt.org standard.
+ * @fileoverview Docusaurus plugin that generates LLM-friendly documentation following the llmstxt.org standard.
  *
  * This plugin creates two files:
  * - llms.txt: Contains links to all sections of documentation
@@ -11,10 +11,11 @@ import type { LoadContext, Plugin } from '@docusaurus/types';
 import { PluginOptions } from './types';
 /**
  * A Docusaurus plugin to generate LLM-friendly documentation following
- * the llmtxt.org standard
+ * the llmstxt.org standard
  *
  * @param context - Docusaurus context
  * @param options - Plugin options
  * @returns Plugin object
  */
 export default function docusaurusPluginLLMs(context: LoadContext, options?: PluginOptions): Plugin<void>;
+export type { PluginOptions };

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * @fileoverview Docusaurus plugin that generates LLM-friendly documentation following the llmtxt.org standard.
+ * @fileoverview Docusaurus plugin that generates LLM-friendly documentation following the llmstxt.org standard.
  *
  * This plugin creates two files:
  * - llms.txt: Contains links to all sections of documentation
@@ -13,7 +13,7 @@ exports.default = docusaurusPluginLLMs;
 const generator_1 = require("./generator");
 /**
  * A Docusaurus plugin to generate LLM-friendly documentation following
- * the llmtxt.org standard
+ * the llmstxt.org standard
  *
  * @param context - Docusaurus context
  * @param options - Plugin options

package/lib/processor.d.ts

@@ -14,7 +14,7 @@ import { DocInfo, PluginContext } from './types';
 export declare function processMarkdownFile(filePath: string, baseDir: string, siteUrl: string, pathPrefix?: string, pathTransformation?: {
     ignorePaths?: string[];
     addPaths?: string[];
-}): Promise<DocInfo>;
+}): Promise<DocInfo | null>;
 /**
  * Process files based on include patterns, ignore patterns, and ordering
  * @param context - Plugin context

package/lib/processor.js

@@ -57,6 +57,10 @@ const utils_1 = require("./utils");
 async function processMarkdownFile(filePath, baseDir, siteUrl, pathPrefix = 'docs', pathTransformation) {
     const content = await (0, utils_1.readFile)(filePath);
     const { data, content: markdownContent } = (0, gray_matter_1.default)(content);
+    // Skip draft files
+    if (data.draft === true) {
+        return null;
+    }
     const relativePath = path.relative(baseDir, filePath);
     // Convert to URL path format (replace backslashes with forward slashes on Windows)
     const normalizedPath = relativePath.replace(/\\/g, '/');
@@ -201,7 +205,9 @@ async function processFilesWithPatterns(context, allFiles, includePatterns = [],
             const baseDir = isBlogFile ? path.join(siteDir, 'blog') : path.join(siteDir, docsDir);
             const pathPrefix = isBlogFile ? 'blog' : 'docs';
             const docInfo = await processMarkdownFile(filePath, baseDir, siteUrl, pathPrefix, context.options.pathTransformation);
-            processedDocs.push(docInfo);
+            if (docInfo !== null) {
+                processedDocs.push(docInfo);
+            }
         }
         catch (err) {
             console.warn(`Error processing ${filePath}: ${err.message}`);

package/lib/types.d.ts

@@ -0,0 +1,86 @@
+/**
+ * Type definitions for the docusaurus-plugin-llms plugin
+ */
+/**
+ * Interface for processed document information
+ */
+export interface DocInfo {
+    title: string;
+    path: string;
+    url: string;
+    content: string;
+    description: string;
+}
+/**
+ * Interface for custom LLM file configuration
+ */
+export interface CustomLLMFile {
+    /** Name of the output file (e.g., 'llms-python.txt') */
+    filename: string;
+    /** Glob patterns for files to include */
+    includePatterns: string[];
+    /** Whether to include full content (true) or just links (false) */
+    fullContent: boolean;
+    /** Custom title for this file (defaults to site title) */
+    title?: string;
+    /** Custom description for this file (defaults to site description) */
+    description?: string;
+    /** Additional patterns to exclude (combined with global ignoreFiles) */
+    ignorePatterns?: string[];
+    /** Order patterns for controlling file ordering (similar to includeOrder) */
+    orderPatterns?: string[];
+    /** Whether to include unmatched files last (default: false) */
+    includeUnmatchedLast?: boolean;
+    /** Version information for this LLM file */
+    version?: string;
+}
+/**
+ * Plugin options interface
+ */
+export interface PluginOptions {
+    /** Whether to generate the llms.txt file (default: true) */
+    generateLLMsTxt?: boolean;
+    /** Whether to generate the llms-full.txt file (default: true) */
+    generateLLMsFullTxt?: boolean;
+    /** Base directory for documentation files (default: 'docs') */
+    docsDir?: string;
+    /** Array of glob patterns for files to ignore */
+    ignoreFiles?: string[];
+    /** Custom title to use in generated files (defaults to site title) */
+    title?: string;
+    /** Custom description to use in generated files (defaults to site tagline) */
+    description?: string;
+    /** Custom file name for the links file (default: 'llms.txt') */
+    llmsTxtFilename?: string;
+    /** Custom file name for the full content file (default: 'llms-full.txt') */
+    llmsFullTxtFilename?: string;
+    /** Whether to include blog content (default: false) */
+    includeBlog?: boolean;
+    /** Path transformation options for URL construction */
+    pathTransformation?: {
+        /** Path segments to ignore when constructing URLs (will be removed if found) */
+        ignorePaths?: string[];
+        /** Path segments to add when constructing URLs (will be prepended if not already present) */
+        addPaths?: string[];
+    };
+    /** Array of glob patterns for controlling the order of files (files will be processed in the order of patterns) */
+    includeOrder?: string[];
+    /** Whether to include files that don't match any pattern in includeOrder at the end (default: true) */
+    includeUnmatchedLast?: boolean;
+    /** Array of custom LLM file configurations */
+    customLLMFiles?: CustomLLMFile[];
+    /** Global version for all generated LLM files */
+    version?: string;
+}
+/**
+ * Plugin context with processed options
+ */
+export interface PluginContext {
+    siteDir: string;
+    outDir: string;
+    siteUrl: string;
+    docsDir: string;
+    docTitle: string;
+    docDescription: string;
+    options: PluginOptions;
+}

package/lib/types.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * Type definitions for the docusaurus-plugin-llms plugin
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "docusaurus-plugin-llms",
-  "version": "0.1.3",
-  "description": "Docusaurus plugin for generating LLM-friendly documentation following the llmtxt.org standard",
+  "version": "0.1.5",
+  "description": "Docusaurus plugin for generating LLM-friendly documentation following the llmstxt.org standard",
   "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "scripts": {
     "build": "tsc",
     "watch": "tsc --watch",

package/src/generator.ts

@@ -60,7 +60,7 @@ ${doc.content}`;
 
 > ${fileDescription}${versionInfo}
 
-This file contains all documentation content in a single document following the llmtxt.org standard.
+This file contains all documentation content in a single document following the llmstxt.org standard.
 
 ${fullContentSections.join('\n\n---\n\n')}
 `;
@@ -79,7 +79,7 @@ ${fullContentSections.join('\n\n---\n\n')}
 
 > ${fileDescription}${versionInfo}
 
-This file contains links to documentation sections following the llmtxt.org standard.
+This file contains links to documentation sections following the llmstxt.org standard.
 
 ## Table of Contents
 

package/src/index.ts

@@ -1,5 +1,5 @@
 /**
- * @fileoverview Docusaurus plugin that generates LLM-friendly documentation following the llmtxt.org standard.
+ * @fileoverview Docusaurus plugin that generates LLM-friendly documentation following the llmstxt.org standard.
  * 
  * This plugin creates two files:
  * - llms.txt: Contains links to all sections of documentation
@@ -15,7 +15,7 @@ import { collectDocFiles, generateStandardLLMFiles, generateCustomLLMFiles } fro
 
 /**
  * A Docusaurus plugin to generate LLM-friendly documentation following
- * the llmtxt.org standard
+ * the llmstxt.org standard
  * 
  * @param context - Docusaurus context
  * @param options - Plugin options
@@ -112,4 +112,6 @@ export default function docusaurusPluginLLMs(
       }
     },
   };
-} 
+}
+
+export type { PluginOptions };

package/src/processor.ts

@@ -31,10 +31,15 @@ export async function processMarkdownFile(
     ignorePaths?: string[];
     addPaths?: string[];
   }
-): Promise<DocInfo> {
+): Promise<DocInfo | null> {
   const content = await readFile(filePath);
   const { data, content: markdownContent } = matter(content);
   
+  // Skip draft files
+  if (data.draft === true) {
+    return null;
+  }
+  
   const relativePath = path.relative(baseDir, filePath);
   // Convert to URL path format (replace backslashes with forward slashes on Windows)
   const normalizedPath = relativePath.replace(/\\/g, '/');
@@ -226,7 +231,9 @@ export async function processFilesWithPatterns(
         pathPrefix,
         context.options.pathTransformation
       );
-      processedDocs.push(docInfo);
+      if (docInfo !== null) {
+        processedDocs.push(docInfo);
+      }
     } catch (err: any) {
       console.warn(`Error processing ${filePath}: ${err.message}`);
     }