New plugin feature to copy page content (#524)

* New plugin feature to copy page content

* Update plugin versions

---------

Co-authored-by: Nirav Nikhil <[email protected]>

Author: Devon-White

website/config/pluginsConfig/docusaurus-plugin-llms-txt.ts

@@ -9,32 +9,28 @@
 
 import { PluginConfig } from '@docusaurus/types';
 // @ts-ignore - ESM/CJS compatibility issue
-import type { PluginOptions } from '@signalwire/docusaurus-plugin-llms-txt';
+import type { PluginOptions } from '@signalwire/docusaurus-plugin-llms-txt/public';
 export const llmsTxtPlugin: PluginConfig = [
   "@signalwire/docusaurus-plugin-llms-txt",
   {
-    siteDescription: "SignalWire Documentation",
-    siteTitle: "SignalWire Documentation",
-    enableDescriptions: true,
-    onRouteError: 'warn',
-    logLevel: 1,
-    depth: 1,
+
+    logLevel: 3,
+    onRouteError: 'throw',
+    onSectionError: 'throw',
     runOnPostBuild: true,
 
-    // Global ordering - guides first, then methods/reference
-    includeOrder: [
-      "/ai/**",
-      "/swml/**"
-    ],
+    generate: {
+      enableMarkdownFiles: true,
+      enableLlmsFullTxt: true,
+      relativePaths: true
+    },
 
-    optionalLinks: [
-      {
-        title: "Support",
-        url: "https://support.signalwire.com",
-        description: "SignalWire Support"
-      }
-    ],
-    content: {
+    include: {
+      includeBlog: false,
+      includePages: false,
+      includeDocs: true,
+      includeVersionedDocs: false,
+      includeGeneratedIndex: false,
       excludeRoutes: [
         "/attachments/**",
         "/cluecon-2024/**",
@@ -51,20 +47,57 @@ export const llmsTxtPlugin: PluginConfig = [
         "/404.html",
         "/media/**" 
       ],
-      includeBlog: false,
-      includePages: false,
-      includeDocs: true,
-      includeVersionedDocs: false,
-      includeGeneratedIndex: false,
-      relativePaths: false,
-      enableMarkdownFiles: true,
-      enableLlmsFullTxt: true,
-      routeRules: [
+    },
+
+    structure: {
+      enableDescriptions: true,
+      siteTitle: "SignalWire Developer Documentation",
+      siteDescription: "SignalWire provide comprehensive and easy to use APIs that allow developers to reate unified communication applications.",
+
+      optionalLinks: [
         {
-          route: '/sdks/{realtime-sdk,browser-sdk,agents-sdk}/**',
-          depth: 2
+          title: "Support",
+          url: "https://support.signalwire.com",
+          description: "SignalWire Support"
         }
+      ],
+
+      sections: [
+        {
+          id: 'swml',
+          name: 'SWML Documentation',
+          description: 'The SignalWire Markup Language which allows developers to create communication applications with simple JSON & YAML documents.',
+          position: 1,
+          routes: [
+            {
+              route: '/swml/**'
+            }
+          ]
+        },
+        {
+          id: 'api-ref',
+          name: 'API OpenAPI Spec',
+          description: 'The OpenAPI Spec defiitions.',
+          position: 1,
+          routes: []
+        },
       ]
+    },
+
+    processing: {
+
+      attachments: [
+        {
+          source: '../specs/signalwire-rest/calling-api/tsp-output/@typespec/openapi3/openapi.yaml',
+          title: 'Calling API Spec',
+          description: "The OpenAPI spec for the SignalWire Calling API.",
+          sectionId: "api-ref"
+        }
+      ]
+    },
+
+    ui: {
+      copyPageContent: true
     }
   } satisfies PluginOptions
 ];

website/docusaurus.config.ts

@@ -22,6 +22,7 @@ const config: Config = {
     mermaid: true, // enables mermaid diagrams in markdown files
   },
   themes: [
+    '@signalwire/docusaurus-theme-llms-txt',
     "@docusaurus/theme-mermaid", // Imports the mermaid library for rendering diagrams
     "docusaurus-theme-openapi-docs", // Imports the openapi-docs theme for rendering OpenAPI documentation
     ...(process.env.TYPESENSE_HOST && process.env.TYPESENSE_API_SEARCH_KEY && process.env.TYPESENSE_COLLECTION_NAME && process.env.TYPESENSE_EXPORTS ? 

website/package.json

@@ -47,7 +47,8 @@
     "@mdx-js/react": "^3.0.1",
     "@popperjs/core": "^2.11.8",
     "@signalwire/call-widget": "^3.15.0",
-    "@signalwire/docusaurus-plugin-llms-txt": "1.2.1",
+    "@signalwire/docusaurus-plugin-llms-txt": "2.0.0-alpha.0",
+    "@signalwire/docusaurus-theme-llms-txt": "1.0.0-alpha.1",
     "canvas": "^3.1.2",
     "clsx": "^2.1.1",
     "color": "^4.2.3",

yarn.lock

@@ -1593,7 +1593,7 @@
     webpack "^5.95.0"
     webpackbar "^6.0.1"
 
-"@docusaurus/[email protected]", "@docusaurus/core@^3.8.1", "@docusaurus/core@~3.8.0":
+"@docusaurus/[email protected]", "@docusaurus/core@^3.0.0", "@docusaurus/core@^3.8.1", "@docusaurus/core@~3.8.0":
   version "3.8.1"
   resolved "https://registry.npmjs.org/@docusaurus/core/-/core-3.8.1.tgz"
   integrity sha512-ENB01IyQSqI2FLtOzqSI3qxG2B/jP4gQPahl2C3XReiLebcVh5B5cB9KYFvdoOqOWPyr5gXK4sjgTKv7peXCrA==
@@ -1926,7 +1926,7 @@
     tslib "^2.6.0"
     utility-types "^3.10.0"
 
-"@docusaurus/[email protected]", "@docusaurus/theme-common@~3.8.0":
+"@docusaurus/[email protected]", "@docusaurus/theme-common@^3.0.0", "@docusaurus/theme-common@~3.8.0":
   version "3.8.1"
   resolved "https://registry.npmjs.org/@docusaurus/theme-common/-/theme-common-3.8.1.tgz"
   integrity sha512-UswMOyTnPEVRvN5Qzbo+l8k4xrd5fTFu2VPPfD6FcW/6qUtVLmJTQCktbAL3KJ0BVXGm5aJXz/ZrzqFuZERGPw==
@@ -2941,10 +2941,10 @@
     redux "^4.2.1"
     uuid "^9.0.0"
 
-"@signalwire/docusaurus-plugin-llms-txt@1.2.1":
-  version "1.2.1"
-  resolved "https://registry.npmjs.org/@signalwire/docusaurus-plugin-llms-txt/-/docusaurus-plugin-llms-txt-1.2.1.tgz"
-  integrity sha512-v/KluP6XMYOFKwsquFpcAbieSpj2mkoKij0GTZQHObrjMvCcJ6LADH0UnYUlHtkTbJTzglhH5wTgZ8ff3NwrVA==
+"@signalwire/docusaurus-plugin-llms-txt@2.0.0-alpha.0":
+  version "2.0.0-alpha.0"
+  resolved "https://registry.yarnpkg.com/@signalwire/docusaurus-plugin-llms-txt/-/docusaurus-plugin-llms-txt-2.0.0-alpha.0.tgz#fa97267103c7a51664f1ad48e49e034f29aff47d"
+  integrity sha512-vJYF0/6lsfVppC+xwSppQFX1YfYpin4gTKlW3HuD7+Jx6CREMr3QnCqju1zW684D6ABDlAgbq5k3rsnDe5jEdQ==
   dependencies:
     fs-extra "^11.0.0"
     hast-util-select "^6.0.4"
@@ -2959,6 +2959,16 @@
     unified "^11"
     unist-util-visit "^5"
 
+"@signalwire/[email protected]":
+  version "1.0.0-alpha.1"
+  resolved "https://registry.yarnpkg.com/@signalwire/docusaurus-theme-llms-txt/-/docusaurus-theme-llms-txt-1.0.0-alpha.1.tgz#596d038d72c2e70cd23f27305ea3a1c4216962ea"
+  integrity sha512-J2GfqMWh2TXV+BhwQJ7kJSSmWQTAtLbcPzd/OD6Fpd4ZNF6Q5vNgLNNxPSNSM5rqfzTD2j73vP5PZiH0lB4nBQ==
+  dependencies:
+    "@docusaurus/core" "^3.0.0"
+    "@docusaurus/theme-common" "^3.0.0"
+    clsx "^2.0.0"
+    react-icons "5.5.0"
+
 "@signalwire/[email protected]":
   version "3.29.1"
   resolved "https://registry.yarnpkg.com/@signalwire/js/-/js-3.29.1.tgz#d39def63d80942aa35abcd1504a13e9476255298"
@@ -10589,7 +10599,7 @@ react-hook-form@^7.59.0:
   resolved "https://registry.npmjs.org/react-hook-form/-/react-hook-form-7.62.0.tgz"
   integrity sha512-7KWFejc98xqG/F4bAxpL41NB3o1nnvQO1RWZT3TqRZYL8RryQETGfEdVnJN2fy1crCiBLLjkRBVK05j24FxJGA==
 
-react-icons@^5.4.0:
+react-icons@5.5.0, react-icons@^5.4.0:
   version "5.5.0"
   resolved "https://registry.npmjs.org/react-icons/-/react-icons-5.5.0.tgz"
   integrity sha512-MEFcXdkP3dLo8uumGI5xN3lDFNsRtrjbOEKDLD7yv76v4wpnEq2Lt2qeHaQOr34I/wPN3s3+N08WkQ+CW37Xiw==