Documentation website

.gitignore

@@ -10,6 +10,10 @@ Desktop.ini
 
 /*.code-workspace
 
+# Downloadable & installable modules & components
+#
+/node_modules/
+
 # Environmental files
 #
 .env

docs/.gitignore

@@ -0,0 +1,4 @@
+# Generated & compiled files
+#
+/.vitepress/cache/
+/.vitepress/dist/

docs/.vitepress/config.mts

@@ -0,0 +1,108 @@
+import { fileURLToPath, URL } from "node:url";
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  lang: "en-US",
+  title: "CMaNGOS on Docker",
+  description: "A collection of ready-to-use Docker images to host your WoW emulated private server wherever you want.",
+  head: [
+    // All browsers
+    ["link", { rel: "icon", href: "/favicons/logo-16x16.png", sizes: "16x16", type: "image.png" }],
+    ["link", { rel: "icon", href: "/favicons/logo-32x32.png", sizes: "32x32", type: "image.png" }],
+
+    // Google & Android
+    ["link", { rel: "icon", href: "/favicons/logo-48x48.png", sizes: "48x48", type: "image.png" }],
+    ["link", { rel: "icon", href: "/favicons/logo-192x192.png", sizes: "192x192", type: "image.png" }],
+
+    // iPad
+    ["link", { rel: "apple-touch-icon", href: "/favicons/logo-167x167.png", sizes: "167x167", type: "image.png" }],
+
+    // iPhone
+    ["link", { rel: "apple-touch-icon", href: "/favicons/logo-180x180.png", sizes: "180x180", type: "image.png" }],
+
+    ["script", {
+      "src": "https://cloud.umami.is/script.js",
+      "data-website-id": "46e2a043-e364-4c30-8561-45e4e4797398",
+      "defer": ""
+    }]
+  ],
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    logo: "/logo.png",
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'Guide', link: '/guide/introduction' }
+    ],
+
+    sidebar: [
+      {
+        text: 'Getting Started',
+        items: [
+          { text: 'Introduction', link: '/guide/introduction' },
+          { text: 'Requirements', link: '/guide/requirements' },
+          { text: 'Getting Started', link: '/guide/getting-started' }
+        ]
+      },
+      {
+        text: 'Server Management',
+        items: [
+          { text: 'Server Administration', link: '/guide/server-administration' },
+          { text: 'Server Configuration', link: '/guide/server-configuration' },
+          { text: 'Database Management', link: '/guide/database-management' }
+        ]
+      },
+      {
+        text: 'Maintenance',
+        items: [
+          { text: 'Installing Updates', link: '/guide/install-updates' }
+        ]
+      },
+      {
+        text: 'Advanced',
+        items: [
+          { text: 'Customization', link: '/guide/customization' },
+          { text: 'Use in Production', link: '/guide/use-in-production' }
+        ]
+      }
+    ],
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/Byloth/cmangos-docker' }
+    ],
+    footer: {
+      message: `Released under the
+<a href="https://creativecommons.org/licenses/by-sa/4.0/" target="_blank" rel="noopener noreferrer nofollow">
+  CC BY-SA 4.0 License</a>.`,
+      copyright: `Copyright © 2014-${new Date().getFullYear()}
+<a href="https://github.com/Byloth">
+  Matteo Bilotta</a>.`
+    },
+
+    editLink: {
+      pattern: 'https://github.com/Byloth/cmangos-docker/edit/master/docs/:path',
+      text: 'Edit this page on GitHub'
+    },
+
+    search: {
+      provider: 'local'
+    },
+
+    lastUpdated: {
+      text: 'Last updated',
+      formatOptions: {
+        dateStyle: 'medium'
+      }
+    }
+  },
+  vite: {
+    resolve: {
+      alias: { "@": fileURLToPath(new URL("../src", import.meta.url)) }
+    }
+  },
+  lastUpdated: true,
+  ignoreDeadLinks: [
+    // Ignore localhost links (they're examples for the user)
+    /^http:\/\/localhost/
+  ]
+})

docs/.vitepress/theme/index.ts

@@ -0,0 +1,17 @@
+// https://vitepress.dev/guide/custom-theme
+import { h } from 'vue'
+import type { Theme } from 'vitepress'
+import DefaultTheme from 'vitepress/theme'
+import './style.css'
+
+export default {
+  extends: DefaultTheme,
+  Layout: () => {
+    return h(DefaultTheme.Layout, null, {
+      // https://vitepress.dev/guide/extending-default-theme#layout-slots
+    })
+  },
+  enhanceApp({ app, router, siteData }) {
+    // ...
+  }
+} satisfies Theme

docs/.vitepress/theme/style.css

@@ -0,0 +1,150 @@
+/**
+ * Customize default theme styling by overriding CSS variables:
+ * https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
+ */
+
+/**
+ * Colors
+ *
+ * Each colors have exact same color scale system with 3 levels of solid
+ * colors with different brightness, and 1 soft color.
+ *
+ * - `XXX-1`: The most solid color used mainly for colored text. It must
+ *   satisfy the contrast ratio against when used on top of `XXX-soft`.
+ *
+ * - `XXX-2`: The color used mainly for hover state of the button.
+ *
+ * - `XXX-3`: The color for solid background, such as bg color of the button.
+ *   It must satisfy the contrast ratio with pure white (#ffffff) text on
+ *   top of it.
+ *
+ * - `XXX-soft`: The color used for subtle background such as custom container
+ *   or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
+ *   on top of it.
+ *
+ *   The soft color must be semi transparent alpha channel. This is crucial
+ *   because it allows adding multiple "soft" colors on top of each other
+ *   to create a accent, such as when having inline code block inside
+ *   custom containers.
+ *
+ * - `default`: The color used purely for subtle indication without any
+ *   special meanings attached to it such as bg color for menu hover state.
+ *
+ * - `brand`: Used for primary brand colors, such as link text, button with
+ *   brand theme, etc.
+ *
+ * - `tip`: Used to indicate useful information. The default theme uses the
+ *   brand color for this by default.
+ *
+ * - `warning`: Used to indicate warning to the users. Used in custom
+ *   container, badges, etc.
+ *
+ * - `danger`: Used to show error, or dangerous message to the users. Used
+ *   in custom container, badges, etc.
+ * -------------------------------------------------------------------------- */
+
+:root
+{
+  --vp-c-default-1: var(--vp-c-gray-1);
+  --vp-c-default-2: var(--vp-c-gray-2);
+  --vp-c-default-3: var(--vp-c-gray-3);
+  --vp-c-default-soft: var(--vp-c-gray-soft);
+
+  --vp-c-brand-1: var(--vp-c-indigo-1);
+  --vp-c-brand-2: var(--vp-c-indigo-2);
+  --vp-c-brand-3: var(--vp-c-indigo-3);
+  --vp-c-brand-soft: var(--vp-c-indigo-soft);
+
+  --vp-c-tip-1: var(--vp-c-brand-1);
+  --vp-c-tip-2: var(--vp-c-brand-2);
+  --vp-c-tip-3: var(--vp-c-brand-3);
+  --vp-c-tip-soft: var(--vp-c-brand-soft);
+
+  --vp-c-warning-1: var(--vp-c-yellow-1);
+  --vp-c-warning-2: var(--vp-c-yellow-2);
+  --vp-c-warning-3: var(--vp-c-yellow-3);
+  --vp-c-warning-soft: var(--vp-c-yellow-soft);
+
+  --vp-c-danger-1: var(--vp-c-red-1);
+  --vp-c-danger-2: var(--vp-c-red-2);
+  --vp-c-danger-3: var(--vp-c-red-3);
+  --vp-c-danger-soft: var(--vp-c-red-soft);
+}
+
+/**
+ * Component: Button
+ * -------------------------------------------------------------------------- */
+
+:root
+{
+  --vp-button-brand-border: transparent;
+  --vp-button-brand-text: var(--vp-c-white);
+  --vp-button-brand-bg: var(--vp-c-brand-3);
+  --vp-button-brand-hover-border: transparent;
+  --vp-button-brand-hover-text: var(--vp-c-white);
+  --vp-button-brand-hover-bg: var(--vp-c-brand-2);
+  --vp-button-brand-active-border: transparent;
+  --vp-button-brand-active-text: var(--vp-c-white);
+  --vp-button-brand-active-bg: var(--vp-c-brand-1);
+}
+
+/**
+ * Component: Home
+ * -------------------------------------------------------------------------- */
+
+:root
+{
+  --vp-home-hero-name-color: transparent;
+  --vp-home-hero-name-background: -webkit-linear-gradient(
+    -60deg, #f47731, #f5594e, #ea3f68, #d53080, #b63294, #8e3aa1, #5d41a5, #0c449f
+  );
+
+  --vp-home-hero-image-background-image: linear-gradient(-45deg, #f47731 33.333%, #c5318a, #0c449f 66.666%);
+
+  --vp-home-hero-image-filter: blur(44px);
+}
+.dark
+{
+  --vp-home-hero-name-background: -webkit-linear-gradient(
+    -60deg, #fc952f, #ff7b5e, #ff6a8c, #fb6ab6, #d676d7, #a484e8, #678ee8, #1093d7
+  );
+
+  --vp-home-hero-image-background-image: linear-gradient(-45deg, #fc952f 33.333%, #e970c6, #1093d7 66.666%);
+}
+
+@media (min-width: 640px)
+{
+  :root
+  {
+    --vp-home-hero-image-filter: blur(56px);
+  }
+}
+
+@media (min-width: 960px)
+{
+  :root
+  {
+    --vp-home-hero-image-filter: blur(68px);
+  }
+}
+
+/**
+ * Component: Custom Block
+ * -------------------------------------------------------------------------- */
+
+:root
+{
+  --vp-custom-block-tip-border: transparent;
+  --vp-custom-block-tip-text: var(--vp-c-text-1);
+  --vp-custom-block-tip-bg: var(--vp-c-brand-soft);
+  --vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
+}
+
+/**
+ * Component: Algolia
+ * -------------------------------------------------------------------------- */
+
+.DocSearch
+{
+  --docsearch-primary-color: var(--vp-c-brand-1) !important;
+}

docs/guide/customization.md

@@ -0,0 +1,49 @@
+# Customization
+
+::: warning Coming Soon
+This page is a placeholder.  
+Content will be added in a future update.
+:::
+
+This section will cover advanced customization options for your CMaNGOS Docker server, including:
+
+## Planned topics
+
+### Custom game rates
+
+- Experience rates (killing, quests, exploration)
+- Drop rates (items, gold)
+- Reputation gains
+- Skill leveling speed
+
+### Server rules
+
+- PvP settings and rules
+- Rest experience configuration
+- Auction house settings
+- Guild and group options
+
+### World modifications
+
+- Adding custom NPCs
+- Modifying loot tables
+- Creating custom quests
+- Event scheduling
+
+### Visual customizations
+
+- Custom loading screens
+- Modified game assets
+- Client-side patches
+
+### Modules and extensions
+
+- PlayerBots module
+- Auction House Bot
+- Other community modules
+
+---
+
+::: tip Contribute
+If you'd like to help write this documentation, feel free to [open a pull request](https://github.com/Byloth/cmangos-docker/pulls) or [suggest content](https://github.com/Byloth/cmangos-docker/issues/new/choose).
+:::