docs: Add glossary plugin

docsite/docusaurus.config.ts

@@ -1,6 +1,7 @@
 import type * as Preset from '@docusaurus/preset-classic';
 import type { Config } from '@docusaurus/types';
 import * as themes from 'prism-react-renderer';
+import glossaryPlugin from 'docusaurus-plugin-glossary';
 //import sidebars from './sidebars';
 
 const config: Config = {
@@ -50,10 +51,15 @@ const config: Config = {
         docs: {
           sidebarPath: './sidebars.ts',
           routeBasePath: '/',
-          // Please change this to your repo.
-          // Remove this to remove the "edit this page" links.
-          editUrl:
-            'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
+          remarkPlugins: [
+            glossaryPlugin.getRemarkPlugin(
+              {
+                glossaryPath: 'glossary/glossary.json',
+                routePath: '/glossary',
+              },
+              { siteDir: __dirname }
+            ),
+          ],
         },
         // blog: {
         //   showReadingTime: true,
@@ -121,7 +127,14 @@ const config: Config = {
           },
         ]
       }
-    ]
+    ],
+        [
+      'docusaurus-plugin-glossary',
+      {
+        glossaryPath: 'glossary/glossary.json',
+        routePath: '/glossary',
+      },
+    ],
   ],
   themeConfig:
     {

docsite/glossary/glossary.json

@@ -0,0 +1,56 @@
+{
+  "description": "A collection of technical terms and their definitions",
+  "terms": [
+    {
+      "term": "AIO",
+      "abbreviation": "All-In-One",
+      "definition": "Configuration type that uses the config.json file to configure Sources, Clients, and all application configuration together",
+      "relatedTerms": ["File Config", "ENV Config"]
+    },
+    {
+      "term": "Client",
+      "definition": "Services that recieve/store Scrobbles sent by Multi-Scrobbler.",
+      "relatedTerms": ["Source"]
+    },
+    {
+      "term": "ENV Config",
+      "definition": "Configuration type that uses environmental variales to configure Sources and Clients",
+      "relatedTerms": ["AIO", "File Config"]
+    },
+    {
+      "term": "ENV",
+      "abbreviation": "Environmental Variable",
+      "definition": "A variable passed to a docker container or present in the operating environment.",
+      "relatedTerms": ["Env Config"]
+    },
+    {
+      "term": "File Config",
+      "definition": "Configuration type that uses individual JSON files to configure Sources and Clients",
+      "relatedTerms": ["AIO", "ENV Config"]
+    },
+    {
+      "term": "MS",
+      "abbreviation": "Multi-Scrobbler",
+      "definition": "Multi-Scrobbler"
+    },
+        {
+      "term": "Play",
+      "definition": "The data related to a specific piece of audio you listened to, without a timestamp. EX: Artist, Title, Album...",
+      "relatedTerms": ["Scrobble"]
+    },
+    {
+      "term": "Source",
+      "definition": "A service/app that Multi-Scrobbler can get listening activity/history from.",
+      "relatedTerms": ["Client"]
+    },
+    {
+      "term": "Scrobble",
+      "definition": "The data (Play) and timestamp related to a certain song you listened to at a specific time"
+    },
+    {
+      "term": "Scrobbling",
+      "definition": "The verb for sending a Scrobble to one or more Clients",
+      "relatedTerms": ["Scrobble", "Client"]
+    }
+  ]
+}

docsite/package.json

@@ -14,26 +14,27 @@
     "typecheck": "tsc"
   },
   "dependencies": {
-    "@docusaurus/core": "3.8.1",
-    "@docusaurus/faster": "3.8.1",
-    "@docusaurus/plugin-client-redirects": "^3.8.1",
-    "@docusaurus/preset-classic": "3.8.1",
-    "@easyops-cn/docusaurus-search-local": "0.51.1",
+    "@docusaurus/core": "3.9.2",
+    "@docusaurus/faster": "3.9.2",
+    "@docusaurus/plugin-client-redirects": "^3.9.2",
+    "@docusaurus/preset-classic": "3.9.2",
+    "@easyops-cn/docusaurus-search-local": "0.52.2",
     "@mdx-js/react": "^3.0.0",
     "clsx": "^2.0.0",
-    "docusaurus-json-schema-plugin": "^1.14.0",
+    "docusaurus-json-schema-plugin": "^1.15.0",
+    "docusaurus-plugin-glossary": "^3.0.0",
     "docusaurus-theme-github-codeblock": "^2.0.2",
     "json5": "^2.2.3",
     "micromark-extension-directive": "^3.0.1",
     "prism-react-renderer": "^2.3.0",
     "raw-loader": "^4.0.2",
-    "react": "^19.0.0",
-    "react-dom": "^19.0.0"
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "^3.6.3",
-    "@docusaurus/tsconfig": "^3.6.3",
-    "@docusaurus/types": "^3.6.3",
+    "@docusaurus/module-type-aliases": "^3.9.2",
+    "@docusaurus/tsconfig": "^3.9.2",
+    "@docusaurus/types": "^3.9.2",
     "@types/react": "^18.2.29",
     "typescript": "~5.6.2"
   },