Working on destucking docs building

Author: rislaed

api/docusaurus-plugin/src/components/ApiPage.tsx

@@ -60,14 +60,24 @@ function mapPackagesToReflection(packages: PackageReflectionGroup[]): TSDDeclara
 	return map;
 }
 
+let cachedMap: TSDDeclarationReflectionMap | null = null;
+let cachedPackages: PackageReflectionGroup[] | null = null;
+
 export interface ApiPageProps extends DocRootProps {
 	options: ApiOptions;
 	packages: PackageReflectionGroup[];
 }
 
 function ApiPage({ options, packages, ...props }: ApiPageProps) {
 	const value = useMemo(
-		() => ({ options, reflections: mapPackagesToReflection(packages) }),
+		() => {
+			if (cachedMap && cachedPackages === packages) {
+				return { options, reflections: cachedMap };
+			}
+			cachedPackages = packages;
+			cachedMap = mapPackagesToReflection(packages);
+			return { options, reflections: cachedMap };
+		},
 		[options, packages],
 	);
 

api/docusaurus-plugin/src/components/SourceLink.tsx

@@ -7,6 +7,10 @@ function replaceWithSrc(url: string): string {
 	return url.replace(/\/(dts|dist|lib|build|es|esm|cjs|mjs)\//, '/src/');
 }
 
+function isExternalSource(fileName: string): boolean {
+	return fileName.includes('node_modules') || fileName.includes('declarations') || fileName.includes('android.d.ts');
+}
+
 export interface SourceLinkProps {
 	sources?: JSONOutput.SourceReference[];
 }
@@ -19,26 +23,31 @@ export function SourceLink({ sources = [] }: SourceLinkProps) {
 		return null;
 	}
 
+	const githubHost = (siteConfig.customFields?.githubHost as string) ?? 'github.com';
+	const githubRepository = `https://${githubHost}/${siteConfig.organizationName}/${siteConfig.projectName}`;
+
 	return (
 		<>
-			{sources.slice(0, 3).map((source) => (
-				<a
-					key={source.fileName}
-					className="tsd-anchor"
-					href={
-						source.url ||
-						`https://${siteConfig.githubHost}${
-							siteConfig.githubPort ? `:${siteConfig.githubPort}` : ''
-						}/${siteConfig.organizationName}/${
-							siteConfig.projectName
-						}/blob/${gitRefName}/${replaceWithSrc(source.fileName)}#L${source.line}`
-					}
-					rel="noreferrer"
-					target="_blank"
-				>
-					<i className="codicon codicon-file-code" />
-				</a>
-			))}
+			{sources.slice(0, 3).map((source) => {
+				if (isExternalSource(source.fileName)) {
+					return null;
+				}
+
+				return (
+					<a
+						key={source.fileName}
+						className="tsd-anchor"
+						href={
+							source.url ||
+							`${githubRepository}/blob/${gitRefName}/${replaceWithSrc(source.fileName)}#L${source.line}`
+						}
+						rel="noreferrer"
+						target="_blank"
+					>
+						<i className="codicon codicon-file-code" />
+					</a>
+				);
+			})}
 		</>
 	);
 }

api/docusaurus-plugin/src/index.ts

@@ -274,6 +274,21 @@ export default function typedocApiPlugin(
 				return;
 			}
 
+			actions.setGlobalData({
+				path: normalizeUrl([context.baseUrl, options.routeBasePath ?? 'api']),
+				versions: content.loadedVersions.map((loadedVersion) => ({
+					name: loadedVersion.versionName,
+					label: loadedVersion.versionLabel,
+					isLast: loadedVersion.isLast,
+					path: loadedVersion.versionPath,
+					mainDocId: '',
+					docs: [],
+					draftIds: [],
+					sidebars: {},
+				})),
+				breadcrumbs: options.breadcrumbs,
+			});
+
 			const docs: PropVersionDocs = {};
 
 			// Create an index of versions for quick lookups.

docusaurus.config.ts

@@ -30,15 +30,17 @@ import { readdirSync } from 'fs';
 import path from 'path';
 
 const baseUrl = process.env.BASE_URL ?? '/';
+const isCI = true; // process.env.npm_command === 'ci';
 const configUrl = 'https://nernar.github.io';
 
 export default {
 	title: 'Inner Core Docs',
 	tagline: 'Inner Core, Core Engine and Horizon documentation',
 	url: configUrl,
 	baseUrl,
-	onBrokenLinks: 'warn',
-	onBrokenMarkdownLinks: 'warn',
+	onBrokenLinks: isCI ? 'ignore' : 'warn',
+	onBrokenMarkdownLinks: isCI ? 'ignore' : 'warn',
+	onBrokenAnchors: isCI ? 'ignore' : 'warn',
 	favicon: 'favicon/favicon.ico',
 
 	markdown: {

src/plugins/remark-authors.ts

@@ -1,7 +1,7 @@
 import type { Transformer } from 'unified';
-import type { Root, Text } from 'mdast';
+import type { Root, Text, Parent } from 'mdast';
 
-async function processAuthors(text: Text) {
+async function processAuthors(text: Text, index: number, parent: Parent) {
 	let children = [];
 	let lastIndex = 0;
 	let match;
@@ -10,7 +10,7 @@ async function processAuthors(text: Text) {
 	while ((match = authorRegex.exec(text.value)) !== null) {
 		if (match.index > lastIndex) {
 			children.push({
-				type: text.type,
+				type: 'text',
 				value: text.value.slice(lastIndex, match.index)
 			});
 		}
@@ -21,7 +21,7 @@ async function processAuthors(text: Text) {
 
 		if (authors.length > 0) {
 			children.push({
-				type: 'mdxJsxFlowElement',
+				type: 'mdxJsxTextElement',
 				name: 'GithubAuthors',
 				attributes: [
 					{
@@ -39,18 +39,17 @@ async function processAuthors(text: Text) {
 	if (lastIndex > 0) {
 		if (lastIndex < text.value.length) {
 			children.push({
-				type: text.type,
+				type: 'text',
 				value: text.value.slice(lastIndex)
 			});
 		}
 
 		if (children.length > 0) {
-			const node: Root = text as unknown as Root;
-			node.type = 'root';
-			node.children = children;
+			parent.children.splice(index, 1, ...children);
 		}
 	}
 }
+
 export default function plugin(): Transformer<Root> {
 	return async (tree) => {
 		const promises = [];
@@ -59,7 +58,7 @@ export default function plugin(): Transformer<Root> {
 			if (!parent || index === undefined) {
 				return;
 			}
-			promises.push(processAuthors(node));
+			promises.push(processAuthors(node as Text, index, parent as Parent));
 		});
 		await Promise.all(promises);
 	};