Merge branch 'space-wizards:master' into master

Author: ScarKy0

.github/workflows/deploy.yml

@@ -31,14 +31,14 @@ jobs:
       - name: Install mdbook & plugins
         uses: taiki-e/install-action@v2.18.6
         with:
-          tool: mdbook@0.4.36,mdbook-admonish@1.14.0,mdbook-linkcheck@0.7.7,mdbook-mermaid@0.12.6,mdbook-template@1.1.0,mdbook-emojicodes@0.3.0
+          tool: mdbook@0.4.36,mdbook-admonish@1.14.0,mdbook-linkcheck@0.7.7,mdbook-mermaid@0.12.6,mdbook-template@1.1.0,mdbook-emojicodes@0.3.0,mdbook-embedify@0.2.11
       - name: Setup Pages
         id: pages
         uses: actions/configure-pages@v3
       - name: Build with mdBook
         run: mdbook build
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v2
+        uses: actions/upload-pages-artifact@v3
         with:
           path: ./book/html
 
@@ -53,4 +53,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v2
+        uses: actions/deploy-pages@v4

.github/workflows/test.yml

@@ -17,11 +17,11 @@ jobs:
       - name: Install mdbook & plugins
         uses: taiki-e/install-action@v2.18.6
         with:
-          tool: mdbook@0.4.36,mdbook-admonish@1.14.0,mdbook-linkcheck@0.7.7,mdbook-mermaid@0.12.6,mdbook-template@1.1.0,mdbook-emojicodes@0.3.0
+          tool: mdbook@0.4.36,mdbook-admonish@1.14.0,mdbook-linkcheck@0.7.7,mdbook-mermaid@0.12.6,mdbook-template@1.1.0,mdbook-emojicodes@0.3.0,mdbook-embedify@0.2.11
       - name: Build with mdBook
         run: mdbook build
       - name: Upload artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: Built Site
           path: ./book/html

.gitignore

@@ -4,3 +4,6 @@ book
 # editor files
 .*~
 *.swp
+
+# VSCodium files
+.vscode/

README.md

@@ -20,6 +20,7 @@ The following `mdbook` features & plugins are available and in use:
 - `mdbook-template`
 - `mdbook-admonish`
 - `mdbook-emojicodes`
+- `mdbook-embedify`
 
 **For information such as how to edit, build & test these docs, see [Guide to Editing Docs](https://spacestation14.io/docs/en/meta/guide-to-editing-docs.html). on the site itself** (or [in this repo](./src/en/meta/guide-to-editing-docs.md))
 

book.toml

@@ -17,9 +17,11 @@ command = "mdbook-admonish"
 [preprocessor.template]
 before = ["mermaid","admonish","emojicodes"] # templates can include these so we run this first
 
+[preprocessor.embedify]
+
 [output.html]
 additional-js = ['scripts/mermaid.min.js', 'scripts/mermaid-init.js', 'scripts/nav-additions.js']
-additional-css = ['theme/mdbook-admonish.css', 'theme/ss14.css', 'theme/nav-style.css']
+additional-css = ['theme/compiled/ss14.css']
 default-theme = "navy"
 preferred-dark-theme = "navy"
 

scripts/mermaid.min.js

@@ -0,0 +1,9 @@
+// Build with 
+// sass ./scss/main.scss ./theme/compiled/ss14.css
+// Get sass with "npm install -g sass"
+
+@use "ss14";
+@use "ss14-mermaid.scss";
+@use "mdbook-admonish";
+@use "nav-style";
+

scss/main.scss

@@ -0,0 +1,50 @@
+// These all have to be !important because Mermaid sets all of them based on ID matches, which sucks.
+
+html {
+    --mermaid-sequence-actor-bg: #2d4c5a;
+    --mermaid-sequence-actor-stroke: #2a3355;
+
+    --mermaid-sequence-note-bg: #2d5a44;
+    --mermaid-sequence-note-stroke: #253d31;
+
+    --mermaid-sequence-rect-bg: #21273C;
+}
+
+// Light themes.
+.light, .rust {
+    --mermaid-sequence-actor-bg: #cde498;
+    --mermaid-sequence-actor-stroke: #a6cf47;
+
+    --mermaid-sequence-note-bg: #fff5ad;
+    --mermaid-sequence-note-stroke: #aaaa33;
+
+    --mermaid-sequence-rect-bg: #abe5f3;
+}
+
+pre.mermaid svg[aria-roledescription="sequence"] {
+    defs > #arrowhead > path {
+        fill: var(--fg) !important;
+        stroke: var(--fg) !important;
+    }
+    .actor {
+        fill: var(--mermaid-sequence-actor-bg) !important;
+        stroke: var(--mermaid-sequence-actor-stroke) !important;
+    }
+
+    .actor > tspan, .messageText, .loopText, .loopText > tspan, .noteText > tspan {
+        fill: var(--fg) !important;
+    }
+
+    .actor-line, .messageLine0, .messageLine1, .loopLine {
+        stroke: var(--fg) !important;
+    }
+
+    .note {
+        fill: var(--mermaid-sequence-note-bg) !important;
+        stroke: var(--mermaid-sequence-note-stroke) !important;
+    }
+
+    .rect {
+        fill: var(--mermaid-sequence-rect-bg) !important;
+    }
+}