Initial spike of Github Pages project status / documentation portal (#400)

* docs: move markdown documentation to be caught by docsify * docs: Initial spike of project status / doc portal * docs: Add searchbar to docsify page * docs: Remove the package-lock.json file, not critical for us * docs: Fix search plugin link * docs: Fix search results colors * docs: Remove the navbar, now redundant.
2026-08-22 07:04:29 -04:00 · 2021-04-30 01:13:15 -04:00
parent 56625bb0ee
commit fab73cab75
57 changed files with 476 additions and 5 deletions
@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" href="/jak-project/favicon.png" />
+    <title>OpenGOAL - API Docs</title>
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+    <meta name="description" content="Description" />
+    <meta
+      name="viewport"
+      content="width=device-width, initial-scale=1.0, minimum-scale=1.0"
+    />
+    <link
+      rel="stylesheet"
+      href="https://cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css"
+    />
+    <style>
+      .sidebar {
+        background-color: #0d1117;
+      }
+      .sidebar ul li a {
+        color: #c5ccd4;
+      }
+      .sidebar-toggle {
+        background-color: #0d1117;
+      }
+      .app-name-link > img:nth-child(1) {
+        width: 75%;
+      }
+      .search {
+        border-bottom: none !important;
+      }
+      .search a {
+        color: #c5ccd4 !important;
+      }
+    </style>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script>
+      window.$docsify = {
+        name: "OpenGOAL Docs",
+        repo: "https://github.com/water111/jak-project",
+        basePath: "./markdown/",
+        loadSidebar: true,
+        subMaxLevel: 2,
+        logo: "./markdown/imgs/logo-text-colored.png",
+        search: "auto", // default
+
+        // complete configuration parameters
+        search: {
+          maxAge: 86400000, // Expiration time, the default one day
+          paths: "auto",
+          placeholder: "Search Docs",
+          noData: "No Results!",
+          // Headline depth, 1 - 6
+          depth: 6,
+          hideOtherSidebarContent: false, // whether or not to hide other sidebar content
+        },
+      };
+    </script>
+    <!-- Docsify v4 -->
+    <script src="https://cdn.jsdelivr.net/npm/docsify@4"></script>
+    <script src="https://unpkg.com/docsify@4.12.1/lib/plugins/search.min.js"></script>
+  </body>
+</html>