work in progress on publishing docs

2026-07-26 23:31:44 +02:00
parent 5a906cdea0
commit 55138d7e2a
42 changed files with 462 additions and 460 deletions
@@ -0,0 +1,60 @@
+<!DOCTYPE html>
+<html lang="en" data-theme="dark">
+
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Spearhead API</title>
+   
+    <link rel="stylesheet" href="/style/prism.css">
+    <link rel="stylesheet" href="/style/style.css">
+
+    <script src="/js/prism.js"></script>
+    <script src="/js/site.js"></script>
+    <script type="module" src="../js/components.js"></script>
+</head>
+
+<body>
+    <header>
+        <app-header></app-header>
+    </header>    <main>
+        <div class="reference-container">
+            <app-sidebar></app-sidebar>
+
+            <div class="content-wrapper">
+                <h1>Spearhead API</h1>
+                
+                <div class="note">
+                    <p><strong>NOTE:</strong> The Spearhead.API space is only released in the Beta branch at the moment.</p>
+                </div>
+                
+                <h2 id="introduction">Introduction</h2>
+                <p>
+                    The <span class="inline-lua"><span class="lua-variable">Spearhead.API</span></span> space is specifically created to make sure mission makers can interact with the framework.
+                </p>
+                <p>
+                    Simply alter logic, get the current state in Spearhead, and give the whole Mission Editor more control.
+                </p>
+                <p>
+                    For example, late activate the entire framework by calling <span class="inline-lua"><span class="lua-function">Spearhead.API.Stages.changeStage</span>(<span class="lua-variable">1</span>)</span> later or on demand and setting the starting config stage to -1 in the Spearhead configuration file.
+                </p>
+
+                <h2 id="stages">Stages</h2>
+                <pre>
+                    @@API_CODE@@
+                </pre>
+            </div>
+        </div>
+    </main>
+    <footer>
+        <p>&copy; 2025 Spearhead Project</p>
+    </footer>
+    <style>
+    .side-nav a.active {
+        font-weight: bold;
+        color: #4fc3f7;
+    }
+    </style>
+</body>
+
+</html>