rspress-plugin-api-extractor 0.1.2 → 0.2.0

package/markdown/index.js

@@ -0,0 +1,11 @@
+import { MarkdownCrossLinker, markdownCrossLinker } from "./cross-linker.js";
+import { ClassPageGenerator } from "./page-generators/class-page.js";
+import { EnumPageGenerator } from "./page-generators/enum-page.js";
+import { FunctionPageGenerator } from "./page-generators/function-page.js";
+import { MainIndexPageGenerator } from "./page-generators/index-pages.js";
+import { InterfacePageGenerator } from "./page-generators/interface-page.js";
+import { NamespacePageGenerator } from "./page-generators/namespace-page.js";
+import { TypeAliasPageGenerator } from "./page-generators/type-alias-page.js";
+import { VariablePageGenerator } from "./page-generators/variable-page.js";
+
+export {  };

package/markdown/page-generators/class-page.js

@@ -0,0 +1,357 @@
+import { ApiParser } from "../../loader.js";
+import { TypeReferenceExtractor } from "../../type-reference-extractor.js";
+import { escapeMdxGenerics, formatExampleCode, generateAvailableFrom, generateFrontmatter, prepareExampleCode, prependHiddenImports, sanitizeId, stripTwoslashDirectives } from "../helpers.js";
+import { markdownCrossLinker } from "../cross-linker.js";
+import { TypeSignatureFormatter } from "../../formatter.js";
+
+//#region src/markdown/page-generators/class-page.ts
+/**
+* Generates MDX documentation pages for TypeScript/JavaScript classes.
+*
+* This class transforms API Extractor class models into rich MDX documentation pages
+* with syntax-highlighted signatures, cross-linked type references, and interactive
+* features like copy-to-clipboard and line wrapping.
+*
+* **Page Structure:**
+* 1. Frontmatter with title, description, and Open Graph metadata
+* 2. Component imports (SourceCode, ParametersTable, ApiSignature, etc.)
+* 3. Page title (H1) and summary
+* 4. Optional deprecation warning and release tag badge
+* 5. Source code link toolbar
+* 6. Full class signature block showing all members
+* 7. Member sections: Constructors, Static Properties, Static Methods, Properties, Getters/Setters, Methods
+* 8. Examples section with Twoslash-enabled code blocks
+* 9. See Also references
+*
+* **Member Rendering:**
+* Each member is rendered with:
+* - An `ApiMember` component showing the signature in class context
+* - Optional `ParametersTable` for methods with parameters
+* - Return type documentation
+* - Cross-linked type references
+*
+* **Relationships:**
+* - Created and invoked by {@link ApiExtractorPlugin} during page generation
+* - Uses {@link TypeSignatureFormatter} for formatting type signatures
+* - Uses {@link ApiParser} for extracting documentation from API models
+* - Uses {@link MarkdownCrossLinker} for adding type reference links
+*
+* @example
+* ```ts
+* const generator = new ClassPageGenerator();
+* const { routePath, content } = await generator.generate(
+*   apiClass,
+*   "/api/my-package",
+*   "my-package",
+*   "Class",
+*   "My Package",
+*   sourceConfig,
+*   true, // suppressExampleErrors
+*   undefined, // llmsPlugin
+*   "claude-binary-plugin", // apiScope
+* );
+* ```
+*
+* @see {@link InterfacePageGenerator} for interface documentation
+* @see {@link FunctionPageGenerator} for function documentation
+*/
+var ClassPageGenerator = class {
+	typeFormatter = new TypeSignatureFormatter();
+	/**
+	* Generate a markdown page for a class
+	*
+	* @param apiScope - API scope identifier for VFS lookup
+	*/
+	async generate(apiClass, baseRoute, packageName, singularName, apiScope, apiName, sourceConfig, suppressExampleErrors, llmsPlugin, availableFrom) {
+		const shouldSuppressErrors = suppressExampleErrors ?? true;
+		const name = apiClass.displayName;
+		const summary = ApiParser.getSummary(apiClass) || "No description available.";
+		const releaseTag = ApiParser.getReleaseTag(apiClass);
+		let content = generateFrontmatter(name, summary, singularName, apiName);
+		content += `import { SourceCode } from "@rspress/core/theme";\n`;
+		content += `import { ParametersTable } from "rspress-plugin-api-extractor/runtime";\n`;
+		content += `import { ApiSignature, ApiMember, ApiExample } from "rspress-plugin-api-extractor/runtime";\n\n`;
+		content += `# ${name}\n\n`;
+		const deprecation = ApiParser.getDeprecation(apiClass);
+		if (deprecation) {
+			const message = escapeMdxGenerics(markdownCrossLinker.addCrossLinks(deprecation.message));
+			content += `> ⚠️ **Deprecated:** ${message}\n\n`;
+		}
+		if (releaseTag !== "Public") content += `\`${releaseTag}\`\n\n`;
+		content += `${summary}\n\n`;
+		content += generateAvailableFrom(packageName, availableFrom);
+		const sourceLink = ApiParser.getSourceLink(apiClass, sourceConfig);
+		if (sourceLink) {
+			content += `<div className="api-docs-toolbar">\n`;
+			content += `  <div className="api-docs-toolbar-left">\n`;
+			content += `    <SourceCode href="${sourceLink}" />\n`;
+			content += `  </div>\n`;
+			if (llmsPlugin?.enabled) {
+				content += `  <div className="api-docs-toolbar-right">\n`;
+				content += `  </div>\n`;
+			}
+			content += `</div>\n\n`;
+		}
+		const skeleton = this.generateClassSkeletonWithTwoslash(apiClass, packageName);
+		const displayCode = stripTwoslashDirectives(skeleton);
+		content += `<ApiSignature code={${JSON.stringify(displayCode)}} source={${JSON.stringify(skeleton)}} apiScope={${JSON.stringify(apiScope)}} />\n\n`;
+		const constructors = apiClass.members.filter((m) => m.kind === "Constructor");
+		if (constructors.length > 0) {
+			content += `## Constructors\n\n`;
+			for (const ctor of constructors) {
+				const ctorSummary = ApiParser.getSummary(ctor);
+				const ctorId = sanitizeId("constructor");
+				const ctorItem = ctor;
+				const params = ApiParser.getParams(ctor);
+				const hasParameters = params.length > 0;
+				if (ctorItem.excerpt?.text) {
+					const memberSignature = this.typeFormatter.format(ctorItem.excerpt).trim();
+					const skeletonWithContext = this.generateClassMemberWithContext(apiClass, ctor, packageName);
+					const summaryMd = ctorSummary ? escapeMdxGenerics(markdownCrossLinker.addCrossLinks(ctorSummary)) : void 0;
+					content += `<ApiMember code={${JSON.stringify(memberSignature)}} source={${JSON.stringify(skeletonWithContext)}} apiScope={${JSON.stringify(apiScope)}} memberName="constructor"${summaryMd ? ` summary={${JSON.stringify(summaryMd)}}` : ""} id={${JSON.stringify(ctorId)}} hasParameters={${hasParameters}} />\n\n`;
+				}
+				if (hasParameters) content += `<ParametersTable parameters={${JSON.stringify(params.map((p) => ({
+					name: p.name,
+					type: p.type,
+					description: markdownCrossLinker.addCrossLinks(p.description)
+				})))}} />\n\n`;
+			}
+		}
+		const properties = apiClass.members.filter((m) => m.kind === "Property" || m.kind === "PropertySignature");
+		const methods = apiClass.members.filter((m) => m.kind === "Method" || m.kind === "MethodSignature");
+		const grouped = methods.length > 0 ? this.groupClassMembers(methods) : {
+			staticMethods: [],
+			instanceMethods: [],
+			getters: []
+		};
+		const staticProperties = properties.filter((m) => {
+			return m.isStatic === true;
+		});
+		const instanceProperties = properties.filter((m) => {
+			const isStatic = m.isStatic === true;
+			const isGetter = m.displayName.startsWith("get ") || m.displayName.startsWith("set ");
+			return !isStatic && !isGetter;
+		});
+		const prefixMap = this.detectMemberConflicts(staticProperties, grouped.staticMethods, instanceProperties, grouped.instanceMethods, grouped.getters);
+		const renderProperties = async (title, propList) => {
+			if (propList.length === 0) return;
+			content += `## ${title}\n\n`;
+			for (const prop of propList) {
+				const propSummary = ApiParser.getSummary(prop);
+				const baseName = sanitizeId(prop.displayName);
+				const prefix = prefixMap.get(baseName) || "";
+				const propId = sanitizeId(prop.displayName, prefix);
+				const propItem = prop;
+				if (propItem.excerpt?.text) {
+					const memberSignature = this.typeFormatter.format(propItem.excerpt).trim();
+					const skeletonWithContext = this.generateClassMemberWithContext(apiClass, prop, packageName);
+					const summaryMd = propSummary ? escapeMdxGenerics(markdownCrossLinker.addCrossLinks(propSummary)) : void 0;
+					content += `<ApiMember code={${JSON.stringify(memberSignature)}} source={${JSON.stringify(skeletonWithContext)}} apiScope={${JSON.stringify(apiScope)}} memberName={${JSON.stringify(prop.displayName)}}${summaryMd ? ` summary={${JSON.stringify(summaryMd)}}` : ""} id={${JSON.stringify(propId)}} />\n\n`;
+				}
+			}
+		};
+		const renderMethods = async (title, methodList) => {
+			if (methodList.length === 0) return;
+			content += `## ${title}\n\n`;
+			for (const method of methodList) {
+				const methodSummary = ApiParser.getSummary(method);
+				const baseName = sanitizeId(method.displayName);
+				const prefix = prefixMap.get(baseName) || "";
+				const methodId = sanitizeId(method.displayName, prefix);
+				const methodItem = method;
+				const params = ApiParser.getParams(method);
+				const hasParameters = params.length > 0;
+				if (methodItem.excerpt?.text) {
+					const memberSignature = this.typeFormatter.format(methodItem.excerpt).trim();
+					const skeletonWithContext = this.generateClassMemberWithContext(apiClass, method, packageName);
+					const summaryMd = methodSummary ? escapeMdxGenerics(markdownCrossLinker.addCrossLinks(methodSummary)) : void 0;
+					content += `<ApiMember code={${JSON.stringify(memberSignature)}} source={${JSON.stringify(skeletonWithContext)}} apiScope={${JSON.stringify(apiScope)}} memberName={${JSON.stringify(method.displayName)}}${summaryMd ? ` summary={${JSON.stringify(summaryMd)}}` : ""} id={${JSON.stringify(methodId)}} hasParameters={${hasParameters}} />\n\n`;
+				}
+				if (hasParameters) content += `<ParametersTable parameters={${JSON.stringify(params.map((p) => ({
+					name: p.name,
+					type: p.type,
+					description: markdownCrossLinker.addCrossLinks(p.description)
+				})))}} />\n\n`;
+				const returns = ApiParser.getReturns(method);
+				if (returns) {
+					const description = escapeMdxGenerics(markdownCrossLinker.addCrossLinks(returns.description));
+					content += `**Returns:** ${description}\n\n`;
+				}
+			}
+		};
+		await renderProperties("Static Properties", staticProperties);
+		await renderMethods("Static Methods", grouped.staticMethods);
+		await renderProperties("Properties", instanceProperties);
+		await renderMethods("Getters & Setters", grouped.getters);
+		await renderMethods("Methods", grouped.instanceMethods);
+		const examples = ApiParser.getExamples(apiClass);
+		if (examples.length > 0) {
+			content += `## Examples\n\n`;
+			for (const example of examples) {
+				const prepared = prepareExampleCode(example, name, packageName, shouldSuppressErrors);
+				const formattedCode = await formatExampleCode(prepared.code, prepared.language, {
+					api: packageName,
+					blockType: "example"
+				});
+				if (prepared.isTypeScript) {
+					const displayCode = stripTwoslashDirectives(formattedCode);
+					content += `<ApiExample code={${JSON.stringify(displayCode)}} source={${JSON.stringify(formattedCode)}} apiScope={${JSON.stringify(apiScope)}} />\n\n`;
+				} else content += `\`\`\`${prepared.language}\n${formattedCode}\n\`\`\`\n\n`;
+			}
+		}
+		const seeReferences = ApiParser.getSeeReferences(apiClass);
+		if (seeReferences.length > 0) {
+			content += `## See Also\n\n`;
+			for (const reference of seeReferences) {
+				const refText = escapeMdxGenerics(markdownCrossLinker.addCrossLinks(reference.text));
+				content += `- ${refText}\n`;
+			}
+			content += `\n`;
+		}
+		return {
+			routePath: `${baseRoute}/class/${name.toLowerCase()}`,
+			content
+		};
+	}
+	/**
+	* Group class members by their type (static, instance, getters/setters)
+	*/
+	groupClassMembers(members) {
+		const staticMethods = [];
+		const instanceMethods = [];
+		const getters = [];
+		for (const member of members) {
+			const isGetter = member.kind === "Method" && (member.displayName.startsWith("get ") || member.displayName.startsWith("set "));
+			const isStatic = member.isStatic === true;
+			if (isGetter) getters.push(member);
+			else if (isStatic) staticMethods.push(member);
+			else instanceMethods.push(member);
+		}
+		return {
+			staticMethods,
+			instanceMethods,
+			getters
+		};
+	}
+	/**
+	* Detect naming conflicts between class members and return prefixes to apply.
+	* Returns a Map of sanitized name to prefix (empty string if no conflict).
+	*/
+	detectMemberConflicts(staticProps, staticMethods, instanceProps, instanceMethods, getters) {
+		const prefixMap = /* @__PURE__ */ new Map();
+		const staticPropNames = new Set(staticProps.map((p) => sanitizeId(p.displayName)));
+		const staticMethodNames = new Set(staticMethods.map((m) => sanitizeId(m.displayName)));
+		const instancePropNames = new Set(instanceProps.map((p) => sanitizeId(p.displayName)));
+		const instanceMethodNames = new Set(instanceMethods.map((m) => sanitizeId(m.displayName)));
+		const getterNames = new Set(getters.map((g) => sanitizeId(g.displayName)));
+		for (const name of staticPropNames) if (staticMethodNames.has(name) || instancePropNames.has(name) || instanceMethodNames.has(name) || getterNames.has(name)) prefixMap.set(name, "static-property");
+		for (const name of staticMethodNames) if (instanceMethodNames.has(name) || instancePropNames.has(name) || getterNames.has(name)) prefixMap.set(name, "static");
+		else if (staticPropNames.has(name)) prefixMap.set(name, "");
+		for (const name of instancePropNames) if (instanceMethodNames.has(name) || getterNames.has(name)) prefixMap.set(name, "property");
+		else if (staticMethodNames.has(name)) prefixMap.set(name, "");
+		for (const name of instanceMethodNames) if (!prefixMap.has(name)) prefixMap.set(name, "");
+		for (const name of getterNames) if (!prefixMap.has(name)) prefixMap.set(name, "");
+		return prefixMap;
+	}
+	/**
+	* Generate a class member signature with full class context
+	* Includes hidden imports with cut directive for external type resolution
+	* Uses the simplified approach: 3 lines (class opening, member, closing)
+	*/
+	generateClassMemberWithContext(apiClass, targetMember, packageName) {
+		const className = apiClass.displayName;
+		const inheritance = ApiParser.getInheritance(apiClass);
+		let declaration = `class ${className}`;
+		if (inheritance.extends && inheritance.extends.length > 0) declaration += ` extends ${inheritance.extends.join(", ")}`;
+		if (inheritance.implements && inheritance.implements.length > 0) declaration += ` implements ${inheritance.implements.join(", ")}`;
+		declaration += " {";
+		const memberItem = targetMember;
+		const memberSignature = memberItem.excerpt?.text ? this.typeFormatter.format(memberItem.excerpt).trim() : "";
+		const skeleton = `${declaration}\n${memberSignature}\n}`;
+		const apiPackage = apiClass.getAssociatedPackage?.();
+		if (apiPackage) return prependHiddenImports(skeleton, new TypeReferenceExtractor(apiPackage, packageName).extractImportsForApiItem(targetMember));
+		return skeleton;
+	}
+	/**
+	* Generate a class skeleton for signature blocks
+	* Includes hidden imports with cut directive for external type resolution
+	*/
+	generateClassSkeletonWithTwoslash(apiClass, packageName) {
+		const skeleton = this.generateClassSkeleton(apiClass);
+		const apiPackage = apiClass.getAssociatedPackage?.();
+		if (apiPackage) return prependHiddenImports(skeleton, new TypeReferenceExtractor(apiPackage, packageName).extractImportsForApiItem(apiClass));
+		return skeleton;
+	}
+	/**
+	* Generate a complete class skeleton showing all members
+	*/
+	generateClassSkeleton(apiClass) {
+		const lines = [];
+		const className = apiClass.displayName;
+		const inheritance = ApiParser.getInheritance(apiClass);
+		let declaration = `class ${className}`;
+		if (inheritance.extends && inheritance.extends.length > 0) declaration += ` extends ${inheritance.extends.join(", ")}`;
+		if (inheritance.implements && inheritance.implements.length > 0) declaration += ` implements ${inheritance.implements.join(", ")}`;
+		declaration += " {";
+		lines.push(declaration);
+		const constructors = apiClass.members.filter((m) => m.kind === "Constructor");
+		if (constructors.length > 0) for (const ctor of constructors) {
+			const ctorItem = ctor;
+			if (ctorItem.excerpt?.text) {
+				const signature = this.typeFormatter.format(ctorItem.excerpt).trim();
+				lines.push(`    ${signature}`);
+			}
+		}
+		const methods = apiClass.members.filter((m) => m.kind === "Method" || m.kind === "MethodSignature");
+		const grouped = this.groupClassMembers(methods);
+		const properties = apiClass.members.filter((m) => m.kind === "Property" || m.kind === "PropertySignature");
+		const staticProperties = properties.filter((m) => {
+			return m.isStatic === true;
+		});
+		if (staticProperties.length > 0) for (const prop of staticProperties) {
+			const propItem = prop;
+			if (propItem.excerpt?.text) {
+				const signature = this.typeFormatter.format(propItem.excerpt).trim();
+				lines.push(`    ${signature}`);
+			}
+		}
+		if (grouped.staticMethods.length > 0) for (const method of grouped.staticMethods) {
+			const methodItem = method;
+			if (methodItem.excerpt?.text) {
+				const signature = this.typeFormatter.format(methodItem.excerpt).trim();
+				lines.push(`    ${signature}`);
+			}
+		}
+		const instanceProperties = properties.filter((m) => {
+			const isStatic = m.isStatic === true;
+			const isGetter = m.displayName.startsWith("get ") || m.displayName.startsWith("set ");
+			return !isStatic && !isGetter;
+		});
+		if (instanceProperties.length > 0) for (const prop of instanceProperties) {
+			const propItem = prop;
+			if (propItem.excerpt?.text) {
+				const signature = this.typeFormatter.format(propItem.excerpt).trim();
+				lines.push(`    ${signature}`);
+			}
+		}
+		if (grouped.getters.length > 0) for (const method of grouped.getters) {
+			const methodItem = method;
+			if (methodItem.excerpt?.text) {
+				const signature = this.typeFormatter.format(methodItem.excerpt).trim();
+				lines.push(`    ${signature}`);
+			}
+		}
+		if (grouped.instanceMethods.length > 0) for (const method of grouped.instanceMethods) {
+			const methodItem = method;
+			if (methodItem.excerpt?.text) {
+				const signature = this.typeFormatter.format(methodItem.excerpt).trim();
+				lines.push(`    ${signature}`);
+			}
+		}
+		lines.push("}");
+		return lines.join("\n");
+	}
+};
+
+//#endregion
+export { ClassPageGenerator };

