Add llms-txt generator module and integrate it

Author: AugustinMauroy

src/generators/index.mjs

@@ -9,6 +9,7 @@ import legacyJsonAll from './legacy-json-all/index.mjs';
 import addonVerify from './addon-verify/index.mjs';
 import apiLinks from './api-links/index.mjs';
 import oramaDb from './orama-db/index.mjs';
+import llmsTxt from './llms-txt/index.mjs';
 
 export default {
   'json-simple': jsonSimple,
@@ -20,4 +21,5 @@ export default {
   'addon-verify': addonVerify,
   'api-links': apiLinks,
   'orama-db': oramaDb,
+  'llms-txt': llmsTxt,
 };

src/generators/llms-txt/index.mjs

@@ -0,0 +1,57 @@
+'use strict';
+
+import { writeFile } from 'node:fs/promises';
+import { join } from 'node:path';
+
+/**
+ * This generator generates the `llms.txt` file that provides an AI-readable index of all the documentation.
+ *
+ * @typedef {Array<ApiDocMetadataEntry>} Input
+ *
+ * @type {import('../types.d.ts').GeneratorMetadata<Input, string>}
+ */
+export default {
+  name: 'llms-txt',
+
+  version: '1.0.0',
+
+  description: 'Generates the `llms.txt` file that provides an AI-readable index of all the documentation.',
+
+  dependsOn: 'ast',
+
+  /**
+   * Generates the `llms.txt` file.
+   *
+   * @param {Input} input
+   * @param {Partial<GeneratorOptions>} options
+   */
+  async generate(input, { output }) {
+    const projectName = 'Node.js Documentation';
+    const projectSummary = 'Comprehensive documentation for Node.js, including API references, guides, and tutorials.';
+    const projectDetails = 'This documentation provides detailed information about Node.js, its APIs, and usage examples. It is designed to help developers understand and use Node.js effectively.';
+
+    const fileList = input.map(entry => {
+      const url = `https://nodejs.org/docs/latest-v${entry.api}.html#${entry.slug}`;
+      return `- [${entry.heading.data.text}](${url})`;
+    }).join('\n');
+
+    const llmsTxtContent = `
+# ${projectName}
+
+## Summary
+${projectSummary}
+
+## Details
+${projectDetails}
+
+## Files
+${fileList}
+    `;
+
+    if (output) {
+      await writeFile(join(output, 'llms.txt'), llmsTxtContent);
+    }
+
+    return llmsTxtContent;
+  },
+};