[DOCS] Factorize top nav bar (#487)

* [DOCS] Factorize top nav bar * Add repository link
theengs · Jan 9, 2024 · 2754689 · 2754689
1 parent 5860102
commit 2754689
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 68 deletions.
diff --git a/.github/workflows/publish_docs.yml b/.github/workflows/publish_docs.yml
@@ -22,6 +22,9 @@ jobs:
           python -m pip install --upgrade pip
           pip install requests pandas markdown pytablereader tabulate
           npm install
+      - name: Download Common Config
+        run: |
+          curl -o docs/.vuepress/public/commonConfig.js https://www.theengs.io/commonConfig.js
       - name: Build documentation
         run: |
           npm run docs:build

diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -1,70 +1,30 @@
+const commonConfig = require('./public/commonConfig');
+
 module.exports = {
-    markdown: {
-      lineNumbers: true
-    },
-    title: 'Theengs Decoder',
-    description: 'One decoder for many devices, decode easily your BLE devices data and transform these into a readable format',
-    head: [
-      ['link', { rel: "apple-touch-icon", sizes: "180x180", href: ".apple-touch-icon.png"}],
-      ['link', { rel: "icon", type: "image/png", sizes: "32x32", href: "/favicon-32x32.png"}],
-      ['link', { rel: "icon", type: "image/png", sizes: "16x16", href: "/favicon-16x16.png"}],
-      ['link', { rel: 'manifest', href: '/manifest.json' }],
-      ['meta', { name: 'theme-color', content: '#3eaf7c' }],
-      ['meta', { name: 'apple-mobile-web-app-capable', content: 'yes' }],
-      ['meta', { name: 'apple-mobile-web-app-status-bar-style', content: 'black' }],
-      ['link', { rel: 'mask-icon', href: '/icons/safari-pinned-tab.svg', color: '#3eaf7c' }],
-      ['meta', { name: 'msapplication-TileImage', content: '/favicon-144x144.png' }],
-      ['meta', { name: 'msapplication-TileColor', content: '#000000' }]
-    ],
-    themeConfig: {
-      smoothScroll: true,
-      repo: 'theengs/decoder',
-      docsDir: 'docs',
-      docsBranch: 'development',
-      lastUpdated: 'Last Updated',
-      editLinks: true,
-      nav: [
-        { text: 'Shop', link: 'https://shop.theengs.io/'},
-        { text: 'Home', link: 'https://www.theengs.io', target:'_self', rel:''},
-        { text: 'Use cases',
-        items: [
-          { text: 'Smart Home', link: 'https://www.theengs.io/usecases/smarthome.html', target:'_self', rel:''},
-          { text: 'Research', link: 'https://www.theengs.io/usecases/research.html', target:'_self', rel:''}
-        ]},
-        { text: 'Compatible', link: 'https://decoder.theengs.io/devices/devices.html', target:'_self', rel:''},
-        { text: 'App', link: 'https://app.theengs.io', target:'_self', rel:''},
-        { text: 'Gateway', link: 'https://gateway.theengs.io', target:'_self', rel:''},
-        { text: 'Decoder', link: 'https://decoder.theengs.io', target:'_self', rel:''},
-        { text: 'Web Parser', link: 'https://parser.theengs.io', target:'_self', rel:''}
-      ],
-      sidebar: [
-        ['/','0 - What is it for 🏠'],
-        {
-          title: '1 - Use ✈️',   // required
-          sidebarDepth: 1,    // optional, defaults to 1
-          children: [
-            'use/include',
-            'use/ESP32',
-            'use/python'
-          ]
-        },
-        {
-          title: '2 - Participate 💻',   // required
-          sidebarDepth: 1,    // optional, defaults to 1
-          children: [
-            'participate/adding-decoders',
-            'participate/support',
-            'participate/development'
-          ]
-        }
-    ]
-    },
-    plugins: [
-      ['@vuepress/pwa', {
-        serviceWorker: true,
-        updatePopup: true
-      }],
-      ['@vuepress/medium-zoom', true],
-      ['@vuepress/nprogress']
-    ]
+  ...commonConfig,
+  themeConfig: {
+    repo: 'theengs/decoder',
+    ...commonConfig.themeConfig,
+    sidebar: [
+      ['/','0 - What is it for 🏠'],
+      {
+        title: '1 - Use ✈️',   // required
+        sidebarDepth: 1,    // optional, defaults to 1
+        children: [
+          'use/include',
+          'use/ESP32',
+          'use/python'
+        ]
+      },
+      {
+        title: '2 - Participate 💻',   // required
+        sidebarDepth: 1,    // optional, defaults to 1
+        children: [
+          'participate/adding-decoders',
+          'participate/support',
+          'participate/development'
+        ]
+      }
+  ]
   }
+}