Merge pull request #149 from manchenkoff/1-docs

[Docs] Nuxt Content project for Github Pages

Author: manchenkoff

.editorconfig

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

.github/workflows/ci.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/docs.yml

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

.github/workflows/prerelease.yml

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

.github/workflows/release.yml

@@ -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/.env.example

@@ -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/.github/workflows/ci.yml

@@ -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/.gitignore

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

docs/.npmrc

@@ -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
+```