Merge pull request #589 from kuzzleio/develop

Release

Author: rolljee

src/.vuepress/components/MajorVersionSelector.vue

@@ -8,7 +8,6 @@
       <div class="selector-selectedItem-name">
         <span class="selector-selectedItem-name-wrapper">
           {{ selectedItem ? selectedItem.text : 'Kuzzle' }}
-          <font-awesome-icon icon="fa-solid fa-caret-down" size="xs" aria-hidden="true"/>
         </span>
       </div>
     </div>

src/.vuepress/components/Redirect.vue

@@ -18,9 +18,6 @@ export default {
       await nextTick();
 
       if (typeof window !== 'undefined') {
-        console.log(props.to);
-        console.log('window.location', window.location);
-
         // Remove leading/trailing slashes and ensure proper joining
         const joinUrl = (base, path) => {
           const cleanBase = base.replace(/\/$/, '');

src/.vuepress/components/SDKSelector.vue

@@ -16,7 +16,6 @@
       <span v-if="currentItem" class="selector-selectedItem-name"
         >{{ currentItem.name }} v{{ currentItem.version }}.x</span
       >
-      <font-awesome-icon icon="fa-solid fa-caret-down" size="xs" aria-hidden="true"/>
     </div>
     <ul
       :class="`selector-list selector-list-${showList ? 'opened' : 'closed'}`"
@@ -27,9 +26,9 @@
         @click="toggleList()"
       >
         <a
-          :class="
-            `selector-list-item-link ${item.subsection === 'api' ? 'api' : ''}`
-          "
+          :class="`selector-list-item-link ${
+            item.subsection === 'api' ? 'api' : ''
+          }`"
           :href="item.path"
         >
           <img
@@ -39,11 +38,9 @@
             :alt="item.name"
           />
           <span
-            :class="
-              `selector-list-item-name${
-                item.subsection === 'api' ? '-api' : ''
-              }`
-            "
+            :class="`selector-list-item-name${
+              item.subsection === 'api' ? '-api' : ''
+            }`"
             >{{ item.name }} v{{ item.version }}.x</span
           >
         </a>
@@ -59,43 +56,45 @@ export default {
   name: 'SDKSelector',
   props: {
     items: { type: Array, required: true },
-    kuzzleMajor: { type: Number, required: true }
+    kuzzleMajor: { type: Number, required: true },
   },
   data() {
     return {
-      showList: false
+      showList: false,
     };
   },
   computed: {
     currentText() {
       return this.currentItem ? this.currentItem.name : 'Select SDK or API';
     },
     filteredItems() {
-      return this.items.filter(item => item !== this.currentItem && item.icon !== undefined);
+      return this.items.filter(
+        (item) => item !== this.currentItem && item.icon !== undefined
+      );
     },
     currentItem() {
-      return this.items.find(i => this.page$.fullPath.startsWith(i.path));
-    }
+      return this.items.find((i) => this.page$.fullPath.startsWith(i.path));
+    },
   },
   methods: {
-    toggleList: function() {
+    toggleList: function () {
       this.showList = !this.showList;
     },
-    onClickOutside: function(e) {
+    onClickOutside: function (e) {
       const el = this.$refs.selector,
         target = e.target;
 
       if (el && el !== target && !el.contains(target)) {
         this.showList = false;
       }
-    }
+    },
   },
   setup() {
     return { page$: usePageData() };
   },
   mounted() {
     document.addEventListener('click', this.onClickOutside);
-  }
+  },
 };
 </script>
 

src/.vuepress/config.ts

@@ -397,12 +397,9 @@ export default defineUserConfig({
       id: JSON.stringify(process.env.GA_ID) || JSON.stringify(googleAnalyticsID),
     }),
     backToTopPlugin(),
+    copyCodePlugin(),
     shikiPlugin({
       langs: ['js', 'ts', 'json', 'vue', 'md', 'sh', 'java', 'xml', 'groovy', 'kotlin', 'yaml', 'dart', 'csharp', 'dockerfile', 'http'],
-      theme: 'catppuccin-macchiato',
-    }),
-    copyCodePlugin({
-      selector: '.md-content div[class*="language-"] pre',
     }),
     markdownContainerPlugin({
       type: 'info',

src/.vuepress/theme/Header.vue

@@ -28,14 +28,11 @@
 
         <!-- Header title -->
         <div data-md-component="title">
-          <span>
-            <MajorVersionSelector :kuzzle-major="kuzzleMajor" />
-          </span>
+          <MajorVersionSelector :kuzzle-major="kuzzleMajor" />
         </div>
 
         <div class="md-header-nav__top-menu-container">
           <div class="screen-only">
-            <div style="display: none">{{ debugInfo }}</div>
             <TopMenu :kuzzle-major="kuzzleMajor" v-if="kuzzleMajor === 2" />
             <TopMenuV1 :kuzzle-major="kuzzleMajor" v-else />
           </div>
@@ -47,7 +44,9 @@
         </div>
 
         <div class="divider"></div>
-        <button class="btnCta"><a href="https://kuzzle.io" target="_blank">Discover Kuzzle</a></button>
+        <button class="btnCta">
+          <a href="https://kuzzle.io" target="_blank">Discover Kuzzle</a>
+        </button>
 
         <!-- Repository containing source -->
         <!-- <div class="md-flex__cell md-flex__cell--shrink">
@@ -79,15 +78,6 @@ export default {
     },
   },
   computed: {
-    debugInfo() {
-      return JSON.stringify(
-        {
-          kuzzleMajor: this.kuzzleMajor,
-        },
-        null,
-        2
-      );
-    },
     searchboxOptions() {
       return {
         searchParameters: {

src/.vuepress/theme/Layout.vue

@@ -55,17 +55,10 @@
             <closed-sources-banner v-if="isClosedSourcesSection" />
             <article class="md-content__inner md-typeset">
               <Content />
-              <hr class="solid">
-              <div class="edit-link" style="color: #4e6e8e;">
-                <a target="_blank" rel="noopener noreferrer" :href="getGithubLink()">Edit this page on Github</a>
-                <span class="sr-only">(opens new window)</span>
-              </div>
             </article>
           </div>
         </div>
       </main>
-
-      <Footer ref="footer" />
     </div>
   </div>
 </template>
@@ -77,21 +70,18 @@ import Header from './Header.vue';
 import DeprecatedBanner from '../components/DeprecatedBanner.vue';
 import Sidebar from './Sidebar.vue';
 import TOC from './TOC.vue';
-import Footer from './Footer.vue';
 import { getCurrentVersion, DEFAULT_VERSION } from '../helpers';
 import MajorVersionDeprecation from '../components/MajorVersionDeprecation.vue';
 import ClosedSourcesBanner from '../components/ClosedSourcesBanner.vue';
-import repositories from '../../../.repos/repositories.json';
 
 export default {
   components: {
     Header,
     Sidebar,
     TOC,
     DeprecatedBanner,
-    Footer,
     MajorVersionDeprecation,
-    ClosedSourcesBanner
+    ClosedSourcesBanner,
   },
   setup() {
     return {
@@ -126,7 +116,7 @@ export default {
     },
     sdkList() {
       return this.page$.sectionList.filter(
-        s =>
+        (s) =>
           s.kuzzleMajor === this.kuzzleMajor &&
           (s.section === 'sdk' || s.subsection === 'api') &&
           s.released
@@ -154,20 +144,6 @@ export default {
     },
   },
   methods: {
-    getGithubLink () {
-      const fullPath = this.page$.fullPath;
-      const base = fullPath.replace(this.page$.regularPath, '');
-      const relativePath = fullPath.replace(base, '');
-      const repository = repositories.find(repo => repo.deploy_path.startsWith(base));
-
-      if (! repository) {
-        return;
-      }
-
-      const link = `${repository.url.replace('.git', '')}/blob/${repository.dev}/doc/${repository.doc_version}/${relativePath}index.md`;
-
-      return link;
-    },
     openSidebar() {
       this.sidebarOpen = true;
     },
@@ -180,8 +156,8 @@ export default {
     },
     setContainerPadding() {
       try {
-        const padding = this.$refs.header.$el.querySelector('header')
-          .offsetHeight;
+        const padding =
+          this.$refs.header.$el.querySelector('header').offsetHeight;
 
         if (padding === null || typeof padding === 'undefined') {
           return;
@@ -213,61 +189,59 @@ export default {
         return;
       }
 
-      const topBoundary = this.$refs.header.$el.querySelector('header')
-        .offsetHeight;
+      const topBoundary =
+        this.$refs.header.$el.querySelector('header').offsetHeight;
 
       if (topBoundary === null || typeof topBoundary === 'undefined') {
         return;
       }
 
       const visible = window.innerHeight - topBoundary;
-      let sidebarHeight = visible - this.$refs.footer.$el.offsetHeight;
+      let sidebarHeight = visible - 0;
 
       if (this.$refs.container.offsetHeight > visible) {
         sidebarHeight = Math.min(
           visible,
           this.$refs.container.offsetHeight -
-            this.$refs.footer.$el.offsetHeight -
+            0 -
             window.pageYOffset -
             topBoundary
         );
       }
 
       this.$refs.sidebar.$el.style = `height: ${sidebarHeight}px`;
       this.$refs.toc.style = `height: ${sidebarHeight}px`;
-    }
+    },
   },
   mounted() {
-    // fix scroll to anchor on chrome https://github.com/vuejs/vuepress/issues/2558
-    if (location.hash && location.hash !== '#') {
-      const anchorLocation = decodeURIComponent(location.hash);
-      const anchorElement = document.querySelector(anchorLocation);
-      if (anchorElement && anchorElement.offsetTop)
-        window.scrollTo(0, anchorElement.offsetTop);
-    }
-
-    window.addEventListener('resize', this.computeContentHeight.bind(this));
-    window.addEventListener('scroll', this.computeSidebarHeight.bind(this));
+    try {
+      window.addEventListener('resize', this.computeContentHeight.bind(this));
+      window.addEventListener('scroll', this.computeSidebarHeight.bind(this));
 
-    this.headerResizeObserver = new ResizeObserver(
-      this.computeContentHeight.bind(this)
-    );
-    this.headerResizeObserver.observe(this.$refs.header.$el.querySelector('header'));
+      this.headerResizeObserver = new ResizeObserver(
+        this.computeContentHeight.bind(this)
+      );
+      this.headerResizeObserver.observe(
+        this.$refs.header.$el.querySelector('header')
+      );
 
-    this.removeRouterListener = this.router$.afterEach(() => {
-      this.$nextTick(() => {
-        this.computeContentHeight();
+      this.removeRouterListener = this.router$.afterEach(() => {
+        this.$nextTick(() => {
+          this.computeContentHeight();
+        });
       });
-    });
 
-    this.computeContentHeight();
+      this.computeContentHeight();
+    } catch (error) {
+      console.error('Error setting up layout:', error);
+    }
   },
   beforeUnmount() {
     window.removeEventListener('resize', this.computeContentHeight.bind(this));
     window.removeEventListener('scroll', this.computeSidebarHeight.bind(this));
 
     this.headerResizeObserver.disconnect();
     this.removeRouterListener?.();
-  }
+  },
 };
 </script>

src/.vuepress/theme/NotFound.vue

@@ -10,25 +10,6 @@
       <main class="md-main">
         <div class="md-main__inner md-grid" data-md-component="container">
           <!-- Main navigation -->
-          <Sidebar
-            ref="sidebar"
-            :kuzzleMajor="kuzzleMajor"
-            :sdkList="[]"
-            :sidebarOpen="sidebarOpen"
-            @closeSidebar="closeSidebar"
-          />
-          <div
-            class="md-sidebar md-sidebar--primary"
-            data-md-component="navigation"
-            ref="sidebar"
-          >
-            <div
-              v-if="!page$.frontmatter.nosidebar"
-              class="md-sidebar__scrollwrap"
-            >
-              <div class="md-sidebar__inner"></div>
-            </div>
-          </div>
 
           <!-- Main container -->
           <div class="md-content">
@@ -55,7 +36,6 @@
           </div>
         </div>
       </main>
-      <Footer ref="footer" />
     </div>
   </div>
 </template>
@@ -66,15 +46,11 @@ import { usePageData } from 'vuepress/client';
 import { getCurrentVersion } from '../helpers';
 import Header from './Header.vue';
 import btnCta from '../components/Cta.vue';
-import Footer from './Footer.vue';
-import Sidebar from './Sidebar.vue';
 
 export default {
   components: {
     Header,
     btnCta,
-    Footer,
-    Sidebar
   },
   data() {
     return {