chore(docs): vendor the book into docs/book and serve it from the site

Hosting the book as a separate repository made link upkeep, dep
versioning, and CI fan-out unnecessarily painful. The book sources, the
hello demo, justfile, and README move under docs/book and the demo's
nightshade dependency switches from a git URL to a workspace-relative
path. The docs directory is excluded from the cargo workspace so the
demo stays out of the main build, and the gitignore whitelists the
book's markdown files.

The site's Book button now resolves to {{ base_url }}/book/, the pages
workflow installs mdBook, builds the book and demo into
site/static/book, and bamboo bundles them into the deployed site so the
book is reachable at /nightshade/book/. The README points there too.

Author: matthewjberger

.github/workflows/pages.yml

@@ -55,9 +55,23 @@ jobs:
         if: steps.cache-bamboo.outputs.cache-hit != 'true'
         run: cargo install bamboo-cli --version 0.5.3 --locked
 
+      - name: Setup mdBook
+        uses: peaceiris/actions-mdbook@v2
+        with:
+          mdbook-version: '0.4.52'
+
       - name: Build viewer
         run: trunk build --release --config apps/viewer/Trunk.toml --dist "$GITHUB_WORKSPACE/site/static/viewer" --public-url /nightshade/viewer/
 
+      - name: Build book demo
+        run: trunk build --release --config docs/book/demos/hello/Trunk.toml --dist "$GITHUB_WORKSPACE/docs/book/demos/hello/dist" --public-url /nightshade/book/demos/hello/
+
+      - name: Build book
+        run: mdbook build docs/book --dest-dir "$GITHUB_WORKSPACE/site/static/book"
+
+      - name: Copy book demo into book output
+        run: mkdir -p site/static/book/demos/hello && cp -r docs/book/demos/hello/dist/. site/static/book/demos/hello/
+
       - name: Build site
         working-directory: site
         run: bamboo build --base-url "https://matthewjberger.github.io/nightshade"

.gitignore

