From 91dafe999560e479b9b81dbe9a872959d601ae77 Mon Sep 17 00:00:00 2001 From: Jon Harrell <4829245+jharrell@users.noreply.github.com> Date: Tue, 9 Apr 2024 18:42:33 -0600 Subject: [PATCH 1/2] make docusaurus metadata compatible with our existing frontmatter --- docusaurus.config.ts | 1 - src/theme/DocItem/Metadata/index.tsx | 23 +++++++++++++++++++++++ 2 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 src/theme/DocItem/Metadata/index.tsx diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 80ddda4cb2..4ee237305c 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -106,7 +106,6 @@ const config: Config = { } satisfies Preset.Options ], ], - themeConfig: { image: '/docs/social/docs-social.png', navbar: { diff --git a/src/theme/DocItem/Metadata/index.tsx b/src/theme/DocItem/Metadata/index.tsx new file mode 100644 index 0000000000..3e4131cfc4 --- /dev/null +++ b/src/theme/DocItem/Metadata/index.tsx @@ -0,0 +1,23 @@ +import React from 'react'; +import { PageMetadata } from '@docusaurus/theme-common'; +import { useDoc } from '@docusaurus/theme-common/internal'; + +import type { DocFrontMatter } from '@docusaurus/plugin-content-docs' + +type PrismaDocFrontMatter = DocFrontMatter & { + metaTitle: string, + metaDescription: string, +} + +export default function DocItemMetadata(): JSX.Element { + const { metadata, frontMatter, assets } = useDoc(); + const prismaFrontMatter = frontMatter as PrismaDocFrontMatter; + return ( + + ); +} From 0ba61e07ed509c851bde9c2654d379bccc884be8 Mon Sep 17 00:00:00 2001 From: Jon Harrell <4829245+jharrell@users.noreply.github.com> Date: Tue, 9 Apr 2024 18:46:36 -0600 Subject: [PATCH 2/2] make frontmatter fields optional --- src/theme/DocItem/Metadata/index.tsx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/theme/DocItem/Metadata/index.tsx b/src/theme/DocItem/Metadata/index.tsx index 3e4131cfc4..87de0f465f 100644 --- a/src/theme/DocItem/Metadata/index.tsx +++ b/src/theme/DocItem/Metadata/index.tsx @@ -5,8 +5,8 @@ import { useDoc } from '@docusaurus/theme-common/internal'; import type { DocFrontMatter } from '@docusaurus/plugin-content-docs' type PrismaDocFrontMatter = DocFrontMatter & { - metaTitle: string, - metaDescription: string, + metaTitle?: string, + metaDescription?: string, } export default function DocItemMetadata(): JSX.Element {