Merge pull request #1 from kioydiolabs/move-to-vitepress

Move documentation to VitePress

.gitignore

@@ -0,0 +1,2 @@
+docs/node_modules
+docs/.vitepress/cache

README.md

@@ -13,6 +13,10 @@ _rock paper scissors_ game for anyone who has a 79XX deskphone and wants to
 experiment with it, or even for businesses who still use them.
 
 ## How to configure CISCAPPS
+
+> [!CAUTION]
+> **This guide is no longer being maintained. For the latest updated CISCAPPS documentation visit [https://ciscapps.kioydiolabs.org](https://ciscapps.kioydiolabs.org).**
+
 Configuring CISCAPPS is really simple. Just use the **Docker Compose** to
 pull the image from **Docker Hub** and deploy a container.
 
@@ -68,4 +72,4 @@ Finally, deploy the container by running this command
 
 ```
 sudo docker-compose up -d
-```
+```

deploy.md

@@ -1,3 +1,7 @@
+> [!CAUTION]
+> **This guide is no longer being maintained. For the latest updated CISCAPPS documentation visit [https://ciscapps.kioydiolabs.org](https://ciscapps.kioydiolabs.org).**
+
+
 ## How to configure CISCAPPS
 Configuring CISCAPPS is really simple. Just use the **Docker Compose** to
 pull the image from **Docker Hub** and deploy a container.

docs/.vitepress/config.mts

@@ -0,0 +1,54 @@
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: "CISCAPPS",
+  description: "OpenSource web apps for Cisco IP deskphones created by KioydioLabs.",
+  head: [
+    ['link', { rel: 'icon', href: '/logo.jpg' }],
+    ['meta', { name: 'theme-color', content: '#007bdf' }]
+  ],
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    search: {
+      provider: 'local'
+    },
+    logo: '/logo.jpg',
+    nav: [
+      { text: 'Home', link: '/' }
+    ],
+    footer: {
+      message: 'Released under the BSD 3-Clause License',
+      copyright: 'KIOYDIOLABS © 2024'
+    },
+    sidebar: [
+      {
+        text: 'Introduction',
+        link: '/introduction',
+      },
+      {
+        text: 'Docker Installation',
+        link: '/docker-installation',
+        collapsed: true,
+        items: [
+          { text: 'Installing requirements', link: '/installing-requirements' },
+          { text: 'Modify the configuration file', link: '/modify-configuration-file' },
+          { text: 'Deploy CISCAPPS', link: '/deploy-ciscapps' }
+        ]
+      },
+      {
+        text: 'Deskphone Configuration',
+        link: '/deskphone-configuration',
+        collapsed: true,
+        items: [
+            { text: 'FreePBX Configuration', link: '/free-pbx-configuration' },
+            { text: 'XML File Configuration (Manual)', link: '/xml-file-manual-configuration' }
+        ]
+      }
+    ],
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/kioydiolabs/ciscapps_suite' }
+    ]
+  }
+})

docs/.vitepress/theme/index.ts

@@ -0,0 +1,17 @@
+// https://vitepress.dev/guide/custom-theme
+import { h } from 'vue'
+import type { Theme } from 'vitepress'
+import DefaultTheme from 'vitepress/theme'
+import './style.css'
+
+export default {
+  extends: DefaultTheme,
+  Layout: () => {
+    return h(DefaultTheme.Layout, null, {
+      // https://vitepress.dev/guide/extending-default-theme#layout-slots
+    })
+  },
+  enhanceApp({ app, router, siteData }) {
+    // ...
+  }
+} satisfies Theme