docs: improve references loading (#13761)
* docs: improve references loading * remove comment * try remove generate metadata * improvements and fixes
This commit is contained in:
@@ -1,21 +1,10 @@
|
||||
import { MDXRemote, MDXRemoteSerializeResult } from "next-mdx-remote/rsc"
|
||||
import { serialize } from "next-mdx-remote/serialize"
|
||||
import path from "path"
|
||||
import { promises as fs } from "fs"
|
||||
import { notFound } from "next/navigation"
|
||||
import {
|
||||
typeListLinkFixerPlugin,
|
||||
localLinksRehypePlugin,
|
||||
workflowDiagramLinkFixerPlugin,
|
||||
prerequisitesLinkFixerPlugin,
|
||||
recmaInjectMdxDataPlugin,
|
||||
} from "remark-rehype-plugins"
|
||||
import MDXComponents from "@/components/MDXComponents"
|
||||
import mdxOptions from "../../../mdx-options.mjs"
|
||||
import { filesMap } from "../../../generated/files-map.mjs"
|
||||
import { Metadata } from "next"
|
||||
import { cache, Suspense } from "react"
|
||||
import { Loading } from "docs-ui"
|
||||
import path from "path"
|
||||
import fs from "fs/promises"
|
||||
import { ReferenceMDX } from "../../../components/ReferenceMDX"
|
||||
import { Metadata } from "next"
|
||||
import { getFrontMatterFromString } from "docs-utils"
|
||||
|
||||
type PageProps = {
|
||||
params: Promise<{
|
||||
@@ -27,60 +16,10 @@ export default async function ReferencesPage(props: PageProps) {
|
||||
const params = await props.params
|
||||
const { slug } = params
|
||||
|
||||
const fileData = await loadFile(slug)
|
||||
|
||||
if (!fileData) {
|
||||
return notFound()
|
||||
}
|
||||
|
||||
const pluginOptions = {
|
||||
filePath: fileData.path,
|
||||
basePath: process.cwd(),
|
||||
}
|
||||
|
||||
return (
|
||||
<Suspense fallback={<Loading />}>
|
||||
<div className="animate animate-fadeIn">
|
||||
<MDXRemote
|
||||
source={fileData.content}
|
||||
components={MDXComponents}
|
||||
options={{
|
||||
mdxOptions: {
|
||||
rehypePlugins: [
|
||||
...mdxOptions.options.rehypePlugins,
|
||||
[
|
||||
typeListLinkFixerPlugin,
|
||||
{
|
||||
...pluginOptions,
|
||||
checkLinksType: "md",
|
||||
},
|
||||
],
|
||||
[
|
||||
workflowDiagramLinkFixerPlugin,
|
||||
{
|
||||
...pluginOptions,
|
||||
checkLinksType: "value",
|
||||
},
|
||||
],
|
||||
[
|
||||
prerequisitesLinkFixerPlugin,
|
||||
{
|
||||
...pluginOptions,
|
||||
checkLinksType: "value",
|
||||
},
|
||||
],
|
||||
[localLinksRehypePlugin, pluginOptions],
|
||||
],
|
||||
remarkPlugins: [...mdxOptions.options.remarkPlugins],
|
||||
recmaPlugins: [
|
||||
[
|
||||
recmaInjectMdxDataPlugin,
|
||||
{ isRemoteMdx: true, mode: process.env.NODE_ENV },
|
||||
],
|
||||
],
|
||||
},
|
||||
}}
|
||||
/>
|
||||
<ReferenceMDX slug={slug} />
|
||||
</div>
|
||||
</Suspense>
|
||||
)
|
||||
@@ -89,11 +28,10 @@ export default async function ReferencesPage(props: PageProps) {
|
||||
export async function generateMetadata({
|
||||
params,
|
||||
}: PageProps): Promise<Metadata> {
|
||||
// read route params
|
||||
const slug = (await params).slug
|
||||
const metadata: Metadata = {}
|
||||
|
||||
const fileData = await loadFile(slug)
|
||||
const fileData = await loadReferencesFile(slug)
|
||||
|
||||
if (!fileData) {
|
||||
return metadata
|
||||
@@ -106,28 +44,26 @@ export async function generateMetadata({
|
||||
}
|
||||
|
||||
metadata.title = pageTitleMatch.groups.title
|
||||
metadata.keywords = (fileData.source.frontmatter?.keywords || []) as string[]
|
||||
const frontmatter = await getFrontMatterFromString(fileData.content)
|
||||
metadata.keywords = (frontmatter.keywords || []) as string[]
|
||||
|
||||
return metadata
|
||||
}
|
||||
|
||||
const loadFile = cache(
|
||||
async (
|
||||
slug: string[]
|
||||
): Promise<
|
||||
| {
|
||||
content: string
|
||||
source: MDXRemoteSerializeResult
|
||||
path: string
|
||||
}
|
||||
| undefined
|
||||
> => {
|
||||
export type LoadedReferenceFile = {
|
||||
content: string
|
||||
path: string
|
||||
}
|
||||
|
||||
const loadReferencesFile = cache(
|
||||
async (slug: string[]): Promise<LoadedReferenceFile | undefined> => {
|
||||
path.join(process.cwd(), "references")
|
||||
const monoRepoPath = path.resolve("..", "..", "..")
|
||||
|
||||
const pathname = `/references/${slug.join("/")}`
|
||||
const slugChanges = (await import("../../../generated/slug-changes.mjs"))
|
||||
const slugChanges = (await import("@/generated/slug-changes.mjs"))
|
||||
.slugChanges
|
||||
const filesMap = (await import("@/generated/files-map.mjs")).filesMap
|
||||
const fileDetails =
|
||||
slugChanges.find((f) => f.newSlug === pathname) ||
|
||||
filesMap.find((f) => f.pathname === pathname)
|
||||
@@ -137,12 +73,9 @@ const loadFile = cache(
|
||||
const fullPath = path.join(monoRepoPath, fileDetails.filePath)
|
||||
|
||||
const fileContent = await fs.readFile(fullPath, "utf-8")
|
||||
const serialized = await serialize(fileContent, {
|
||||
parseFrontmatter: true,
|
||||
})
|
||||
|
||||
return {
|
||||
content: fileContent,
|
||||
source: serialized,
|
||||
path: fullPath,
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user