docs: add script to generate llm.txt (#9281)

Author: Laffery

angular.json

@@ -33,6 +33,8 @@
               "site/doc/404.html",
               "site/doc/google854eb8b183564acb.html",
               "site/doc/robots.txt",
+              "site/doc/llms.txt",
+              "site/doc/llms-full.txt",
               {
                 "glob": "**/*",
                 "input": "node_modules/@ant-design/icons-angular/src/inline-svg/",

package-lock.json

@@ -18,6 +18,7 @@
     "format": "prettier --config .prettierrc.js --list-different \\\"component/**/*{.ts}\\\"",
     "stage-release": "ts-node --project scripts/release/tsconfig.json scripts/release/release.ts",
     "gulp": "gulp",
+    "llms": "tsx scripts/generate-llms.ts",
     "lint": "npm run lint:script && npm run lint:style",
     "lint:script": "eslint --cache",
     "lint:style": "stylelint components/**/*.less",
@@ -131,6 +132,7 @@
     "terser": "^5.43.0",
     "ts-node": "^10.9.1",
     "tslib": "^2.0.3",
+    "tsx": "^4.20.3",
     "typescript": "~5.8.2",
     "typescript-eslint": "^8.37.0",
     "yaml-front-matter": "^4.1.1",

package.json

@@ -0,0 +1,98 @@
+/**
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://github.com/NG-ZORRO/ng-zorro-antd/blob/master/LICENSE
+ */
+
+import * as fs from 'fs-extra';
+import { glob } from 'glob';
+
+import { resolve, join } from 'path';
+
+/**
+ * @see https://github.com/ant-design/ant-design/blob/master/scripts/generate-llms.ts
+ */
+export async function generateLLms(): Promise<void> {
+  const cwd = process.cwd();
+  const siteDir = resolve(cwd, 'site', 'doc');
+  const docsDir = ['components', 'docs'];
+
+  const matchSuffix = '.en-US.md';
+
+  // Ensure siteDir
+  await fs.ensureDir(siteDir);
+
+  const docs = await glob(`{${docsDir.join(',')}}/**/*.md`);
+  const ignoreDocs = ['changelog', 'join', 'migration', 'recommendation'];
+  const filteredDocs = docs.filter(doc => doc.includes(matchSuffix) && !ignoreDocs.some(title => doc.includes(title)));
+
+  const docsIndex: Array<{ title: string; url: string }> = [];
+  const docsBody: string[] = [];
+
+  for (const markdown of filteredDocs) {
+    const mdPath = join(cwd, markdown);
+
+    const fsContent = (await fs.readFile(mdPath, 'utf-8')).trim();
+
+    // e.g. title: Button -> Button
+    const title = fsContent.match(/title:\s*(.*)/)?.[1].trim();
+
+    if (!title) {
+      console.log('MISS title, ignore:', mdPath);
+      continue;
+    }
+
+    // URL
+    let url = `https://ng.ant.design/${markdown.replace(matchSuffix, '')}/en`;
+    if (url.includes('/components/')) {
+      url = url.replace('/doc/index', '');
+    }
+
+    // Docs: title
+    docsIndex.push({
+      title,
+      url
+    });
+
+    // Docs: content
+    const parsedContent = fsContent.replace(/^---[\s\S]*?---\n/, '').trim();
+
+    const fullContent = [
+      // Title
+      '---',
+      `Title: ${title}`,
+      `URL: ${url}`,
+      '---',
+      '',
+      // Content
+      parsedContent,
+      ''
+    ].join('\n');
+
+    docsBody.push(fullContent);
+  }
+  const docsIndexContent = [
+    '# ng-zorro-antd - Ant Design of Angular',
+    '',
+    '- An enterprise-class Angular UI component library based on Ant Design, which aims to provide a high-quality design language and development framework for enterprise-level backend management systems. It offers a rich set of components and design guidelines, helping developers build modern, responsive, and high-performance web applications.\n' +
+      '',
+    '## Docs',
+    '',
+    ...docsIndex.map(({ title, url }) => `- [${title}](${url})`),
+    ''
+  ].join('\n');
+
+  const docsBodyContent = docsBody.join('\n');
+
+  await fs.writeFile(join(siteDir, 'llms.txt'), docsIndexContent);
+  await fs.writeFile(join(siteDir, 'llms-full.txt'), docsBodyContent);
+  console.log('Generated llms.txt and llms-full.txt');
+}
+
+(async () => {
+  if (require.main === module) {
+    await generateLLms();
+  }
+})().catch(e => {
+  console.error(e);
+  process.exit(1);
+});

scripts/generate-llms.ts

@@ -11,6 +11,7 @@ import { debounce } from 'lodash';
 import { join } from 'path';
 
 import { buildConfig } from '../../build-config';
+import { generateLLms } from '../../generate-llms';
 import { generate } from '../../prerender/ngsw-config';
 import { generateSitemap } from '../../prerender/sitemap';
 import { execNodeTask, execTask } from '../util/task-helpers';
@@ -50,6 +51,7 @@ task('watch:site', () => {
 task('init:site', async done => {
   siteGenerate('init');
   await themeGenerate();
+  await generateLLms();
   done();
 });