Merge pull request #23 from SkwalExe/docs

Add base for VitePress documentation

Author: SkwalExe

.github/workflows/docs_deploy.yml

@@ -0,0 +1,68 @@
+name: Deploy VitePress site to Pages
+
+on:
+  push:
+    branches: [main]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+defaults:
+      run:
+        working-directory: docs/
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Not needed if lastUpdated is not enabled
+      - uses: pnpm/action-setup@v3 # Uncomment this if you're using pnpm
+        with:
+          version: 9
+          run_install: |
+            - cwd: "docs/"
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: pnpm
+          cache-dependency-path: docs/package.json
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Install dependencies
+        run: pnpm install
+      - name: Build with VitePress
+        run: pnpm run build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1,2 +1,3 @@
+cache/
 node_modules/
 dist/

docs/.vitepress/config.mts

@@ -0,0 +1,43 @@
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+    title: 'WinMB.js',
+    description:
+        'Non-serious library allowing you to effortlessly bring windows dialogue boxes to your webpages!',
+    srcDir: 'src',
+    themeConfig: {
+        // https://vitepress.dev/reference/default-theme-config
+        nav: [
+            { text: 'Home', link: '/' },
+            { text: 'Getting Started', link: '/getting-started' }
+        ],
+        outline: 'deep',
+        footer: {
+            message: 'Released under the GNU General Public License (GPLv3).',
+            copyright: 'Copyright © 2021-present Léopold Koprivnik'
+        },
+        search: {
+            provider: 'local'
+        },
+        editLink: {
+            pattern: 'https://github.com/skwalexe/WinMB.js/edit/main/docs/src/:path'
+        },
+        sidebar: [
+            {
+                text: 'Introduction',
+                items: [{ text: '📥 Getting Started', link: '/getting-started' }]
+            }
+        ],
+
+        socialLinks: [{ icon: 'github', link: 'https://github.com/skwalexe/WinMB.js' }]
+    },
+    head: [
+        [
+            'script',
+            {
+                src: 'https://cdn.jsdelivr.net/npm/@skwalexe/[email protected]/dist/winmb.umd.js'
+            }
+        ]
+    ]
+})

docs/package.json

@@ -0,0 +1,10 @@
+{
+    "devDependencies": {
+        "vitepress": "^1.3.1"
+    },
+    "scripts": {
+        "dev": "vitepress dev",
+        "build": "vitepress build",
+        "preview": "vitepress preview"
+    }
+}