diff --git a/apps/website/src/components/SidebarLayout.tsx b/apps/website/src/components/SidebarLayout.tsx index b913c5ebc..feda2798c 100644 --- a/apps/website/src/components/SidebarLayout.tsx +++ b/apps/website/src/components/SidebarLayout.tsx @@ -31,6 +31,7 @@ export interface SidebarLayoutProps { asPath: string; branchName: string; data: { + description: string; member?: ReturnType; members: ReturnType; source: MDXRemoteSerializeResult; diff --git a/apps/website/src/pages/_document.tsx b/apps/website/src/pages/_document.tsx index f03dc1129..0ce3f5e4c 100644 --- a/apps/website/src/pages/_document.tsx +++ b/apps/website/src/pages/_document.tsx @@ -18,7 +18,7 @@ export default function Document() { - + diff --git a/apps/website/src/pages/docs/[...slug].tsx b/apps/website/src/pages/docs/[...slug].tsx index b50200ed6..c36da8aa3 100644 --- a/apps/website/src/pages/docs/[...slug].tsx +++ b/apps/website/src/pages/docs/[...slug].tsx @@ -40,8 +40,9 @@ import { TypeAlias } from '~/components/model/TypeAlias'; import { Variable } from '~/components/model/Variable'; import { CmdKProvider } from '~/contexts/cmdK'; import { MemberProvider } from '~/contexts/member'; -import { PACKAGES } from '~/util/constants'; +import { DESCRIPTION, PACKAGES } from '~/util/constants'; import { findMember, findMemberByKey } from '~/util/model.server'; +import { tryResolveDescription } from '~/util/summary'; export const getStaticPaths: GetStaticPaths = async () => { const pkgs = ( @@ -197,6 +198,7 @@ export const getStaticProps: GetStaticProps = async ({ params }) => { : []; const member = memberName && containerKey ? findMemberByKey(model, packageName, containerKey, branchName) ?? null : null; + const description = member ? tryResolveDescription(member) ?? DESCRIPTION : DESCRIPTION; return { props: { @@ -205,6 +207,7 @@ export const getStaticProps: GetStaticProps = async ({ params }) => { data: { members, member, + description, source: mdxSource, }, }, @@ -318,7 +321,9 @@ export default function SlugPage(props: SidebarLayoutProps & { error?: string }) <> {name} + + {member(props.data.member)} diff --git a/apps/website/src/util/summary.ts b/apps/website/src/util/summary.ts index 46852655f..b715caa88 100644 --- a/apps/website/src/util/summary.ts +++ b/apps/website/src/util/summary.ts @@ -10,7 +10,7 @@ export function tryResolveDescription(member: ApiItemJSON) { const { summary } = member!; if (!summary) { - return undefined; + return null; } let retVal = '';