Feature title
Feature description
This is a note.
Feature description
Feature description
diff --git a/server/fixtures/llms/code-block-commands.html b/server/fixtures/llms/code-block-commands.html new file mode 100644 index 00000000..9c7ce915 --- /dev/null +++ b/server/fixtures/llms/code-block-commands.html @@ -0,0 +1 @@ +tsh login --proxy=example.teleport.sh
const x = 1;const y = 2;
Before comment.
After comment.
diff --git a/server/fixtures/llms/heading-anchor-links.html b/server/fixtures/llms/heading-anchor-links.html new file mode 100644 index 00000000..280e6820 --- /dev/null +++ b/server/fixtures/llms/heading-anchor-links.html @@ -0,0 +1 @@ +Some content
\ No newline at end of file diff --git a/server/fixtures/llms/heading-with-regular-link.html b/server/fixtures/llms/heading-with-regular-link.html new file mode 100644 index 00000000..929f8097 --- /dev/null +++ b/server/fixtures/llms/heading-with-regular-link.html @@ -0,0 +1 @@ +Normal paragraph.
Another paragraph.
diff --git a/server/fixtures/llms/reposition-h1-with-duplicate.html b/server/fixtures/llms/reposition-h1-with-duplicate.html new file mode 100644 index 00000000..e7116dee --- /dev/null +++ b/server/fixtures/llms/reposition-h1-with-duplicate.html @@ -0,0 +1 @@ +Some content
Some content
More content
\ No newline at end of file diff --git a/server/fixtures/llms/result/admonition.html b/server/fixtures/llms/result/admonition.html new file mode 100644 index 00000000..04a4d13f --- /dev/null +++ b/server/fixtures/llms/result/admonition.html @@ -0,0 +1 @@ +This is a note.
Feature description
diff --git a/server/fixtures/llms/result/anchor-mixed-content.html b/server/fixtures/llms/result/anchor-mixed-content.html new file mode 100644 index 00000000..7127b8b1 --- /dev/null +++ b/server/fixtures/llms/result/anchor-mixed-content.html @@ -0,0 +1 @@ +Feature description
diff --git a/server/fixtures/llms/result/code-block-commands.html b/server/fixtures/llms/result/code-block-commands.html new file mode 100644 index 00000000..259138bc --- /dev/null +++ b/server/fixtures/llms/result/code-block-commands.html @@ -0,0 +1 @@ +$ tsh login --proxy=example.teleport.shconst x = 1;
+const y = 2;Before comment.
After comment.
diff --git a/server/fixtures/llms/result/heading-anchor-links.html b/server/fixtures/llms/result/heading-anchor-links.html new file mode 100644 index 00000000..8b87eebb --- /dev/null +++ b/server/fixtures/llms/result/heading-anchor-links.html @@ -0,0 +1 @@ +Some content
\ No newline at end of file diff --git a/server/fixtures/llms/result/heading-with-regular-link.html b/server/fixtures/llms/result/heading-with-regular-link.html new file mode 100644 index 00000000..929f8097 --- /dev/null +++ b/server/fixtures/llms/result/heading-with-regular-link.html @@ -0,0 +1 @@ +Normal paragraph.
Another paragraph.
diff --git a/server/fixtures/llms/result/reposition-h1-with-duplicate.html b/server/fixtures/llms/result/reposition-h1-with-duplicate.html new file mode 100644 index 00000000..2d0a4c59 --- /dev/null +++ b/server/fixtures/llms/result/reposition-h1-with-duplicate.html @@ -0,0 +1 @@ +Some content
diff --git a/server/fixtures/llms/result/reposition-h1.html b/server/fixtures/llms/result/reposition-h1.html new file mode 100644 index 00000000..dfa83bba --- /dev/null +++ b/server/fixtures/llms/result/reposition-h1.html @@ -0,0 +1 @@ +Some content
More content
diff --git a/server/fixtures/llms/result/tabs.html b/server/fixtures/llms/result/tabs.html new file mode 100644 index 00000000..2ed7a5c1 --- /dev/null +++ b/server/fixtures/llms/result/tabs.html @@ -0,0 +1 @@ +Tab 1 content
Tab 2 content
Connect to example.teleport.sh
diff --git a/server/fixtures/llms/tabs.html b/server/fixtures/llms/tabs.html new file mode 100644 index 00000000..b2a5ea3a --- /dev/null +++ b/server/fixtures/llms/tabs.html @@ -0,0 +1 @@ +Tab 1 content
Tab 2 content
Connect to example.teleport.sh
\ No newline at end of file diff --git a/server/llms/index.ts b/server/llms/index.ts new file mode 100644 index 00000000..77d3b7e1 --- /dev/null +++ b/server/llms/index.ts @@ -0,0 +1,126 @@ +import type { Options as PluginOptions } from "@signalwire/docusaurus-plugin-llms-txt"; +import rehypePrepareHTML from "./rehype-prepare-html"; + +// Define the sections for the llms.txt index file, including their routes and descriptions +const sections = [ + { + id: "get-started", + name: "Get Started", + description: + "Learn how to deploy a cluster, connect infrastructure, set up access controls, and review audit logs.", + routes: [{ route: "/docs/get-started/**" }], + position: 0, + }, + { + id: "core-concepts", + name: "Core Concepts", + description: "Learn the key components that make up Teleport.", + routes: [{ route: "/docs/core-concepts/**" }], + position: 1, + }, + { + id: "agentic-identity-framework", + name: "Agentic Identity Framework", + description: + "Design and reference implementation for the secure deployment of agents on infrastructure.", + routes: [{ route: "/docs/agentic-identity-framework/**" }], + position: 2, + }, + { + id: "installation", + name: "Installation", + description: + "How to install Teleport and Teleport's client tools on your platform, including binaries and instructions for Docker and Helm.", + routes: [{ route: "/docs/installation/**" }], + position: 3, + }, + { + id: "connect-your-client", + name: "Teleport User Guides", + description: + "Provides instructions to help users connect to infrastructure resources with Teleport.", + routes: [{ route: "/docs/connect-your-client/**" }], + position: 4, + }, + { + id: "zero-trust-access", + name: "Teleport Zero Trust Access", + description: + "Easy access to all your infrastructure, on a foundation of cryptographic identity and zero trust.", + routes: [{ route: "/docs/zero-trust-access/**" }], + position: 5, + }, + { + id: "machine-workload-identity", + name: "Machine & Workload Identity", + description: + "Use Teleport to replace long-lived secrets with identity-based authentication for your machines and workloads.", + routes: [{ route: "/docs/machine-workload-identity/**" }], + position: 6, + }, + { + id: "identity-governance", + name: "Identity Governance", + description: + "Manage on-demand access, privileges, and compliance for all your infrastructure.", + routes: [{ route: "/docs/identity-governance/**" }], + position: 7, + }, + { + id: "identity-security", + name: "Teleport Identity Security", + description: + "Teleport Identity Security centralizes access policy across your infrastructure, consolidates disparate identity audit logs, discovers shadow access, and alerts on access anomalies.", + routes: [{ route: "/docs/identity-security/**" }], + position: 8, + }, + { + id: "enroll-resources", + name: "Enroll Resources", + description: + "Teleport protects infrastructure resources such as servers, databases, and Kubernetes clusters by enforcing strong access controls and auditability.", + routes: [{ route: "/docs/enroll-resources/**" }], + position: 9, + }, + { + id: "reference-guides", + name: "Teleport Reference Guides", + description: + "Provides comprehensive information on configuration fields, Teleport commands, and other ways of interacting with Teleport.", + routes: [{ route: "/docs/reference/**" }], + position: 10, + }, +]; + +export const llmsTxtPluginOptions: PluginOptions = { + // Top-level runtime options + logLevel: 1, + onRouteError: "throw", + onSectionError: "throw", + runOnPostBuild: true, + + // Markdown file generation options + markdown: { + relativePaths: false, // Whether to use relative paths or absolute path URLs in the generated markdown files + beforeDefaultRehypePlugins: [rehypePrepareHTML], // Custom rehype plugins to clean up and reposition content for cleaner markdown output + remarkStringify: { + bullet: "-", + rule: "-", + ruleRepetition: 3, + }, + }, + + // llms.txt index file options + llmsTxt: { + sections, + autoSectionPosition: 11, + includeDocs: true, + includeBlog: false, + includePages: false, + excludeRoutes: ["/docs/tags/**"], + enableDescriptions: true, + siteTitle: "Teleport documentation", + siteDescription: + "Teleport is an identity-based access platform that secures servers, Kubernetes clusters, databases, internal applications, and desktops using short-lived certificates, detailed audit logging, and fine-grained role-based access controls tied to your SSO provider (e.g., Okta, GitHub, Google Workspace).", + }, +}; diff --git a/server/llms/rehype-prepare-html.test.ts b/server/llms/rehype-prepare-html.test.ts new file mode 100644 index 00000000..2ce7472e --- /dev/null +++ b/server/llms/rehype-prepare-html.test.ts @@ -0,0 +1,211 @@ +import { describe, expect, test } from "@jest/globals"; +import { readFileSync } from "fs"; +import { resolve } from "path"; +import { unified } from "unified"; +import rehypeParse from "rehype-parse"; +import rehypeStringify from "rehype-stringify"; +import rehypeProcessCustomComponents from "./rehype-prepare-html"; + +describe("server/llms/rehype-prepare-html", () => { + const transformer = (html: string) => + unified() + .use(rehypeParse, { fragment: true }) + .use(rehypeProcessCustomComponents) + .use(rehypeStringify) + .processSync(html); + + test("Var: replaces wrapper-input span with the input placeholder text", () => { + const result = transformer( + readFileSync(resolve("server/fixtures/llms/var-component.html"), "utf-8"), + ); + + expect((result.value as string).trim()).toBe( + readFileSync( + resolve("server/fixtures/llms/result/var-component.html"), + "utf-8", + ).trim(), + ); + }); + + test("Admonition: wraps block in hr separators and uppercases the type title", () => { + const result = transformer( + readFileSync(resolve("server/fixtures/llms/admonition.html"), "utf-8"), + ); + + expect((result.value as string).trim()).toBe( + readFileSync( + resolve("server/fixtures/llms/result/admonition.html"), + "utf-8", + ).trim(), + ); + }); + + test("Tabs: restructures so each tab label is directly followed by its content", () => { + const result = transformer( + readFileSync(resolve("server/fixtures/llms/tabs.html"), "utf-8"), + ); + + expect((result.value as string).trim()).toBe( + readFileSync( + resolve("server/fixtures/llms/result/tabs.html"), + "utf-8", + ).trim(), + ); + }); + + test("Code block: extracts line text into a clean pre/code structure", () => { + const result = transformer( + readFileSync(resolve("server/fixtures/llms/code-block.html"), "utf-8"), + ); + + expect((result.value as string).trim()).toBe( + readFileSync( + resolve("server/fixtures/llms/result/code-block.html"), + "utf-8", + ).trim(), + ); + }); + + test("Code block: prepends data-content prefix to command lines", () => { + const result = transformer( + readFileSync( + resolve("server/fixtures/llms/code-block-commands.html"), + "utf-8", + ), + ); + + expect((result.value as string).trim()).toBe( + readFileSync( + resolve("server/fixtures/llms/result/code-block-commands.html"), + "utf-8", + ).trim(), + ); + }); + + test("Link with inner content: only headings keep the link, other elements are unwrapped", () => { + const result = transformer( + readFileSync( + resolve("server/fixtures/llms/anchor-mixed-content.html"), + "utf-8", + ), + ); + + expect((result.value as string).trim()).toBe( + readFileSync( + resolve("server/fixtures/llms/result/anchor-mixed-content.html"), + "utf-8", + ).trim(), + ); + }); + + test("Link with deeply nested content: traverses into wrapper divs, headings keep the link and other elements are unwrapped", () => { + const result = transformer( + readFileSync( + resolve("server/fixtures/llms/anchor-mixed-content-nested.html"), + "utf-8", + ), + ); + + expect((result.value as string).trim()).toBe( + readFileSync( + resolve("server/fixtures/llms/result/anchor-mixed-content-nested.html"), + "utf-8", + ).trim(), + ); + }); + + test("Heading anchor links: removes hash-link anchors from all heading levels", () => { + const result = transformer( + readFileSync( + resolve("server/fixtures/llms/heading-anchor-links.html"), + "utf-8", + ), + ); + + expect((result.value as string).trim()).toBe( + readFileSync( + resolve("server/fixtures/llms/result/heading-anchor-links.html"), + "utf-8", + ).trim(), + ); + }); + + test("Heading anchor links: does not remove non-hash-link anchors from headings", () => { + const result = transformer( + readFileSync( + resolve("server/fixtures/llms/heading-with-regular-link.html"), + "utf-8", + ), + ); + + expect((result.value as string).trim()).toBe( + readFileSync( + resolve("server/fixtures/llms/result/heading-with-regular-link.html"), + "utf-8", + ).trim(), + ); + }); + + test("Irrelevant components: removes thumbsFeedback and checkpoint components, preserving other content", () => { + const result = transformer( + readFileSync( + resolve("server/fixtures/llms/irrelevant-components.html"), + "utf-8", + ), + ); + + expect((result.value as string).trim()).toBe( + readFileSync( + resolve("server/fixtures/llms/result/irrelevant-components.html"), + "utf-8", + ).trim(), + ); + }); + + test("Irrelevant components: removes empty HTML comments", () => { + const result = transformer( + readFileSync( + resolve("server/fixtures/llms/empty-comments.html"), + "utf-8", + ), + ); + + expect((result.value as string).trim()).toBe( + readFileSync( + resolve("server/fixtures/llms/result/empty-comments.html"), + "utf-8", + ).trim(), + ); + }); + + test("H1 repositioning: moves h1 out of a header element to the top of the tree", () => { + const result = transformer( + readFileSync(resolve("server/fixtures/llms/reposition-h1.html"), "utf-8"), + ); + + expect((result.value as string).trim()).toBe( + readFileSync( + resolve("server/fixtures/llms/result/reposition-h1.html"), + "utf-8", + ).trim(), + ); + }); + + test("H1 repositioning: removes duplicate h1 elements after repositioning", () => { + const result = transformer( + readFileSync( + resolve("server/fixtures/llms/reposition-h1-with-duplicate.html"), + "utf-8", + ), + ); + + expect((result.value as string).trim()).toBe( + readFileSync( + resolve( + "server/fixtures/llms/result/reposition-h1-with-duplicate.html", + ), + "utf-8", + ).trim(), + ); + }); +}); diff --git a/server/llms/rehype-prepare-html.ts b/server/llms/rehype-prepare-html.ts new file mode 100644 index 00000000..f1c08825 --- /dev/null +++ b/server/llms/rehype-prepare-html.ts @@ -0,0 +1,427 @@ +import { Root, Element, Text, Comment } from "hast"; +import { Plugin } from "unified"; +import { visitParents, SKIP } from "unist-util-visit-parents"; + +/* + * Process html components for cleaner markdown ouput. + * + * Admonition: wrap the block in horizontal rule separators and turn the title into uppercase text + * Tabs: place tab content directly after the label + * Var: prevent duplicate text by keeping only the placeholder text + * Code blocks: extract text content and replace with clean structure
+ * Card links: prevent duplicate links in the markdown output
+ * Heading anchor links: remove hash-link anchors from headings
+ * Irrelevant components: remove interactive UI components (thumbsFeedback, checkpoint, docsHeader)
+ * H1 repositioning: move the h1 heading to the top of the document
+ */
+
+type CodeBlockEntry = {
+ outerWrapper: Element;
+ outerParent: Element | Root;
+ pre: Element;
+};
+
+type AnchorEntry = {
+ node: Element;
+ parent: Element | Root;
+};
+
+const rehypePrepareHTML: Plugin<[], Root, Root> = function () {
+ return (tree: Root) => {
+ const irrelevantClassPrefixes = [
+ "thumbsFeedback",
+ "checkpoint",
+ "docsHeader",
+ ]; // Add any other class prefixes in order to remove irrelevant components, if needed
+
+ // --- Track nodes for post-processing ---
+ const toRemove: Array<{
+ node: Element | Comment;
+ parent: Element | Root;
+ }> = [];
+
+ let h1: Element | null = null;
+ let headerElement: Element | null = null;
+ let headerParent: Element | Root | null = null;
+
+ const varNodes: Array<{ node: Element; parent: Element | Root }> = [];
+ const admonitionNodes: Array<{
+ node: Element;
+ parent: Element | Root;
+ }> = [];
+ const tabNodes: Element[] = [];
+
+ const codeBlocks: CodeBlockEntry[] = [];
+
+ const anchorEntries = new Map(); // track tags that wrap around content (card links)
+
+ // ----------- Collect nodes to modify or remove -----------
+
+ visitParents(tree, (node, ancestors) => {
+ // *** Empty comments ***
+ if (node.type === "comment") {
+ if ((node as Comment).value.trim() === "") {
+ const parent = ancestors[ancestors.length - 1] as Element | Root;
+ toRemove.push({ node: node as Comment, parent });
+ }
+ return;
+ }
+
+ if (node.type !== "element") return;
+
+ const element = node as Element;
+ const parent = ancestors[ancestors.length - 1] as Element | Root;
+ const classes = element.properties?.className;
+ const classArray = Array.isArray(classes) ? classes : [];
+
+ // *** Irrelevant components ***
+ if (
+ classArray.some((c) =>
+ irrelevantClassPrefixes.some((prefix) =>
+ String(c).startsWith(prefix),
+ ),
+ )
+ ) {
+ toRemove.push({ node: element, parent });
+ return SKIP; // don't traverse children (e.g. avoids capturing an h1 inside a removed node)
+ }
+
+ // *** Headings ***
+ if (/^h[1-6]$/.test(element.tagName)) {
+ // Remove hash-link anchor children in-place
+ element.children = element.children.filter((child) => {
+ if (child.type !== "element") return true;
+ const childEl = child as Element;
+ if (childEl.tagName !== "a") return true;
+ const childClasses = childEl.properties?.className;
+ const childClassArray = Array.isArray(childClasses)
+ ? childClasses
+ : [];
+ return !childClassArray.includes("hash-link");
+ });
+
+ // H1 tracking / duplicate removal
+ if (element.tagName === "h1") {
+ if (!h1) {
+ h1 = element;
+ // Find the nearest ancestor
+ for (let i = ancestors.length - 1; i >= 0; i--) {
+ const ancestor = ancestors[i];
+ if (
+ ancestor.type === "element" &&
+ (ancestor as Element).tagName === "header"
+ ) {
+ headerElement = ancestor as Element;
+ headerParent = ancestors[i - 1] as Element | Root;
+ break;
+ }
+ }
+ if (!headerElement) {
+ headerParent = parent;
+ }
+ } else {
+ toRemove.push({ node: element, parent });
+ }
+ }
+
+ // Card link detection: find nearest ancestor
+ for (let i = ancestors.length - 1; i >= 0; i--) {
+ const ancestor = ancestors[i];
+ if (ancestor.type !== "element") continue;
+ const ancestorEl = ancestor as Element;
+ if (ancestorEl.tagName !== "a") continue;
+ if (!anchorEntries.has(ancestorEl)) {
+ const anchorParent = ancestors[i - 1] as Element | Root;
+ anchorEntries.set(ancestorEl, {
+ node: ancestorEl,
+ parent: anchorParent,
+ });
+ }
+ break;
+ }
+
+ return;
+ }
+
+ // *** Var component ***
+ if (classArray.some((c) => String(c) === "wrapper-input")) {
+ varNodes.push({ node: element, parent });
+ return;
+ }
+
+ // *** Admonition ***
+ if (classArray.some((c) => String(c) === "theme-admonition")) {
+ admonitionNodes.push({ node: element, parent });
+ return;
+ }
+
+ // *** Tabs ***
+ if (classArray.some((c) => String(c) === "theme-tabs-container")) {
+ tabNodes.push(element);
+ return;
+ }
+
+ // *** Code blocks ***
+ // Identify the code blocks by looking for the code_* css module class
+ // outerParent > outerWrapper > innerDiv > pre
+ if (
+ element.tagName === "pre" &&
+ classArray.some((c) => String(c).startsWith("code_")) &&
+ ancestors.length >= 3
+ ) {
+ const outerWrapper = ancestors[ancestors.length - 2] as Element;
+ const outerParent = ancestors[ancestors.length - 3] as Element | Root;
+ codeBlocks.push({ outerWrapper, outerParent, pre: element });
+ return;
+ }
+ });
+
+ // ----------- Post-processing: removals & modifications -----------
+
+ // Apply removals: irrelevant components, empty comments, duplicate h1s
+ for (const { node, parent } of toRemove) {
+ parent.children = parent.children.filter((child) => child !== node);
+ }
+
+ // *** Var component: replace with just the placeholder text ***
+ for (const { node, parent } of varNodes) {
+ let placeholder = "";
+ for (const child of node.children) {
+ if (child.type === "element") {
+ const childEl = child as Element;
+ if (childEl.tagName === "input" && childEl.properties?.placeholder) {
+ placeholder = String(childEl.properties.placeholder);
+ break;
+ }
+ }
+ }
+ const idx = parent.children.indexOf(node);
+ if (idx >= 0) {
+ const textNode: Text = { type: "text", value: placeholder };
+ parent.children.splice(idx, 1, textNode);
+ }
+ }
+
+ // *** Admonition: add
separators and capitalize the type title ***
+ for (const { node, parent } of admonitionNodes) {
+ for (const child of node.children) {
+ if (child.type !== "element") continue;
+ const childEl = child as Element;
+ const childClasses = childEl.properties?.className;
+ const childClassArray = Array.isArray(childClasses) ? childClasses : [];
+ if (
+ !childClassArray.some((c) =>
+ String(c).startsWith("admonitionHeading"),
+ )
+ )
+ continue;
+ for (const headingChild of childEl.children) {
+ if (headingChild.type === "text") {
+ const textNode = headingChild as Text;
+ const trimmed = textNode.value.trim();
+ if (trimmed) {
+ textNode.value = trimmed.toUpperCase();
+ }
+ }
+ }
+ break;
+ }
+
+ const hr = (): Element => ({
+ type: "element",
+ tagName: "hr",
+ properties: {},
+ children: [],
+ });
+ const idx = parent.children.indexOf(node);
+ if (idx >= 0) {
+ parent.children.splice(idx, 0, hr()); // insert before
+ parent.children.splice(idx + 2, 0, hr()); // insert after
+ }
+ }
+
+ // *** Tabs: restructure so each tab title is directly followed by the content ***
+ for (const element of tabNodes) {
+ const tabItems: Element[] = [];
+ const tabPanels: Element[] = [];
+
+ for (const child of element.children) {
+ if (child.type !== "element") continue;
+ const childEl = child as Element;
+ if (
+ childEl.tagName === "ul" &&
+ childEl.properties?.role === "tablist"
+ ) {
+ for (const li of childEl.children) {
+ if (li.type === "element" && (li as Element).tagName === "li") {
+ tabItems.push(li as Element);
+ }
+ }
+ } else {
+ for (const panelChild of childEl.children) {
+ if (panelChild.type !== "element") continue;
+ const panelEl = panelChild as Element;
+ if (panelEl.properties?.role === "tabpanel") {
+ tabPanels.push(panelEl);
+ }
+ }
+ }
+ }
+
+ const newChildren: Element[] = [];
+ for (let i = 0; i < tabItems.length; i++) {
+ const label: Element = {
+ type: "element",
+ tagName: "strong",
+ properties: {},
+ children: tabItems[i].children,
+ };
+ newChildren.push(label);
+ if (tabPanels[i]) {
+ newChildren.push(tabPanels[i]);
+ }
+ }
+
+ element.children = newChildren;
+ }
+
+ // *** Code blocks: make sure the code blocks show up as expected ***
+ {
+ function extractInnerText(node: Element): string {
+ let text = "";
+ for (const child of node.children) {
+ if (child.type === "text") {
+ text += (child as Text).value;
+ } else if (child.type === "element") {
+ text += extractInnerText(child as Element);
+ }
+ }
+ return text;
+ }
+
+ for (const { outerWrapper, outerParent, pre } of codeBlocks) {
+ // Locate the scroll_* div inside the pre
+ let scrollDiv: Element | null = null;
+ for (const child of pre.children) {
+ if (child.type !== "element") continue;
+ const el = child as Element;
+ const elClasses = el.properties?.className;
+ const elClassArray = Array.isArray(elClasses) ? elClasses : [];
+ if (elClassArray.some((c) => String(c).startsWith("scroll_"))) {
+ scrollDiv = el;
+ break;
+ }
+ }
+ if (!scrollDiv) continue;
+
+ // Extract each line of the code block
+ const lines: string[] = [];
+ for (const child of scrollDiv.children) {
+ if (child.type !== "element") continue;
+ const el = child as Element;
+ const elClasses = el.properties?.className;
+ const elClassArray = Array.isArray(elClasses) ? elClasses : [];
+
+ if (elClassArray.some((c) => String(c).startsWith("command_"))) {
+ for (const cmdChild of el.children) {
+ if (cmdChild.type !== "element") continue;
+ const cmdEl = cmdChild as Element;
+ const cmdClasses = cmdEl.properties?.className;
+ const cmdClassArray = Array.isArray(cmdClasses) ? cmdClasses : [];
+ if (!cmdClassArray.some((c) => String(c).startsWith("line_")))
+ continue;
+ const prefix =
+ cmdEl.properties?.dataContent != null
+ ? String(cmdEl.properties.dataContent)
+ : "";
+ lines.push(prefix + extractInnerText(cmdEl));
+ }
+ } else if (
+ elClassArray.some(
+ (c) =>
+ String(c).startsWith("line_") ||
+ String(c).startsWith("comment_"),
+ )
+ ) {
+ lines.push(extractInnerText(el));
+ }
+ }
+
+ const cleanPre: Element = {
+ type: "element",
+ tagName: "pre",
+ properties: {},
+ children: [
+ {
+ type: "element",
+ tagName: "code",
+ properties: {},
+ children: [{ type: "text", value: lines.join("\n") }],
+ },
+ ],
+ };
+
+ const idx = outerParent.children.indexOf(outerWrapper);
+ if (idx >= 0) {
+ outerParent.children.splice(idx, 1, cleanPre);
+ }
+ }
+ }
+
+ // *** Card links: only headings keep the link ***
+ // Prevents the same link from being repeated multiple times in custom card components with an wrapper.
+ {
+ function collectNodes(
+ node: Element,
+ href: Element["properties"][string],
+ ): Element[] {
+ const results: Element[] = [];
+ for (const child of node.children) {
+ if (child.type !== "element") continue;
+ const childEl = child as Element;
+ if (/^h[1-6]$/.test(childEl.tagName)) {
+ results.push({
+ type: "element",
+ tagName: "a",
+ properties: { href },
+ children: [childEl],
+ });
+ } else if (/^(p)$/.test(childEl.tagName)) {
+ results.push(childEl);
+ } else if (/^(img|svg)$/.test(childEl.tagName)) {
+ continue;
+ } else {
+ const nested = collectNodes(childEl, href);
+ if (nested.length > 0) {
+ results.push(...nested);
+ } else {
+ // Keep other elements as is
+ results.push(childEl);
+ }
+ }
+ }
+ return results;
+ }
+
+ for (const { node, parent } of anchorEntries.values()) {
+ const href = node.properties?.href;
+ const newNodes = collectNodes(node, href);
+ const idx = parent.children.indexOf(node);
+ if (idx >= 0) {
+ parent.children.splice(idx, 1, ...newNodes);
+ }
+ }
+ }
+
+ // *** H1 repositioning: move the h1 to the top of the document ***
+ if (h1 && headerParent) {
+ const nodeToRemove = headerElement ?? h1;
+ headerParent.children = headerParent.children.filter(
+ (child) => child !== nodeToRemove,
+ );
+ headerParent.children.unshift(h1);
+ }
+ };
+};
+
+export default rehypePrepareHTML;
diff --git a/server/unist-augment.d.ts b/server/unist-augment.d.ts
new file mode 100644
index 00000000..de07386f
--- /dev/null
+++ b/server/unist-augment.d.ts
@@ -0,0 +1,12 @@
+export {};
+
+// Augments the `Data` interface in @types/unist to add an index signature,
+// resolving a type mismatch caused by @types/mdast bundling its own copy of
+// @types/unist whose `Data` already has [key: string]: unknown. Without this,
+// unist-util-visit's Node parameter is incompatible with nodes typed
+// against the top-level @types/unist package.
+declare module "unist" {
+ interface Data {
+ [key: string]: unknown;
+ }
+}
\ No newline at end of file
diff --git a/src/components/Icon/icons.ts b/src/components/Icon/icons.ts
index bb24e6ed..c90513ec 100644
--- a/src/components/Icon/icons.ts
+++ b/src/components/Icon/icons.ts
@@ -119,6 +119,8 @@ export { default as youtube } from "./svg/youtube.svg";
export { default as rocketLaunch } from "./svg/rocket-launch.svg";
export { default as chat } from "./svg/chat-circle.svg";
export { default as lightbulb } from "./svg/lightbulb.svg";
+export { default as githubLogo } from "./svg/github-logo.svg";
+export { default as markdown } from "./svg/markdown.svg";
// Teleport svgs
export { default as agent } from "./teleport-svg/agent.svg";
diff --git a/src/components/Icon/svg/github-logo.svg b/src/components/Icon/svg/github-logo.svg
new file mode 100644
index 00000000..bfe5ae90
--- /dev/null
+++ b/src/components/Icon/svg/github-logo.svg
@@ -0,0 +1,3 @@
+
diff --git a/src/components/Icon/svg/markdown.svg b/src/components/Icon/svg/markdown.svg
new file mode 100644
index 00000000..1f995f0a
--- /dev/null
+++ b/src/components/Icon/svg/markdown.svg
@@ -0,0 +1,5 @@
+
diff --git a/src/components/PageActions/PageActions.module.css b/src/components/PageActions/PageActions.module.css
index 05a1f610..a293a083 100644
--- a/src/components/PageActions/PageActions.module.css
+++ b/src/components/PageActions/PageActions.module.css
@@ -1,26 +1,26 @@
.pageActions {
display: flex;
- gap: var(--m-4);
- padding: var(--m-2) 0;
+ gap: var(--m-3);
+ padding: var(--m-1-5) 0;
border-bottom: 1px solid var(--color-tonal-neutral-2);
margin-bottom: var(--m-5);
- @media (--sm-scr) {
- & > * {
- &:not(:nth-last-child(2)) {
- &::after {
- content: "";
- position: relative;
- transform: translateX(var(--m-2));
- width: 1px;
- height: 100%;
- background-color: var(--color-tonal-neutral-1);
- }
+ & > * {
+ &:not(:nth-last-child(2)) {
+ &::after {
+ content: "";
+ position: relative;
+ transform: translateX(var(--m-1-5));
+ width: 1px;
+ height: 100%;
+ background-color: var(--color-tonal-neutral-1);
}
}
}
@media (--lg-scr) {
+ gap: var(--m-4);
+ margin-bottom: var(--m-6);
& > * {
&:not(:last-child) {
&::after {
@@ -40,6 +40,11 @@
background-color: unset;
border: unset;
position: relative;
+
+ span {
+ width: 100%;
+ text-align: left;
+ }
}
.githubLink,
@@ -48,7 +53,7 @@
color: var(--color-foreground-slightly-muted);
display: flex;
align-items: center;
- font-size: var(--fs-text-md);
+ font-size: var(--fs-text-lg);
letter-spacing: 0.024px;
line-height: 1.625;
margin: 0;
@@ -58,11 +63,15 @@
& > svg {
width: 20px;
height: 20px;
- margin-right: var(--m-1);
+ min-width: 20px;
+ min-height: 20px;
+ margin-right: var(--m-0-5);
+ & > path {
+ fill: var(--color-foreground-muted);
+ }
}
@media (--xs-scr) {
- font-size: var(--fs-text-lg);
width: auto;
height: auto;
}
diff --git a/src/components/PageActions/PageActions.tsx b/src/components/PageActions/PageActions.tsx
index 5b88de08..b0f1cc92 100644
--- a/src/components/PageActions/PageActions.tsx
+++ b/src/components/PageActions/PageActions.tsx
@@ -4,25 +4,60 @@ import Icon from "../Icon";
import { useInkeepSearch } from "@site/src/hooks/useInkeepSearch";
import BrowserOnly from "@docusaurus/BrowserOnly";
import ThumbsFeedback from "../ThumbsFeedback";
+import {
+ copyPageContentAsMarkdown,
+ normalizeMarkdownPathname,
+} from "@site/src/utils/markdown";
+import { useMemo, useRef, useState } from "react";
+import { useWindowSize } from "@docusaurus/theme-common";
const PageActions: React.FC<{ pathname: string }> = ({ pathname }) => {
const { setIsOpen, ModalSearchAndChat, inkeepModalProps } = useInkeepSearch({
enableAIChat: true,
});
+ const windowSize = useWindowSize();
+ const [copiedMessage, setCopiedMessage] = useState("Copy for LLM");
+
+ const copyButtonRef = useRef(null);
+
+ const copyButtonWidth = useMemo(
+ () => copyButtonRef.current?.offsetWidth || 125,
+ [copyButtonRef.current?.offsetWidth],
+ );
+
return (
-
-