Merge pull request #24 from shanecaf/main

Documentation Overhaul

.github/workflows/deploy.yml

@@ -1,24 +1,82 @@
-name: Deploy to GitHub Pages
-on: push
+name: Deploy Site to pages
+
+on:
+  # Runs on pushes targeting the default branch
+  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
+
+env:
+  BUILD_PATH: "." # default value when not using subfolders
+  # BUILD_PATH: subfolder
+
 jobs:
-  deploy:
-    name: Deploy to GitHub Pages
+  build:
+    name: Build
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Detect package manager
+        id: detect-package-manager
+        run: |
+          if [ -f "${{ github.workspace }}/yarn.lock" ]; then
+            echo "manager=yarn" >> $GITHUB_OUTPUT
+            echo "command=install" >> $GITHUB_OUTPUT
+            echo "runner=yarn" >> $GITHUB_OUTPUT
+            exit 0
+          elif [ -f "${{ github.workspace }}/package.json" ]; then
+            echo "manager=npm" >> $GITHUB_OUTPUT
+            echo "command=ci" >> $GITHUB_OUTPUT
+            echo "runner=npx --no-install" >> $GITHUB_OUTPUT
+            exit 0
+          else
+            echo "Unable to determine package manager"
+            exit 1
+          fi
+      - name: Setup Node
+        uses: actions/setup-node@v3
         with:
-          node-version: 14.x
-          cache: yarn
-      - name: Build website
-        working-directory: .
+          node-version: "18"
+          cache: ${{ steps.detect-package-manager.outputs.manager }}
+          cache-dependency-path: ${{ env.BUILD_PATH }}/yarn.lock
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v3
+      - name: Install dependencies
+        run: ${{ steps.detect-package-manager.outputs.manager }} ${{ steps.detect-package-manager.outputs.command }}
+        working-directory: ${{ env.BUILD_PATH }}
+      - name: Build
         run: |
-          yarn install --frozen-lockfile
-          yarn build
+          ${{ steps.detect-package-manager.outputs.runner }} build
+        working-directory: ${{ env.BUILD_PATH }}
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: ${{ env.BUILD_PATH }}/build
 
+  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
-        uses: peaceiris/actions-gh-pages@v3
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./build
-          cname: docs.votion.dev
+        id: deployment
+        uses: actions/deploy-pages@v2

.github/workflows/test-deploy.yml

@@ -0,0 +1,51 @@
+name: Test Deployment
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+env:
+  BUILD_PATH: "." # default value when not using subfolders
+  # BUILD_PATH: subfolder
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Detect package manager
+        id: detect-package-manager
+        run: |
+          if [ -f "${{ github.workspace }}/yarn.lock" ]; then
+            echo "manager=yarn" >> $GITHUB_OUTPUT
+            echo "command=install" >> $GITHUB_OUTPUT
+            echo "runner=yarn" >> $GITHUB_OUTPUT
+            exit 0
+          elif [ -f "${{ github.workspace }}/package.json" ]; then
+            echo "manager=npm" >> $GITHUB_OUTPUT
+            echo "command=ci" >> $GITHUB_OUTPUT
+            echo "runner=npx --no-install" >> $GITHUB_OUTPUT
+            exit 0
+          else
+            echo "Unable to determine package manager"
+            exit 1
+          fi
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: "18"
+          cache: ${{ steps.detect-package-manager.outputs.manager }}
+          cache-dependency-path: ${{ env.BUILD_PATH }}/yarn.lock
+      - name: Install dependencies
+        run: ${{ steps.detect-package-manager.outputs.manager }} ${{ steps.detect-package-manager.outputs.command }}
+        working-directory: ${{ env.BUILD_PATH }}
+      - name: Build
+        run: |
+          ${{ steps.detect-package-manager.outputs.runner }} build
+        working-directory: ${{ env.BUILD_PATH }}

README.md

@@ -1,6 +1,6 @@
 # Website
 
-This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
 
 ### Installation
 

blog/authors.yml

@@ -0,0 +1,5 @@
+jamie:
+  name: Jamie
+  title: Lead Developer
+  url: https://github.com/JamieGrimwood
+  image_url: https://avatars.githubusercontent.com/u/59361355

blog/2021-12-22-dashactyl-0.4-eol.md → blog/dashactyl-0.4-eol.mdx

@@ -2,11 +2,9 @@
 slug: dashactyl-0.4-eol
 title: Dashactyl 0.4 EOL
 authors:
-  name: Jamie
-  title: Lead Developer
-  url: https://github.com/JamieGrimwood
-  image_url: https://avatars.githubusercontent.com/u/59361355
+  - jamie
 tags: [Dashactyl, 0.4]
+date: 2021-12-22
 ---
 
 As of 22nd December 2021, Dashactyl 0.4 will be EOL (End Of Life). This is because it is now outdated software and has critical security flaws. It has developed many bypasses over its time and will no longer recieve security updates. Please do not try and ask for support in the discord as it will just be ignored and removed. If you continue to do so, moderators will take action. The Github repository has been set to Public Archive but will continue to stay in the orginisation and is not planned to be deleted.

blog/2022-1-19-music-man-rewrite.md → blog/music-man-rewrite.mdx

@@ -2,11 +2,9 @@
 slug: music-man-rewrite
 title: Music Man Rewrite
 authors:
-  name: Jamie
-  title: Lead Developer
-  url: https://github.com/JamieGrimwood
-  image_url: https://avatars.githubusercontent.com/u/59361355
+	- jamie
 tags: [Music Man]
+date: 2022-1-19
 ---
 
 So I thought I would write a bit of a plan for the Music Man rewrite. It is currently made in discord.js v12 and uses message commands. Since discord upadted their API to slash commands and interactions, that is what it will now be using. It will use discord.js v13 with Sharding. Most of the commands have already been added and you can check on its progress with the bot "jamies testing bot". The bot uses lavalink to be able to stream music as it is very efficient and sounds very good. We plan to have a few music events with the bot aswell like on stages as kareoke nights or just coding and listening to music. If you do have any suggestions for events, ping me in the suggestions channel with it.

components/Badge.tsx

@@ -0,0 +1,16 @@
+import React from 'react';
+import styles from './badge.module.css';
+import clsx from 'clsx';
+
+interface BadgeProps {
+	type: "danger" | "warning" | "info";
+	children: React.ReactNode;
+}
+
+export default function Badge({ type, children }: BadgeProps) {
+	return (
+		<span className={clsx(styles.badge, styles[`badge-${type}`])}>
+			{children}
+		</span>
+	)
+}

components/badge.module.css

@@ -0,0 +1,22 @@
+.badge {
+	font-family: monospace;
+	padding: 2px;
+	border-radius: 5px;
+	border: 1px solid;
+	width: fit-content;
+}
+
+.badge-info {
+	background-color: var(--ifm-color-info-contrast-background);
+	border-color: var(--ifm-color-info-dark);
+}
+
+.badge-danger {
+	background-color: var(--ifm-color-danger-contrast-background);
+	border-color: var(--ifm-color-danger-dark);
+}
+
+.badge-warning {
+	background-color: var(--ifm-color-warning-contrast-background);
+	border-color: var(--ifm-color-warning-dark);
+}