feat: switch to use docs layer theme

zksync-sdk · May 8, 2024 · a29166e · a29166e
1 parent 58a48fa
commit a29166e
Show file tree

Hide file tree

Showing 29 changed files with 40 additions and 584 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/.eslintignore b/.eslintignore
diff --git a/.eslintrc.json b/.eslintrc.json
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -9,5 +9,6 @@
   "files.eol": "\n",
   "[markdown]": {
     "editor.wordWrap": "on"
-  }
+  },
+  "eslint.experimental.useFlatConfig": true
 }
diff --git a/app.config.ts b/app.config.ts
@@ -4,120 +4,30 @@
  * globally available `useAppConfig()`.
  */
 export default defineAppConfig({
-  ui: {
-    // potential config options: https://github.com/nuxt/ui/tree/dev/src/runtime/ui.config
-    variables: {
-      light: {
-        background: '255 252 255',
-        // foreground: '147 68 68',
-      },
-      dark: {
-        background: '17 20 43',
-        // foreground: 'var(--color-gray-200)',
-      },
-      // header: {
-      //   height: '1rem',
-      // },
-    },
-    primary: 'zkPurple',
-    gray: 'zkSlate',
-    footer: {
-      bottom: {
-        left: 'text-sm text-gray-500 dark:text-gray-400',
-        wrapper: 'border-t border-gray-200 dark:border-gray-800',
-      },
-    },
-    content: {
-      prose: {
-        code: {
-          icon: {
-            go: 'vscode-icons:file-type-go',
-          },
-        },
-      },
-    },
-    'navigation-accordion': {
-      button: {
-        label: 'text-sm/6 font-semibold text-left text-pretty',
-      },
-    },
-  },
   seo: {
-    siteName: 'zkSync Docs',
+    siteName: 'ZKsync SDK Docs',
   },
   header: {
     logo: {
       alt: '',
       light: '/logos/zksync_logo_black.svg',
       dark: '/logos/zksync_logo.svg',
     },
-    search: true,
-    colorMode: true,
-    links: [
-      {
-        icon: 'i-simple-icons-github',
-        to: 'https://github.com/matter-labs/zksync-docs',
-        target: '_blank',
-        'aria-label': 'zkSync Docs on GitHub',
-        title: 'zkSync Docs on GitHub',
-      },
-    ],
-  },
-  footer: {
-    credits: 'Made with ❤️ by Matter Labs & Community',
-    colorMode: false,
     links: [
-      {
-        icon: 'i-zksync-matterlabs-logo',
-        to: 'https://matter-labs.io',
-        target: '_blank',
-        'aria-label': 'MatterLabs Website',
-      },
-      {
-        icon: 'i-simple-icons-x',
-        to: 'https://x.com/zksync',
-        target: '_blank',
-        'aria-label': 'zkSync on X',
-      },
       {
         icon: 'i-simple-icons-github',
-        to: 'https://github.com/matter-labs',
-        target: '_blank',
-        'aria-label': 'zkSync on GitHub',
-      },
-      {
-        icon: 'i-simple-icons-discord',
-        to: 'https://join.zksync.dev/',
+        to: 'https://github.com/zksync-sdk/sdk-docs',
         target: '_blank',
-        'aria-label': 'zkSync on Discord',
+        'aria-label': 'ZKsync SDK Docs on GitHub',
+        title: 'ZKsync SDK Docs on GitHub',
       },
     ],
   },
   toc: {
     title: 'Table of Contents',
     bottom: {
       title: 'Community',
-      edit: 'https://github.com/matter-labs/zksync-docs/edit/main/content',
-      links: [
-        // {
-        //   icon: 'i-heroicons-star',
-        //   label: 'Star on GitHub',
-        //   to: 'https://github.com/nuxt/ui',
-        //   target: '_blank',
-        // },
-        // {
-        //   icon: 'i-heroicons-book-open',
-        //   label: 'Nuxt UI Pro docs',
-        //   to: 'https://ui.nuxt.com/pro/guide',
-        //   target: '_blank',
-        // },
-        // {
-        //   icon: 'i-simple-icons-nuxtdotjs',
-        //   label: 'Purchase a license',
-        //   to: 'https://ui.nuxt.com/pro/purchase',
-        //   target: '_blank',
-        // },
-      ],
+      edit: 'https://github.com/zksync-sdk/sdk-docs/edit/staging/content',
     },
   },
 });
diff --git a/app.vue b/app.vue
@@ -1,7 +1,5 @@
 <script setup lang="ts">
 import type { ParsedContent } from '@nuxt/content/dist/runtime/types';
-import FooterComponent from './components/FooterComponent.vue';
-import HeaderComponent from './components/HeaderComponent.vue';
 
 const { seo } = useAppConfig();
 
@@ -54,7 +52,7 @@ provide('navigation', navigation);
   <div>
     <NuxtLoadingIndicator />
 
-    <HeaderComponent />
+    <HeaderComponent :links="[]" />
 
     <UMain>
       <NuxtLayout>

diff --git a/assets/zksync-icons.ts b/assets/zksync-icons.ts
diff --git a/bun.lockb b/bun.lockb
diff --git a/components/FooterComponent.vue b/components/FooterComponent.vue
diff --git a/components/HeaderComponent.vue b/components/HeaderComponent.vue
diff --git a/components/OgImage/OgImageDocs.vue b/components/OgImage/OgImageDocs.vue
diff --git a/components/content/ContentSwitcher.vue b/components/content/ContentSwitcher.vue
diff --git a/components/content/DisplayPartial.vue b/components/content/DisplayPartial.vue
diff --git a/components/content/ExternalLink.vue b/components/content/ExternalLink.vue
diff --git a/content/sdk/11.go/00.getting-started.md b/content/sdk/11.go/00.getting-started.md
@@ -11,7 +11,7 @@ and provides a starting point for those newer to zkSync Era.
 
 In order to install SDK for zkSync Era, run the command below in your terminal.
 
-```console
+```shell
  go get github.com/zksync-sdk/zksync2-go
 ```