feat(docs): add canonical links (#2221)

kadena-community · May 31, 2024 · 55f5654 · 55f5654
1 parent 96f0c3a
commit 55f5654
Show file tree

Hide file tree

Showing 26 changed files with 3,308 additions and 131 deletions.
diff --git a/.changeset/proud-rocks-smash.md b/.changeset/proud-rocks-smash.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/packages/apps/docs/src/components/Layout/__fixtures__/frontmatter.ts b/packages/apps/docs/src/components/Layout/__fixtures__/frontmatter.ts
@@ -24,6 +24,8 @@ export const blogFrontMatter: IPageMeta = {
   publishDate: '2018-02-07T00:00:00.000Z',
   layout: 'full',
   order: 6,
+  canonicalURL:
+    'https://docs.kadena.io/blogchain/2018/the-evm-is-fundamentally-unsafe-2018-02-07',
 };
 
 export const fullLayoutFrontMatter: IPageMeta = {
@@ -47,6 +49,7 @@ export const fullLayoutFrontMatter: IPageMeta = {
   label: 'Overview',
   order: 1,
   layout: 'full',
+  canonicalURL: 'https://docs.kadena.io/kadena/overview',
 };
 
 export const landingFrontMatter: IBasePageMeta = {
@@ -78,4 +81,5 @@ export const redoclyFrontMatter: IPageMeta = {
       title: 'What is KDA?',
     },
   },
+  canonicalURL: 'https://docs.kadena.io/kadena/overview',
 };
diff --git a/packages/apps/docs/src/pages/_app.tsx b/packages/apps/docs/src/pages/_app.tsx
@@ -56,7 +56,7 @@ export const MyApp = ({
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [router.isReady]);
 
-  const { title, description, headerImage } = props.frontmatter;
+  const { title, description, headerImage, canonicalURL } = props.frontmatter;
   const defaultImagePath = '/assets/og_banner.jpeg';
   const ogImage = headerImage
     ? `https://${process.env.NEXT_PUBLIC_VERCEL_URL}${headerImage}`
@@ -66,6 +66,7 @@ export const MyApp = ({
     <>
       <Head>
         <title>{`${title} | Kadena Docs`}</title>
+        {canonicalURL && <link rel="canonical" href={canonicalURL} />}
         <link rel="manifest" href="/manifest.json" />
         <meta name="title" content={`${title} | Kadena Docs`} />
         <meta name="description" content={description} />

diff --git a/packages/tools/docs-tools/src/mock/config.mock.yaml b/packages/tools/docs-tools/src/mock/config.mock.yaml
@@ -47,6 +47,7 @@ pages:
       build:
         url: /build
         file: /index.tsx
+        repo: https://github.com/kadena-community/kadena.js
       build2:
         url: /build2
         file: /test.md

diff --git a/packages/tools/docs-tools/src/mock/getData.mock.ts b/packages/tools/docs-tools/src/mock/getData.mock.ts
@@ -0,0 +1,13 @@
+import { readFile } from 'fs/promises';
+import { join } from 'path';
+import type { IMenuData } from './../types';
+
+const getData = async (): Promise<IMenuData[]> => {
+  const configFilePath = join(process.cwd(), 'src/mock/menu.mock.json');
+  const result = await readFile(configFilePath, 'utf-8');
+
+  const data = JSON.parse(result);
+  return data as IMenuData[];
+};
+
+export { getData };
diff --git a/packages/tools/docs-tools/src/mock/loadConfigPages.mock.ts b/packages/tools/docs-tools/src/mock/loadConfigPages.mock.ts
@@ -4,7 +4,7 @@ import type { IConfig, IConfigTreeItem } from 'src/types';
 
 export const loadConfigPages = (): IConfigTreeItem[] => {
   const data = fs.readFileSync(
-    `${process.cwd()}/src/scripts/fixLocalLinks/utils/__tests__/config.mock.yaml`,
+    `${process.cwd()}/src/mock/config.mock.yaml`,
     'utf-8',
   );
   const { pages } = yaml.load(data) as IConfig;