refactor: reorganize docs (#82)

* ci: deploy REACT-VFX docs to react-vfx-docs * refactor: rename docs to docs-react-vfx * ci: replace deploy key * refactor: rename docs-vfx-js to docs * docs: deploy VFX-JS docs to GitHub Pages of this repository * chore: remove unused * chore: rename * chore: update package-lock.json
fand · Jul 9, 2024 · 5471c2a · 5471c2a
1 parent 675e859
commit 5471c2a
Show file tree

Hide file tree

Showing 92 changed files with 733 additions and 712 deletions.
diff --git a/.github/workflows/deploy-react-vfx.yml b/.github/workflows/deploy-react-vfx.yml
@@ -0,0 +1,37 @@
+name: Deploy to amagi.dev/react-vfx-docs
+
+on:
+    push:
+        branches:
+            - main
+    workflow_dispatch:
+
+jobs:
+    deploy:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+
+            - name: Setup Node
+              uses: actions/setup-node@v3
+              with:
+                  node-version: "20"
+                  cache: "npm"
+                  cache-dependency-path: "**/package-lock.json"
+
+            - name: Install dependencies
+              run: npm ci
+
+            - name: Build
+              run: npm run build
+
+            - name: Pushes to another repository
+              uses: cpina/github-action-push-to-another-repository@main
+              env:
+                  SSH_DEPLOY_KEY: ${{ secrets.REACT_VFX_DEPLOY_KEY }}
+              with:
+                  source-directory: "packages/docs-react-vfx/dist"
+                  destination-github-username: "fand"
+                  destination-repository-name: "react-vfx-docs"
+                  user-email: [email protected]
+                  target-branch: main
diff --git a/.github/workflows/deploy-vfx-js.yml b/.github/workflows/deploy-vfx-js.yml
@@ -27,17 +27,12 @@ jobs:
 
             - name: Sync TypeDoc
               run: |
-                  cd packages/docs-vfx-js
+                  cd packages/docs
                   rm -rf dist/docs
                   mv docs dist/docs
 
-            - name: Pushes to another repository
-              uses: cpina/github-action-push-to-another-repository@main
-              env:
-                  SSH_DEPLOY_KEY: ${{ secrets.VFX_JS_DEPLOY_KEY }}
+            - name: Deploy
+              uses: peaceiris/actions-gh-pages@v3
               with:
-                  source-directory: "packages/docs-vfx-js/dist"
-                  destination-github-username: "fand"
-                  destination-repository-name: "vfx-js"
-                  user-email: [email protected]
-                  target-branch: main
+                  github_token: ${{ secrets.GITHUB_TOKEN }}
+                  publish_dir: ./packages/docs/dist
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/docs-vfx-js/.gitignore → packages/docs-react-vfx/.gitignore b/packages/docs-vfx-js/.gitignore → packages/docs-react-vfx/.gitignore
@@ -11,6 +11,3 @@ dist
 .vscode/*
 !.vscode/extensions.json
 .DS_Store
-
-# Typedoc outputs
-docs/*
diff --git a/packages/docs-react-vfx/index.html b/packages/docs-react-vfx/index.html
@@ -0,0 +1,78 @@
+<!doctype html>
+<html lang="en">
+    <head>
+        <meta charset="utf-8" />
+        <meta name="viewport" content="width=device-width, initial-scale=1" />
+
+        <title>REACT-VFX - WebGL effects for React! #REACTVFX</title>
+
+        <meta name="theme-color" content="#000000" />
+        <meta
+            name="description"
+            content="REACT-VFX is a React component library which allows you to add WebGL powered effects to you React aaplication."
+        />
+        <link rel="apple-touch-icon" href="logo-with-bg.png" />
+
+        <meta property="og:url" content="https://amagi.dev/react-vfx/" />
+        <meta property="og:type" content="website" />
+        <meta
+            property="og:title"
+            content="REACT-VFX - WebGL effects for React! #REACTVFX"
+        />
+        <meta property="og:image" content="logo-with-bg.png" />
+        <meta
+            property="og:description"
+            content="REACT-VFX is a React component library which allows you to add WebGL powered effects to you React aaplication."
+        />
+        <meta
+            property="og:site_name"
+            content="REACT-VFX - WebGL effects for React! #REACTVFX"
+        />
+        <meta property="og:locale" content="en_US" />
+
+        <meta name="twitter:card" content="summary_large_image" />
+        <meta name="twitter:site" content="@amagitakayosi" />
+        <meta name="twitter:creator" content="@amagitakayosi" />
+        <meta name="twitter:url" content="https://amagi.dev/react-vfx/" />
+        <meta
+            name="twitter:title"
+            content="REACT-VFX - WebGL effects for React! #REACTVFX"
+        />
+        <meta
+            name="twitter:description"
+            content="REACT-VFX is a React component library which allows you to add WebGL powered effects to you React aaplication."
+        />
+        <meta
+            name="twitter:image"
+            content="https://amagi.dev/react-vfx/logo-with-bg.png"
+        />
+
+        <link rel="icon" href="favicon/favicon.ico" />
+        <link
+            rel="icon"
+            type="image/x-icon"
+            sizes="16x16 32x32"
+            href="favicon/favicon-36.png"
+        />
+        <link
+            rel="apple-touch-icon"
+            sizes="180x180"
+            href="favicion/favicon-180.png"
+        />
+        <link rel="icon" sizes="192x192" href="favicon/favicon-192.png" />
+    </head>
+
+    <body>
+        <noscript>You need to enable JavaScript to run this app.</noscript>
+        <div id="root"></div>
+        <script type="module" src="/src/main.tsx"></script>
+
+        <!-- Cloudflare Web Analytics -->
+        <script
+            defer
+            src="https://static.cloudflareinsights.com/beacon.min.js"
+            data-cf-beacon='{"token": "b9c39aae9c304f1cbfa1e7bb3e84f078"}'
+        ></script>
+        <!-- End Cloudflare Web Analytics -->
+    </body>
+</html>