docs: Add docusaurus site

Author: FoxxMD

.devcontainer/devcontainer.json

@@ -18,7 +18,8 @@
 				"hbenl.vscode-mocha-test-adapter",
 				"dbaeumer.vscode-eslint",
 				"tamasfe.even-better-toml",
-				"TakumiI.markdowntable"
+				"TakumiI.markdowntable",
+				"unifiedjs.vscode-mdx"
 			]
 		}
 	}

.dockerignore

@@ -17,10 +17,7 @@ config/*.p8
 .flatpak-builder
 **/generated-sources.*
 flatpak/.flatpak-builder
-docsite/build
-docsite/node_modules
-docsite/.docusaurus
-docsite/.cache-loader
+docsite
 build
 *.secrets
 .devcontainer

.github/workflows/docsDeploy.yml

@@ -0,0 +1,51 @@
+name: Deploy to GitHub Pages
+
+on:
+  workflow_dispatch:
+  release:
+    types: [released]
+    # Review gh actions docs if you want to further define triggers, paths, etc
+    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
+
+jobs:
+  deploy:
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+
+      - name: Install app dev dependencies
+        run: npm ci
+
+      - name: Install docusaurus dependencies
+        run: npm ci
+        working-directory: ./docsite
+      - name: Build website
+        env:
+          RY_ANALYTICS: ${{ vars.RY_ANALYTICS }}
+          RY_ANALYTICS_SITEID: ${{ vars.RY_ANALYTICS_SITEID }}
+          RY_ANALYTICS_REPLAY: ${{ vars.RY_ANALYTICS_REPLAY }}
+          GSITEVERIFICATION: ${{ vars.GSITEVERIFICATION }}
+          DOCS_BASE: '/komodo-import'
+        run: npm run build
+        working-directory: ./docsite
+
+      # Popular action to deploy to GitHub Pages:
+      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          # Build output to publish to the `gh-pages` branch:
+          publish_dir: ./docsite/build
+          # The following lines assign commit authorship to the official
+          # GH-Actions bot for deploys to `gh-pages` branch:
+          # https://github.com/actions/checkout/issues/13#issuecomment-724415212
+          # The GH actions bot is used by default if you didn't specify the two fields.
+          # You can swap them out with your own user credentials.
+          user_name: github-actions[bot]
+          user_email: 41898282+github-actions[bot]@users.noreply.github.com

Dockerfile

@@ -10,9 +10,7 @@ ENV TZ=Etc/GMT \
     COLORED_STD=true \
     FILES_ON_SERVER_DIR=/filesOnServer
 
-FROM base as app
-
-USER 1000
+FROM base as builder
 
 WORKDIR /usr/src/app
 
@@ -23,4 +21,12 @@ RUN npm install --omit=dev \
     && chown -R node:node node_modules \
     && rm -rf node_modules/@types
 
+FROM base as app
+
+USER 1000
+
+WORKDIR /usr/src/app
+
+COPY --chown=node:node --from=builder /usr/src/app /usr/src/app
+
 CMD ["dumb-init", "node", "/usr/src/app/node_modules/.bin/tsx", "/usr/src/app/src/index.ts"]

docsite/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

docsite/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

docsite/docs/FAQ.md

@@ -0,0 +1,6 @@
+---
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+dfsdfsd

docsite/docs/installation/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Installation",
+  "position": 2,
+  "link": {
+    "type": "generated-index",
+    "description": "Way to install Multi-Scrobbler"
+  }
+}