add docs setup

2023-02-18 22:47:53 +00:00 · 2023-02-18 22:47:53 +00:00 · d83bf6d86c
commit d83bf6d86c
parent 66360e3438
5 changed files with 2084 additions and 0 deletions
--- a/.gitignore
+++ b/.gitignore
@ -2,3 +2,4 @@
 .vscode
 vmf/bundleV1
 vmf/bundleV2
+node_modules
--- a/docs/.nojekyll
+++ b/docs/.nojekyll
--- a/docs/index.html
+++ b/docs/index.html
@ -0,0 +1,49 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title>DMF Docs</title>
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+    <meta
+      name="description"
+      content="The Darktide Mod Framework is an open-source, community-run framework of modules that provides enhanced modding capabilities and support."
+    />
+    <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>
+      h1.app-name {
+        font-weight: 900;
+        text-transform: uppercase;
+        font-family: system-ui, "Helvetica Neue", Arial, sans-serif;
+      }
+    </style>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script>
+      var repo = "Darktide-Mod-Framework/Darktide-Mod-Framework";
+      window.$docsify = {
+        name: "Darktide Mod Framework",
+        repo,
+        basePath: `https://raw.githubusercontent.com/wiki/${repo}/`,
+        coverpage: false,
+        alias: {
+          "/.*/_sidebar.md": "/_sidebar.md",
+        },
+        loadSidebar: true,
+        auto2top: true,
+        search: "auto",
+      };
+    </script>
+    <!-- Docsify v4 -->
+    <script src="https://cdn.jsdelivr.net/npm/docsify@4"></script>
+    <script src="https://cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-lua.min.js"></script>
+  </body>
+</html>
--- a/docs/package-lock.json
+++ b/docs/package-lock.json
--- a/docs/package.json
+++ b/docs/package.json
@ -0,0 +1,10 @@
+{
+  "name": "dmf-docs",
+  "private": true,
+  "scripts": {
+    "start": "docsify serve ."
+  },
+  "dependencies": {
+    "docsify-cli": "^4.4.4"
+  }
+}