DOCS-103 Metadescription prop in mdx for SEO (#1476)

* test description field * clean up
100mslive · Apr 13, 2023 · 38ec82f · 38ec82f · vercel · Apr 13, 2023
1 parent 562c7fb
commit 38ec82f
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/layouts/DocLayout.tsx b/layouts/DocLayout.tsx
@@ -5,6 +5,7 @@ import Header from '@/components/Header';
 import SegmentAnalytics from '@/components/SegmentAnalytics';
 import Sidebar from '@/components/Sidebar';
 import useLockBodyScroll from '@/lib/useLockBodyScroll';
+import { SEOText } from '@/lib/utils';
 
 interface Props {
     children: JSX.Element;
@@ -16,8 +17,10 @@ export default function DocLayout({ children }: Props) {
     const router = useRouter() as any;
     const SEO = {
         title: `${frontMatter.title || '100ms Docs'} | 100ms`,
+        description: frontMatter?.description || SEOText,
         openGraph: {
-            title: `${frontMatter.title || '100ms Docs'} | 100ms`
+            title: `${frontMatter.title || '100ms Docs'} | 100ms`,
+            description: frontMatter?.description || SEOText
         },
         canonical: `${process.env.NEXT_PUBLIC_CANONICAL_BASE_URL}${
             router.asPath === '/' ? '' : router.asPath.split('?')[0]

diff --git a/lib/utils.js b/lib/utils.js
@@ -76,3 +76,6 @@ export const GitHubLink = 'https://github.com/100mslive';
 export const WebsiteLink = 'https://www.100ms.live';
 
 export const ContactLink = `${WebsiteLink}/contact`;
+
+export const SEOText =
+    'Quick to integrate native iOS, Android & Web SDKs to add live video & audio conferencing to your applications.';
diff --git a/pages/[...slug].tsx b/pages/[...slug].tsx
@@ -236,4 +236,4 @@ export const getStaticPaths = async () => {
     };
 };
 
-DocSlugs.Layout = DocLayout
+DocSlugs.Layout = DocLayout;
-Original file line number
+Diff line change
@@ Expand Up / @@ -236,4 +236,4 @@ export const getStaticPaths = async () => { @@
         };
     };
-    DocSlugs.Layout = DocLayout
+    DocSlugs.Layout = DocLayout;