package/markdown/page-generators/enum-page.js

@@ -0,0 +1,152 @@
+import { ApiParser } from "../../loader.js";
+import { escapeMdxGenerics, formatExampleCode, generateAvailableFrom, generateFrontmatter, prepareExampleCode, stripTwoslashDirectives } from "../helpers.js";
+import { markdownCrossLinker } from "../cross-linker.js";
+
+//#region src/markdown/page-generators/enum-page.ts
+/**
+* Generates MDX documentation pages for TypeScript enums.
+*
+* This class transforms API Extractor enum models into rich MDX documentation
+* pages with syntax-highlighted signatures, member tables, and cross-linked
+* type references.
+*
+* **Page Structure:**
+* 1. Frontmatter with title, description, and Open Graph metadata
+* 2. Component imports
+* 3. Page title (H1) and summary
+* 4. Optional deprecation warning and release tag badge
+* 5. Source code link toolbar
+* 6. Enum signature block
+* 7. Members table (Name, Value, Description)
+* 8. Examples section with Twoslash-enabled code blocks
+* 9. See Also references
+*
+* **Relationships:**
+* - Created and invoked by {@link ApiExtractorPlugin} during page generation
+* - Uses {@link TypeSignatureFormatter} for formatting type signatures
+* - Uses {@link ApiParser} for extracting documentation from API models
+* - Uses {@link MarkdownCrossLinker} for adding type reference links
+*
+* @see {@link TypeAliasPageGenerator} for type alias documentation
+* @see {@link VariablePageGenerator} for variable/constant documentation
+*/
+var EnumPageGenerator = class {
+	/**
+	* Generate a markdown page for an enum
+	*
+	* @param apiScope - API scope identifier for VFS lookup
+	*/
+	async generate(apiEnum, baseRoute, packageName, singularName, apiScope, apiName, sourceConfig, suppressExampleErrors, llmsPlugin, availableFrom) {
+		const shouldSuppressErrors = suppressExampleErrors ?? true;
+		const name = apiEnum.displayName;
+		const summary = ApiParser.getSummary(apiEnum) || "No description available.";
+		const releaseTag = ApiParser.getReleaseTag(apiEnum);
+		let content = generateFrontmatter(name, summary, singularName, apiName);
+		content += `import { SourceCode } from "@rspress/core/theme";\n`;
+		content += `import { EnumMembersTable } from "rspress-plugin-api-extractor/runtime";\n`;
+		content += `import { ApiSignature, ApiExample } from "rspress-plugin-api-extractor/runtime";\n\n`;
+		content += `# ${name}\n\n`;
+		const deprecation = ApiParser.getDeprecation(apiEnum);
+		if (deprecation) {
+			const message = escapeMdxGenerics(markdownCrossLinker.addCrossLinks(deprecation.message));
+			content += `> ⚠️ **Deprecated:** ${message}\n\n`;
+		}
+		if (releaseTag !== "Public") content += `\`${releaseTag}\`\n\n`;
+		content += `${summary}\n\n`;
+		content += generateAvailableFrom(packageName, availableFrom);
+		const sourceLink = ApiParser.getSourceLink(apiEnum, sourceConfig);
+		if (sourceLink) {
+			content += `<div className="api-docs-toolbar">\n`;
+			content += `  <div className="api-docs-toolbar-left">\n`;
+			content += `    <SourceCode href="${sourceLink}" />\n`;
+			content += `  </div>\n`;
+			if (llmsPlugin?.enabled) {
+				content += `  <div className="api-docs-toolbar-right">\n`;
+				content += `  </div>\n`;
+			}
+			content += `</div>\n\n`;
+		}
+		const skeleton = this.generateEnumSkeleton(apiEnum);
+		const hasMembers = apiEnum.members.length > 0;
+		if (skeleton) {
+			const displayCode = stripTwoslashDirectives(skeleton);
+			const signatureNewlines = hasMembers ? "\n" : "\n\n";
+			content += `<ApiSignature code={${JSON.stringify(displayCode)}} source={${JSON.stringify(skeleton)}} apiScope={${JSON.stringify(apiScope)}} hasMembers={${hasMembers}} />${signatureNewlines}`;
+		}
+		if (hasMembers) {
+			const membersData = apiEnum.members.map((member) => {
+				const memberItem = member;
+				const memberSummary = ApiParser.getSummary(member) || "";
+				let value;
+				if (memberItem.excerpt?.text) {
+					const excerptText = memberItem.excerpt.text.trim();
+					const equalsIndex = excerptText.indexOf("=");
+					if (equalsIndex !== -1) value = excerptText.substring(equalsIndex + 1).trim().replace(/,\s*$/, "");
+				}
+				return {
+					name: member.displayName,
+					value,
+					description: markdownCrossLinker.addCrossLinks(memberSummary)
+				};
+			});
+			content += `<EnumMembersTable members={${JSON.stringify(membersData)}} />\n\n`;
+		}
+		const examples = ApiParser.getExamples(apiEnum);
+		if (examples.length > 0) {
+			content += `## Examples\n\n`;
+			for (const example of examples) {
+				const prepared = prepareExampleCode(example, name, packageName, shouldSuppressErrors);
+				const formattedCode = await formatExampleCode(prepared.code, prepared.language, {
+					api: packageName,
+					blockType: "example"
+				});
+				if (prepared.isTypeScript) {
+					const displayCode = stripTwoslashDirectives(formattedCode);
+					content += `<ApiExample code={${JSON.stringify(displayCode)}} source={${JSON.stringify(formattedCode)}} apiScope={${JSON.stringify(apiScope)}} />\n\n`;
+				} else content += `\`\`\`${prepared.language}\n${formattedCode}\n\`\`\`\n\n`;
+			}
+		}
+		const seeReferences = ApiParser.getSeeReferences(apiEnum);
+		if (seeReferences.length > 0) {
+			content += `## See Also\n\n`;
+			for (const reference of seeReferences) {
+				const refText = escapeMdxGenerics(markdownCrossLinker.addCrossLinks(reference.text));
+				content += `- ${refText}\n`;
+			}
+			content += `\n`;
+		}
+		return {
+			routePath: `${baseRoute}/enum/${name.toLowerCase()}`,
+			content
+		};
+	}
+	/**
+	* Generate a complete enum skeleton showing all members
+	*/
+	generateEnumSkeleton(apiEnum) {
+		const lines = [];
+		const enumName = apiEnum.displayName;
+		lines.push(`enum ${enumName} {`);
+		const members = apiEnum.members;
+		for (let i = 0; i < members.length; i++) {
+			const member = members[i];
+			const memberItem = member;
+			let memberLine = `    ${member.displayName}`;
+			if (memberItem.excerpt?.text) {
+				const excerptText = memberItem.excerpt.text.trim();
+				const equalsIndex = excerptText.indexOf("=");
+				if (equalsIndex !== -1) {
+					const value = excerptText.substring(equalsIndex + 1).trim().replace(/,\s*$/, "");
+					memberLine += ` = ${value}`;
+				}
+			}
+			if (i < members.length - 1) memberLine += ",";
+			lines.push(memberLine);
+		}
+		lines.push("}");
+		return lines.join("\n");
+	}
+};
+
+//#endregion
+export { EnumPageGenerator };

