feat(examples): add rust-doc example

Author: ReenigneArcher

.gitignore

@@ -12,4 +12,5 @@ coverage/
 _readthedocs/
 build/
 dist/
+target/
 lizardbyte-shared-web*.tgz

.readthedocs.yaml

@@ -6,6 +6,7 @@ build:
     nodejs: "22"
     python: "3.13"
     ruby: "3.3"
+    rust: "1.91"
   commands:
     - 'echo "output directory: ${READTHEDOCS_OUTPUT}html"'
     # shared-web build
@@ -26,5 +27,8 @@ build:
     - cd examples/sphinx && npm ci  # we need to include scripts for postinstall actions
     - cd examples/sphinx && npm run build
     - cd examples/sphinx && npm run lint
+    # rustdoc example build
+    - cd examples/rustdoc && npm ci --ignore-scripts
+    - cd examples/rustdoc && npm run build
     # debug output
     - cd ${READTHEDOCS_OUTPUT}html && ls -la -R

eslint.config.mjs

@@ -9,6 +9,7 @@ export default [
         "coverage/**",
         "dist/**",
         "docs/**", // generated JSDoc output
+        "examples/**/build/**", // generated example output
     ],
   },
   {

examples/rustdoc/.cargo/config.toml

@@ -0,0 +1,5 @@
+[build]
+rustdocflags = [
+    "--html-after-content",
+    "rustdoc/shared-web.html",
+]

examples/rustdoc/Cargo.lock

@@ -0,0 +1,15 @@
+[package]
+name = "shared-web-rustdoc-example"
+version = "0.0.0"
+edition = "2021"
+description = "Example use of @lizardbyte/shared-web in rustdoc html."
+license = "AGPL-3.0-only"
+publish = false
+exclude = [
+    "build",
+    "node_modules",
+]
+
+[lib]
+name = "shared_web_rustdoc_example"
+path = "src/lib.rs"

examples/rustdoc/Cargo.toml

@@ -0,0 +1,11 @@
+{
+  "name": "shared-web-rustdoc-example",
+  "version": "0.0.0",
+  "description": "Example use of @lizardbyte/shared-web in rustdoc html.",
+  "dependencies": {
+    "@lizardbyte/shared-web": "file:../.."
+  },
+  "scripts": {
+    "build": "node rustdoc/build.js"
+  }
+}

examples/rustdoc/package-lock.json

@@ -0,0 +1,28 @@
+const fs = require('node:fs');
+const path = require('node:path');
+const { spawnSync } = require('node:child_process');
+
+const exampleDir = path.resolve(__dirname, '..');
+const readTheDocsOutput = process.env.READTHEDOCS_OUTPUT ?
+    path.resolve(process.env.READTHEDOCS_OUTPUT) :
+    path.join(exampleDir, 'build');
+const targetDir = path.join(readTheDocsOutput, 'html', 'rustdoc');
+const docDir = path.join(targetDir, 'doc');
+const sharedWebDist = path.join(exampleDir, 'node_modules', '@lizardbyte', 'shared-web', 'dist');
+
+const cargoResult = spawnSync('cargo', ['doc', '--no-deps', '--target-dir', targetDir], {
+    stdio: 'inherit',
+});
+
+if (cargoResult.status !== 0) {
+    process.exit(cargoResult.status || 1);
+}
+
+fs.mkdirSync(docDir, { recursive: true });
+
+[
+    'crowdin.js',
+    'crowdin-rustdoc-css.css',
+].forEach((asset) => {
+    fs.copyFileSync(path.join(sharedWebDist, asset), path.join(docDir, asset));
+});

examples/rustdoc/package.json

@@ -0,0 +1,20 @@
+<!--LIZARDBYTE/SHARED-WEB START-->
+<script>
+(function() {
+    const rustdocVars = document.querySelector('meta[name="rustdoc-vars"]');
+    const rootPath = rustdocVars ? rustdocVars.dataset.rootPath : '';
+
+    const stylesheet = document.createElement('link');
+    stylesheet.rel = 'stylesheet';
+    stylesheet.href = rootPath + 'crowdin-rustdoc-css.css';
+    document.head.appendChild(stylesheet);
+
+    const crowdin = document.createElement('script');
+    crowdin.src = rootPath + 'crowdin.js';
+    crowdin.onload = function() {
+        globalThis.initCrowdIn('LizardByte-docs', 'rustdoc');
+    };
+    document.head.appendChild(crowdin);
+}());
+</script>
+<!--LIZARDBYTE/SHARED-WEB END-->