JDSKJSDKJAKJ

.gitignore

@@ -17,7 +17,8 @@ client/public/plugins/
 backend/plugins/
 
 # Docs
-docs/
+documentation/docs/.vuepress/.cache
+documentation/docs/.vuepress/.temp
 
 # local env files
 .env.local

backend/tests/app.spec.js

@@ -2,7 +2,7 @@ const supertest = require('supertest');
 const { app, server } = require('../server.js');
 const request = supertest(app);
 
-const { connectDB, disconnectDB } = require('../services/database');
+const { connectDB, disconnectDB } = require('../services/database.js');
 
 describe('API test', () => {
   beforeAll(() => {

build.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 # Gen docs
-npm run generate-docs
+npx vuepress-jsdoc --exclude="*"
 
 # Copy media to all versions of documentation (if there is more than one)
 # for d in docs/dragonroll/*/; do cp -r media "$d/media"; done

documentation/docs/.vuepress/config.js

@@ -0,0 +1,19 @@
+import { defaultTheme } from '@vuepress/theme-default'
+import { defineUserConfig } from 'vuepress/cli'
+import { viteBundler } from '@vuepress/bundler-vite'
+
+export default defineUserConfig({
+  lang: 'en-US',
+
+  title: 'Dragonroll Docs',
+  description: 'Documentation for Dragonroll API for plugin development',
+
+  theme: defaultTheme({
+    logo: '/images/logo-light.png',
+    logoDark: '/images/logo.png',
+
+    navbar: ['/', '/get-started'],
+  }),
+
+  bundler: viteBundler(),
+})

documentation/docs/.vuepress/styles/index.scss

@@ -0,0 +1,112 @@
+// === colors ===
+:root {
+    // accent colors
+    --vp-c-accent: #E13F65;
+    --vp-c-accent-bg: #F5556B;
+    --vp-c-accent-hover: #FF867B;
+    --vp-c-accent-text: var(--vp-c-white);
+    --vp-c-accent-soft: rgba(185, 16, 67, 0.14);
+  
+    // background colors
+    --vp-c-bg: #fff;
+    --vp-c-bg-alt: #f6f6f7;
+    --vp-c-bg-elv: #fff;
+  
+    // text colors
+    --vp-c-text: rgb(60 60 67);
+    --vp-c-text-mute: rgb(60 60 67 / 78%);
+    --vp-c-text-subtle: rgb(60 60 67 / 56%);
+  
+    // border colors
+    --vp-c-gutter: #e2e2e3;
+    --vp-c-border: #c2c2c4;
+    --vp-c-border-hard: #b8b8ba;
+  
+    // shadow colors
+    --vp-c-shadow: rgb(0 0 0 / 15%);
+  
+    // control colors
+    --vp-c-control: rgb(142 150 170 / 10%);
+    --vp-c-control-hover: rgb(142 150 170 / 16%);
+    --vp-c-control-disabled: #eaeaea;
+  
+    // layout colors
+    --vp-navbar-c-bg: var(--vp-c-bg);
+    --vp-sidebar-c-bg: var(--vp-c-bg);
+  
+    // code group colors
+    --vp-c-code-tab-title: var(--code-c-text, rgb(255 255 255 / 90%));
+    --vp-c-code-tab-bg: var(--code-bg-color, var(--code-c-bg));
+    --vp-c-code-tab-active: var(--vp-c-accent);
+  
+    // badge colors
+    --badge-c-tip-text: var(--vp-c-green-text);
+    --badge-c-tip-bg: var(--vp-c-green-soft);
+    --badge-c-warning-text: var(--vp-c-yellow-text);
+    --badge-c-warning-bg: var(--vp-c-yellow-soft);
+    --badge-c-danger-text: var(--vp-c-red-text);
+    --badge-c-danger-bg: var(--vp-c-red-soft);
+    --badge-c-important-text: var(--vp-c-purple-text);
+    --badge-c-important-bg: var(--vp-c-purple-soft);
+    --badge-c-info-text: var(--vp-c-indigo-text);
+    --badge-c-info-bg: var(--vp-c-indigo-soft);
+    --badge-c-note-text: var(--vp-c-grey-text);
+    --badge-c-note-bg: var(--vp-c-grey-soft);
+  
+    // font vars
+    --font-family: -apple-system, 'BlinkMacSystemFont', 'Segoe UI', roboto, oxygen,
+      ubuntu, cantarell, 'Fira Sans', 'Droid Sans', 'Helvetica Neue', sans-serif;
+  
+    // layout vars
+    --navbar-height: 3.6rem;
+    --navbar-padding-v: 0.7rem;
+    --navbar-padding-h: 1.5rem;
+    --sidebar-width: 20rem;
+    --sidebar-width-mobile: calc(var(--sidebar-width) * 0.82);
+    --content-width: 740px;
+    --homepage-width: 960px;
+  
+    // header offset
+    --header-offset: var(--navbar-height);
+  
+    // transition vars
+    --vp-t-color: 0.3s ease;
+    --vp-t-transform: 0.3s ease;
+  
+    // external-link-icon
+    --external-link-icon: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'%3E%3Cpath d='M0 0h24v24H0V0z' fill='none'/%3E%3Cpath d='M9 5v2h6.59L4 18.59 5.41 20 17 8.41V15h2V5H9z'/%3E%3C/svg%3E");
+    --external-link-c-icon: var(--vp-c-text-mute);
+  }
+  
+  
+  [data-theme='dark'] {
+    // brand colors
+    --vp-c-accent: #FF772F;
+    --vp-c-accent-bg: #FF4700;
+    --vp-c-accent-hover: #ff783a;
+    --vp-c-accent-soft: rgba(185, 64, 16, 0.16);
+  
+    // background colors
+    --vp-c-bg: #1b1b1f;
+    --vp-c-bg-alt: #161618;
+    --vp-c-bg-elv: #202127;
+  
+    // text colors
+    --vp-c-text: rgb(235 235 245 / 86%);
+    --vp-c-text-mute: rgb(235 235 245 / 60%);
+    --vp-c-text-subtle: rgb(235 235 245 / 38%);
+  
+    // border colors
+    --vp-c-gutter: #000;
+    --vp-c-border: #3c3f44;
+    --vp-c-border-hard: #45484e;
+  
+    // shadow color
+    --vp-c-shadow: rgb(0 0 0 / 30%);
+  
+    // control colors
+    --vp-c-control: rgb(101 117 133 / 12%);
+    --vp-c-control-hover: rgb(101 117 133 / 18%);
+    --vp-c-control-disabled: #363636;
+  }
+  

documentation/docs/README.md

@@ -0,0 +1,18 @@
+---
+home: true
+title: Home
+heroImage: images/logo-splash-light.png
+heroImageDark: images/logo-splash.png
+actions:
+  - text: Get Started
+    link: /get-started.html
+    type: primary
+
+#  - text: Introduction
+#    link: https://vuejs.press/guide/introduction.html
+#    type: secondary
+
+footer: MIT Licensed | Copyright © 2024-Aran Roig
+---
+
+[default-theme-home]: https://vuejs.press/reference/default-theme/frontmatter.html#home-page

documentation/docs/get-started.md

@@ -0,0 +1,46 @@
+# Get Started
+
+This is a normal page, which contains VuePress basics.
+
+## Pages
+
+You can add markdown files in your vuepress directory, every markdown file will be converted to a page in your site.
+
+See [routing][] for more details.
+
+## Content
+
+Every markdown file [will be rendered to HTML, then converted to a Vue SFC][content].
+
+VuePress support basic markdown syntax and [some extensions][synatex-extensions], you can also [use Vue features][vue-feature] in it.
+
+## Configuration
+
+VuePress use a `.vuepress/config.js`(or .ts) file as [site configuration][config], you can use it to config your site.
+
+For [client side configuration][client-config], you can create `.vuepress/client.js`(or .ts).
+
+Meanwhile, you can also add configuration per page with [frontmatter][].
+
+## Layouts and customization
+
+Here are common configuration controlling layout of `@vuepress/theme-default`:
+
+- [navbar][]
+- [sidebar][]
+
+Check [default theme docs][default-theme] for full reference.
+
+You can [add extra style][style] with `.vuepress/styles/index.scss` file.
+
+[routing]: https://vuejs.press/guide/page.html#routing
+[content]: https://vuejs.press/guide/page.html#content
+[synatex-extensions]: https://vuejs.press/guide/markdown.html#syntax-extensions
+[vue-feature]: https://vuejs.press/guide/markdown.html#using-vue-in-markdown
+[config]: https://vuejs.press/guide/configuration.html#client-config-file
+[client-config]: https://vuejs.press/guide/configuration.html#client-config-file
+[frontmatter]: https://vuejs.press/guide/page.html#frontmatter
+[navbar]: https://vuejs.press/reference/default-theme/config.html#navbar
+[sidebar]: https://vuejs.press/reference/default-theme/config.html#sidebar
+[default-theme]: https://vuejs.press/reference/default-theme/
+[style]: https://vuejs.press/reference/default-theme/styles.html#style-file

documentation/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "dragonroll-docs",
+  "version": "0.0.1",
+  "description": "Dragonroll documentation",
+  "license": "MIT",
+  "type": "module",
+  "scripts": {
+    "docs:build": "vuepress build docs",
+    "docs:clean-dev": "vuepress dev docs --clean-cache",
+    "docs:dev": "vuepress dev docs",
+    "docs:update-package": "npx vp-update"
+  },
+  "devDependencies": {
+    "@vuepress/bundler-vite": "^2.0.0-rc.7",
+    "@vuepress/theme-default": "^2.0.0-rc.11",
+    "sass-embedded": "^1.79.4",
+    "vue": "^3.4.0",
+    "vuepress": "^2.0.0-rc.7"
+  }
+}

jsdoc.json

@@ -1,32 +0,0 @@
-{
-    "source": {
-        "includePattern": ".+\\.js(doc|x)?$",
-        "include": ["./client/src/services/Api.js", "./backend/services/api.js", "package.json", "DOCS.md"],
-        "exclude": ["node_modules"]
-    },
-    "plugins": ["plugins/markdown"],
-    "recurseDepth": 10,
-    "opts": {
-        "encoding": "utf8",
-        "readme": "./DOCS.md",
-        "destination": "docs/",
-        "recurse": true,
-        "verbose": true,
-        "template": "node_modules/clean-jsdoc-theme",
-        "tutorials": "./tutorials",
-        "theme_opts": {
-            "sort": false,
-            "default_theme": "dark",
-            "homepageTitle": "Dragonroll API",
-            "title": "<a href='index.html'><img src='static/media/logo-splash.png' class='logo-splash-dark'/><img src='static/media/logo-splash-light.png' class='logo-splash-light'/></a>",
-            "static_dir": ["./static"],
-            "include_js": ["./static/scripts/themeWatch.js"],
-            "favicon": "static/media/logo.png",
-            "outputSourceFiles": false
-        }
-    },
-    "markdown": {
-        "hardwrap": false,
-        "idInHeadings": true
-    }
-}

package.json

@@ -20,6 +20,7 @@
     "clean-jsdoc-theme": "^4.3.0",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
-    "jsdoc": "^4.0.3"
+    "jsdoc": "^4.0.3",
+    "vuepress-jsdoc": "^5.0.0"
   }
 }

tutorials/tutorials.json

@@ -5,6 +5,9 @@
     "howtoread": {
         "title": "How to read this documentation"
     },
+    "guides": {
+        "title": "Guides",
+        "children": {
             "vdragonviews": {
                 "title": "Using Dragonroll views"
             },
@@ -12,3 +15,5 @@
                 "title": "Creating a window"
             }
         }
+    }
+}