[Docs] Nuxt Content project for Github Pages

.github/workflows/ci.yml

@@ -1,4 +1,3 @@
----
 name: Nuxt [Validate]
 env:
   node_version: 20

.github/workflows/docs.yml

@@ -0,0 +1,46 @@
+name: Nuxt [Docs]
+env:
+  node_version: 20
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.node_version }}
+      - name: Enable corepack
+        run: corepack enable
+      - name: Install dependencies
+        working-directory: ./docs
+        run: npx nypm@latest i
+      - name: Generate documentation
+        run: pnpm generate
+        working-directory: ./docs
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs/.output/public
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/prerelease.yml

@@ -1,4 +1,3 @@
----
 name: Nuxt [Pre-Release]
 env:
   node_version: 20

.github/workflows/release.yml

@@ -1,4 +1,3 @@
----
 name: Nuxt [Release]
 env:
   node_version: 20

docs/.env.example

@@ -0,0 +1,2 @@
+# Public URL, used for OG Image when running nuxt generate
+NUXT_PUBLIC_SITE_URL=https://manchenkoff.github.com/nuxt-laravel-echo

docs/.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: ci
+
+on: push
+
+jobs:
+  ci:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        node: [22]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+
+      - name: Install node
+        uses: actions/setup-node@v5
+        with:
+          node-version: ${{ matrix.node }}
+          cache: pnpm
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Lint
+        run: pnpm run lint
+
+      - name: Typecheck
+        run: pnpm run typecheck

docs/.gitignore

@@ -0,0 +1,27 @@
+# Nuxt dev/build outputs
+.output
+.data
+.nuxt
+.nitro
+.cache
+dist
+
+# Node dependencies
+node_modules
+
+# Logs
+logs
+*.log
+
+# Misc
+.DS_Store
+.fleet
+.idea
+
+# Local env files
+.env
+.env.*
+!.env.example
+
+# VSC
+.history

docs/.npmrc

@@ -0,0 +1 @@
+shamefully-hoist=true

docs/README.md

@@ -0,0 +1,55 @@
+# Nuxt - Laravel Echo Docs
+
+This directory contains Nuxt Content project to deploy
+module documentation to Github Pages.
+
+## Setup
+
+Make sure to install the dependencies:
+
+```bash
+pnpm install
+```
+
+## Development Server
+
+Start the development server on `http://localhost:3000`:
+
+```bash
+pnpm dev
+```
+
+## Production
+
+Build the application for production:
+
+```bash
+pnpm build
+```
+
+Or generate all pages for static hosting via:
+
+```bash
+pnpm generate
+```
+
+Locally preview production build:
+
+```bash
+pnpm preview
+```
+
+## Validation
+
+To check code quality, run the following command:
+
+```bash
+pnpm validate
+```
+
+or separately:
+
+```bash
+pnpm lint
+pnpm typecheck
+```

docs/app/app.config.ts