@@ -14,6 +14,7 @@ logs/
 !crates/nightshade/*.md
 !template/*.md
 !docs/*.md
+!docs/book/**/*.md
 !site/content/*.md
 apps/game/game.json
 *.tmp

Cargo.toml

@@ -1,6 +1,6 @@
 [workspace]
 members = ["apps/*", "crates/*"]
-exclude = ["site", "template"]
+exclude = ["site", "template", "docs"]
 resolver = "2"
 
 [workspace.package]

README.md

@@ -6,7 +6,7 @@
   <a href="https://github.com/matthewjberger/nightshade"><img alt="github" src="https://img.shields.io/badge/github-matthewjberger/nightshade-8da0cb?style=for-the-badge&labelColor=555555&logo=github" height="20"></a>
   <a href="https://crates.io/crates/nightshade"><img alt="crates.io" src="https://img.shields.io/crates/v/nightshade.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20"></a>
   <a href="https://docs.rs/nightshade"><img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-nightshade-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs" height="20"></a>
-  <a href="https://matthewjberger.github.io/nightshade-book"><img alt="book" src="https://img.shields.io/badge/book-nightshade-blue?style=for-the-badge&labelColor=555555&logo=mdbook" height="20"></a>
+  <a href="https://matthewjberger.github.io/nightshade/book/"><img alt="book" src="https://img.shields.io/badge/book-nightshade-blue?style=for-the-badge&labelColor=555555&logo=mdbook" height="20"></a>
 </p>
 
 `Nightshade` is a data-oriented game engine written in rust 🦀
@@ -16,7 +16,7 @@
 
 ## Documentation
 
-📖 **[Read the Book](https://matthewjberger.github.io/nightshade-book)** - Comprehensive guide covering all engine systems, from getting started to advanced features like SDF sculpting and audio-reactive effects.
+📖 **[Read the Book](https://matthewjberger.github.io/nightshade/book/)** - Comprehensive guide covering all engine systems, from getting started to advanced features like SDF sculpting and audio-reactive effects.
 
 ## Gallery
 

docs/book/README.md

@@ -0,0 +1,28 @@
+# Nightshade Game Engine Documentation
+
+Comprehensive documentation for the [Nightshade](https://github.com/matthewjberger/nightshade) game engine, built with [mdBook](https://rust-lang.github.io/mdBook/).
+
+## Building
+
+Install mdBook:
+
+```bash
+cargo install mdbook
+```
+
+Build and serve locally:
+
+```bash
+mdbook serve --open
+```
+
+## License
+
+Nightshade is free, open source and permissively licensed. All code in this repository is dual-licensed under either:
+
+* MIT License ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+
+at your option.
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in `nightshade` by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

docs/book/book.toml

@@ -0,0 +1,13 @@
+[book]
+authors = ["Matthew J. Berger"]
+language = "en"
+src = "src"
+title = "Nightshade Game Engine"
+
+[rust]
+edition = "2024"
+
+[output.html]
+default-theme = "dark"
+preferred-dark-theme = "ayu"
+mathjax-support = false

docs/book/demos/hello/.gitignore

@@ -0,0 +1,3 @@
+/target
+/dist
+Cargo.lock

docs/book/demos/hello/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "hello-nightshade"
+version = "0.1.0"
+edition = "2024"
+
+[dependencies]
+nightshade = { path = "../../../../crates/nightshade", features = ["egui"] }
+
+[target.'cfg(target_arch = "wasm32")'.dependencies]
+wasm-bindgen = "0.2"
+wasm-bindgen-futures = "0.4"
+
+[profile.release]
+opt-level = "z"
+lto = true

docs/book/demos/hello/Trunk.toml

@@ -0,0 +1,8 @@
+[build]
+target = "index.html"
+dist = "dist"
+
+[serve]
+addresses = ["127.0.0.1"]
+port = 8080
+open = true

docs/book/demos/hello/index.html

@@ -0,0 +1,71 @@
+<!doctype html>
+<html>
+    <head>
+        <meta charset="utf-8" />
+        <meta name="viewport" content="width=device-width, initial-scale=1" />
+        <title>Hello Nightshade</title>
+        <base data-trunk-public-url />
+        <style type="text/css">
+            :focus {
+                outline: none;
+            }
+
+            body,
+            html {
+                margin: 0;
+                padding: 0;
+                width: 100%;
+                height: 100%;
+                overflow: hidden;
+            }
+
+            .root {
+                width: 100%;
+                height: 100%;
+                display: flex;
+                justify-content: center;
+                align-items: center;
+            }
+
+            .main-canvas {
+                display: block;
+                width: 100%;
+                height: 100%;
+            }
+        </style>
+    </head>
+
+    <body>
+        <script>
+            window.addEventListener('error', function(e) {
+                if (e.message && e.message.includes('message channel closed')) {
+                    e.preventDefault();
+                }
+            });
+            window.addEventListener('unhandledrejection', function(e) {
+                if (e.reason && e.reason.message && e.reason.message.includes('message channel closed')) {
+                    e.preventDefault();
+                }
+            });
+        </script>
+        <link data-trunk rel="rust" href="Cargo.toml" data-target-name="hello-nightshade" />
+        <div class="root">
+            <canvas class="main-canvas" id="canvas"></canvas>
+        </div>
+        <script>
+            function resizeCanvas() {
+                const canvas = document.getElementById("canvas");
+                const dpr = window.devicePixelRatio || 1;
+                const width = window.innerWidth;
+                const height = window.innerHeight;
+
+                canvas.width = Math.round(width * dpr);
+                canvas.height = Math.round(height * dpr);
+                canvas.style.width = width + "px";
+                canvas.style.height = height + "px";
+            }
+            resizeCanvas();
+            window.addEventListener("resize", resizeCanvas);
+        </script>
+    </body>
+</html>