package/markdown/page-generators/function-page.js

@@ -0,0 +1,127 @@
+import { ApiParser } from "../../loader.js";
+import { TypeReferenceExtractor } from "../../type-reference-extractor.js";
+import { escapeMdxGenerics, formatExampleCode, generateAvailableFrom, generateFrontmatter, prepareExampleCode, prependHiddenImports, stripTwoslashDirectives } from "../helpers.js";
+import { markdownCrossLinker } from "../cross-linker.js";
+import { TypeSignatureFormatter } from "../../formatter.js";
+
+//#region src/markdown/page-generators/function-page.ts
+/**
+* Generates MDX documentation pages for TypeScript/JavaScript functions.
+*
+* This class transforms API Extractor function models into rich MDX documentation
+* pages with syntax-highlighted signatures and cross-linked type references.
+*
+* **Page Structure:**
+* 1. Frontmatter with title, description, and Open Graph metadata
+* 2. Component imports
+* 3. Page title (H1) and summary
+* 4. Optional deprecation warning and release tag badge
+* 5. Source code link toolbar
+* 6. Function signature block
+* 7. Parameters documentation
+* 8. Returns documentation
+* 9. Examples section with Twoslash-enabled code blocks
+* 10. See Also references
+*
+* **Relationships:**
+* - Created and invoked by {@link ApiExtractorPlugin} during page generation
+* - Uses {@link TypeSignatureFormatter} for formatting type signatures
+* - Uses {@link ApiParser} for extracting documentation from API models
+* - Uses {@link MarkdownCrossLinker} for adding type reference links
+*
+* @see {@link ClassPageGenerator} for class documentation
+* @see {@link TypeAliasPageGenerator} for type alias documentation
+*/
+var FunctionPageGenerator = class {
+	typeFormatter = new TypeSignatureFormatter();
+	/**
+	* Generate a markdown page for a function
+	*
+	* @param apiScope - API scope identifier for VFS lookup
+	*/
+	async generate(apiFunction, baseRoute, packageName, singularName, apiScope, apiName, sourceConfig, suppressExampleErrors, llmsPlugin, availableFrom) {
+		const shouldSuppressErrors = suppressExampleErrors ?? true;
+		const name = apiFunction.displayName;
+		const summary = ApiParser.getSummary(apiFunction) || "No description available.";
+		const releaseTag = ApiParser.getReleaseTag(apiFunction);
+		let content = generateFrontmatter(name, summary, singularName, apiName);
+		content += `import { SourceCode } from "@rspress/core/theme";\n`;
+		content += `import { ParametersTable } from "rspress-plugin-api-extractor/runtime";\n`;
+		content += `import { ApiSignature, ApiExample } from "rspress-plugin-api-extractor/runtime";\n\n`;
+		content += `# ${name}\n\n`;
+		const deprecation = ApiParser.getDeprecation(apiFunction);
+		if (deprecation) {
+			const message = escapeMdxGenerics(markdownCrossLinker.addCrossLinks(deprecation.message));
+			content += `> ⚠️ **Deprecated:** ${message}\n\n`;
+		}
+		if (releaseTag !== "Public") content += `\`${releaseTag}\`\n\n`;
+		content += `${summary}\n\n`;
+		content += generateAvailableFrom(packageName, availableFrom);
+		const sourceLink = ApiParser.getSourceLink(apiFunction, sourceConfig);
+		if (sourceLink) {
+			content += `<div className="api-docs-toolbar">\n`;
+			content += `  <div className="api-docs-toolbar-left">\n`;
+			content += `    <SourceCode href="${sourceLink}" />\n`;
+			content += `  </div>\n`;
+			if (llmsPlugin?.enabled) {
+				content += `  <div className="api-docs-toolbar-right">\n`;
+				content += `  </div>\n`;
+			}
+			content += `</div>\n\n`;
+		}
+		const params = ApiParser.getParams(apiFunction);
+		const hasParameters = params.length > 0;
+		if (apiFunction.excerpt.text) {
+			const signature = this.typeFormatter.format(apiFunction.excerpt).trim();
+			let signatureWithImports = signature;
+			const apiPackage = apiFunction.getAssociatedPackage?.();
+			if (apiPackage) signatureWithImports = prependHiddenImports(signature, new TypeReferenceExtractor(apiPackage, packageName).extractImportsForApiItem(apiFunction));
+			const displayCode = stripTwoslashDirectives(signatureWithImports);
+			content += `<ApiSignature code={${JSON.stringify(displayCode)}} source={${JSON.stringify(signatureWithImports)}} apiScope={${JSON.stringify(apiScope)}} hasParameters={${hasParameters}} />\n\n`;
+		}
+		if (hasParameters) {
+			const parametersData = params.map((param) => ({
+				name: param.name,
+				type: param.type,
+				description: escapeMdxGenerics(markdownCrossLinker.addCrossLinks(param.description))
+			}));
+			content += `<ParametersTable parameters={${JSON.stringify(parametersData)}} />\n\n`;
+		}
+		const returns = ApiParser.getReturns(apiFunction);
+		if (returns) {
+			const description = escapeMdxGenerics(markdownCrossLinker.addCrossLinks(returns.description));
+			content += `## Returns\n\n${description}\n\n`;
+		}
+		const examples = ApiParser.getExamples(apiFunction);
+		if (examples.length > 0) {
+			content += `## Examples\n\n`;
+			for (const example of examples) {
+				const prepared = prepareExampleCode(example, name, packageName, shouldSuppressErrors);
+				const formattedCode = await formatExampleCode(prepared.code, prepared.language, {
+					api: packageName,
+					blockType: "example"
+				});
+				if (prepared.isTypeScript) {
+					const displayCode = stripTwoslashDirectives(formattedCode);
+					content += `<ApiExample code={${JSON.stringify(displayCode)}} source={${JSON.stringify(formattedCode)}} apiScope={${JSON.stringify(apiScope)}} />\n\n`;
+				} else content += `\`\`\`${prepared.language}\n${formattedCode}\n\`\`\`\n\n`;
+			}
+		}
+		const seeReferences = ApiParser.getSeeReferences(apiFunction);
+		if (seeReferences.length > 0) {
+			content += `## See Also\n\n`;
+			for (const reference of seeReferences) {
+				const refText = escapeMdxGenerics(markdownCrossLinker.addCrossLinks(reference.text));
+				content += `- ${refText}\n`;
+			}
+			content += `\n`;
+		}
+		return {
+			routePath: `${baseRoute}/function/${name.toLowerCase()}`,
+			content
+		};
+	}
+};
+
+//#endregion
+export { FunctionPageGenerator };

package/markdown/page-generators/index-pages.js

@@ -0,0 +1,27 @@
+import { escapeYamlString } from "../helpers.js";
+
+//#region src/markdown/page-generators/index-pages.ts
+/**
+* Generator for main API index page with only frontmatter (no content)
+*/
+var MainIndexPageGenerator = class {
+	/**
+	* Generate the main API index page
+	*/
+	generate(packageName, baseRoute, _categoryCounts) {
+		const content = `---
+title: API Reference
+description: Auto-generated API documentation for ${escapeYamlString(packageName)}
+overview: true
+---
+
+`;
+		return {
+			routePath: `${baseRoute}/index`,
+			content
+		};
+	}
+};
+
+//#endregion
+export { MainIndexPageGenerator };