@@ -0,0 +1,143 @@
+const siteName = 'Nuxt - Laravel Echo'
+
+export default defineAppConfig({
+  ui: {
+    colors: {
+      primary: 'red',
+      neutral: 'zinc'
+    },
+    footer: {
+      slots: {
+        root: 'border-t border-default',
+        left: 'text-sm text-muted'
+      }
+    }
+  },
+  seo: {
+    siteName: siteName
+  },
+  header: {
+    title: siteName,
+    to: '/',
+    logo: {
+      alt: 'Laravel Echo',
+      light: 'logo.svg',
+      dark: 'logo.svg'
+    },
+    search: true,
+    colorMode: true,
+    links: [
+      {
+        'icon': 'i-simple-icons-github',
+        'to': 'https://github.com/manchenkoff/nuxt-laravel-echo',
+        'target': '_blank',
+        'aria-label': 'GitHub'
+      },
+      {
+        'icon': 'i-simple-icons-nuxt',
+        'to': 'https://nuxt.com/modules/nuxt-laravel-echo',
+        'target': '_blank',
+        'aria-label': 'Nuxt Module'
+      }
+    ]
+  },
+  footer: {
+    credits: `Artem Manchenkov © ${new Date().getFullYear()}`,
+    colorMode: false,
+    links: [
+      {
+        'icon': 'i-simple-icons-github',
+        'to': 'https://github.com/manchenkoff',
+        'target': '_blank',
+        'aria-label': 'manchenkoff on GitHub'
+      },
+      {
+        'icon': 'i-simple-icons-twitter',
+        'to': 'https://twitter.com/amanchenkov',
+        'target': '_blank',
+        'aria-label': 'manchenkoff on X'
+      },
+      {
+        'icon': 'i-simple-icons-facebook',
+        'to': 'https://fb.com/manchenkoff',
+        'target': '_blank',
+        'aria-label': 'manchenkoff on Facebook'
+      },
+      {
+        'icon': 'i-simple-icons-linkedin',
+        'to': 'https://linkedin.com/in/manchenkoff',
+        'target': '_blank',
+        'aria-label': 'manchenkoff on LinkedIn'
+      },
+      {
+        'icon': 'i-simple-icons-instagram',
+        'to': 'https://instagram.com/manchenkof',
+        'target': '_blank',
+        'aria-label': 'manchenkoff on Instagram'
+      },
+      {
+        'icon': 'i-simple-icons-threads',
+        'to': 'https://threads.net/@manchenkof',
+        'target': '_blank',
+        'aria-label': 'manchenkoff on Threads'
+      },
+      {
+        'icon': 'i-simple-icons-youtube',
+        'to': 'https://youtube.com/@manchenkoff',
+        'target': '_blank',
+        'aria-label': 'manchenkoff on YouTube'
+      },
+      {
+        'icon': 'i-simple-icons-medium',
+        'to': 'https://manchenkoff.medium.com/',
+        'target': '_blank',
+        'aria-label': 'manchenkoff on Medium'
+      },
+      {
+        'icon': 'i-simple-icons-telegram',
+        'to': 'https://t.me/manchenkoff',
+        'target': '_blank',
+        'aria-label': 'manchenkoff on Telegram'
+      },
+      {
+        'icon': 'i-simple-icons-bluesky',
+        'to': 'https://bsky.app/profile/manchenkoff.bsky.social',
+        'target': '_blank',
+        'aria-label': 'manchenkoff on Bluesky'
+      }
+    ]
+  },
+  toc: {
+    title: 'Table of Contents',
+    bottom: {
+      title: 'Ready to contribute?',
+      edit: 'https://github.com/nuxt-ui-templates/docs/edit/main/content',
+      links: [
+        {
+          icon: 'i-lucide-star',
+          label: 'Star on GitHub',
+          to: 'https://github.com/manchenkoff/nuxt-laravel-echo',
+          target: '_blank'
+        },
+        {
+          icon: 'i-lucide-git-pull-request-create',
+          label: 'Suggest a feature',
+          to: 'https://github.com/manchenkoff/nuxt-laravel-echo/issues/new?template=feature_request.md',
+          target: '_blank'
+        },
+        {
+          icon: 'i-simple-icons-github',
+          label: 'Support project',
+          to: 'https://github.com/sponsors/manchenkoff?o=esb',
+          target: '_blank'
+        },
+        {
+          icon: 'i-simple-icons-buymeacoffee',
+          label: 'Buy me a coffee',
+          to: 'https://buymeacoffee.com/manchenkoff',
+          target: '_blank'
+        }
+      ]
+    }
+  }
+})

docs/app/app.vue

@@ -0,0 +1,52 @@
+<script setup lang="ts">
+const { seo } = useAppConfig()
+
+const { data: navigation } = await useAsyncData('navigation', () => queryCollectionNavigation('docs'))
+const { data: files } = useLazyAsyncData(
+  'search', () => queryCollectionSearchSections('docs'),
+  { server: false }
+)
+
+useHead({
+  meta: [
+    { name: 'viewport', content: 'width=device-width, initial-scale=1' }
+  ],
+  link: [
+    { rel: 'icon', href: '/logo.svg' }
+  ],
+  htmlAttrs: {
+    lang: 'en'
+  }
+})
+
+useSeoMeta({
+  titleTemplate: `%s - ${seo?.siteName}`,
+  ogSiteName: seo?.siteName,
+  twitterCard: 'summary_large_image'
+})
+
+provide('navigation', navigation)
+</script>
+
+<template>
+  <UApp>
+    <NuxtLoadingIndicator />
+
+    <AppHeader />
+
+    <UMain>
+      <NuxtLayout>
+        <NuxtPage />
+      </NuxtLayout>
+    </UMain>
+
+    <AppFooter />
+
+    <ClientOnly>
+      <LazyUContentSearch
+        :files="files"
+        :navigation="navigation"
+      />
+    </ClientOnly>
+  </UApp>
+</template>