Groundwork for docs

.github/workflows/docs.yml

@@ -0,0 +1,57 @@
+name: Deploy VitePress site to Pages
+
+on:
+  push:
+    branches: [ "1.20.1/dev" ]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: pnpm
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: cd to docs/
+        run: cd docs/
+      - name: Install dependencies
+        run: pnpm install
+      - name: Build with VitePress
+        run: pnpm run build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+
+  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
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -43,6 +43,24 @@ local.properties
 # PDT-specific
 .buildpath
 
+# Vitepress
+docs/.vitepress/dist/
+docs/.vitepress/cache/
+
+# Logs
+docs/logs
+docs/*.log
+docs/npm-debug.log*
+docs/yarn-debug.log*
+docs/yarn-error.log*
+docs/pnpm-debug.log*
+docs/lerna-debug.log*
+
+docs/node_modules
+docs/dist
+docs/dist-ssr
+docs/*.local
+
 # Other
 .DS_Store
 mcmodsrepo

docs/.prettierignore

@@ -0,0 +1,4 @@
+pnpm-lock.yaml
+.vitepress/dist/
+.vitepress/cache/
+.idea/

docs/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "singleQuote": false,
+  "trailingComma": "es5",
+  "useTabs": false,
+  "tabWidth": 2,
+  "semi": true
+}

docs/.vitepress/config.ts

@@ -0,0 +1,50 @@
+// noinspection JSUnusedGlobalSymbols
+
+import { defineConfig } from "vitepress";
+import users from "./sidebars/users";
+import developers from "./sidebars/developers";
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: "Flywheel Docs",
+  description: "A modern engine for modded Minecraft.",
+
+  cleanUrls: true,
+  lastUpdated: true,
+
+  head: [["link", { rel: "icon", href: "/flywheel-icon-small.webp" }]],
+
+  themeConfig: {
+    logo: {
+      src: "/flywheel-icon-small.webp",
+      width: 24,
+      height: 24,
+    },
+
+    search: {
+      // TODO - Switch to Algolia Search post deployment
+      provider: "local",
+    },
+
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [{ text: "Home", link: "/" }],
+
+    sidebar: {
+      ...users,
+      ...developers,
+    },
+
+    socialLinks: [
+      {
+        icon: "github",
+        link: "https://github.com/Engine-Room/Flywheel",
+      },
+      { icon: "discord", link: "https://discord.gg/ambsHEyaAD" },
+    ],
+
+    editLink: {
+      pattern: "https://github.com/Engine-Room/Flywheel/edit/main/docs/:path",
+      text: "Edit this page on GitHub",
+    },
+  },
+});

docs/.vitepress/sidebars/developers.ts

@@ -0,0 +1,7 @@
+import {DefaultTheme} from "vitepress";
+
+export default {
+    "/developers": [
+        {}
+    ],
+} as DefaultTheme.SidebarMulti;

docs/.vitepress/sidebars/tutorial.ts

@@ -0,0 +1,10 @@
+import {DefaultTheme} from "vitepress";
+
+export default {
+    "/tutorial": [
+        {
+            text: "Getting Started",
+            link: "/tutorial",
+        }
+    ],
+} as DefaultTheme.SidebarMulti;

docs/.vitepress/theme/index.ts

@@ -0,0 +1,16 @@
+// noinspection JSUnusedGlobalSymbols
+
+// 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
+    });
+  },
+} satisfies Theme;

docs/.vitepress/theme/style.css

@@ -0,0 +1,141 @@
+/**
+ * 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: #4fddfa;
+  --vp-c-brand-2: #54d9f4;
+  --vp-c-brand-3: #82e5f9;
+  --vp-c-brand-soft: rgba(163, 218, 249, 0.14);
+
+  --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: var(--vp-c-brand-1);
+
+  --vp-home-hero-image-background-image: linear-gradient(
+    -45deg,
+    var(--vp-c-brand-2) 50%,
+    var(--vp-c-brand-2) 50%
+  );
+  --vp-home-hero-image-filter: blur(44px);
+}
+
+@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;
+}
+
+/**
+ * Custom
+ * -------------------------------------------------------------------------- */
+.image-container {
+  padding-top: 230px;
+}