@vantagecompute/docusaurus-theme 0.2.3 → 0.4.1

package/lib/index.cjs

@@ -5,7 +5,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.rehypeTabsTransform = exports.staticDir = void 0;
 exports.default = themeVantage;
+exports.getProjectVersion = getProjectVersion;
 const node_path_1 = __importDefault(require("node:path"));
+const node_child_process_1 = require("node:child_process");
 function themeVantage() {
     return {
         name: '@vantagecompute/docusaurus-theme',
@@ -32,6 +34,23 @@ function themeVantage() {
  * ```
  */
 exports.staticDir = node_path_1.default.resolve(__dirname, '../static');
+/**
+ * Infer the project version from git tags via `git describe --tags --always`.
+ * Returns a string like "v0.3.1" (on a tag) or "v0.3.1-3-gabcdef" (between tags).
+ * Falls back to "dev" if git is unavailable or no tags exist.
+ */
+function getProjectVersion() {
+    try {
+        const version = (0, node_child_process_1.execSync)('git describe --tags --always', {
+            encoding: 'utf8',
+            stdio: ['pipe', 'pipe', 'pipe'],
+        }).trim();
+        return version;
+    }
+    catch {
+        return 'dev';
+    }
+}
 // Re-export the rehype utility (plain JS, lives in src/utils/)
 exports.rehypeTabsTransform = require(node_path_1.default.resolve(__dirname, '../src/utils/rehypeTabsTransform'));
 //# sourceMappingURL=index.cjs.map

package/lib/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.cts"],"names":[],"mappings":";;;;;;;AAAA,0DAA6B;AAG7B;IACE,OAAO;QACL,IAAI,EAAE,kCAAkC;QAExC,YAAY;YACV,OAAO,mBAAI,CAAC,OAAO,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;QACjD,CAAC;QAED,eAAe;YACb,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,SAAS,EAAE,uCAAuC,CAAC,CAAC,CAAC;QAC5E,CAAC;QAED,gBAAgB;YACd,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,SAAS,EAAE,uBAAuB,CAAC,CAAC,CAAC;QAC5D,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACU,QAAA,SAAS,GAAG,mBAAI,CAAC,OAAO,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;AAE9D,+DAA+D;AAClD,QAAA,mBAAmB,GAAG,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,SAAS,EAAE,kCAAkC,CAAC,CAAC,CAAC"}
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.cts"],"names":[],"mappings":";;;;;;;;AAAA,0DAA6B;AAC7B,2DAA8C;AAG9C;IACE,OAAO;QACL,IAAI,EAAE,kCAAkC;QAExC,YAAY;YACV,OAAO,mBAAI,CAAC,OAAO,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;QACjD,CAAC;QAED,eAAe;YACb,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,SAAS,EAAE,uCAAuC,CAAC,CAAC,CAAC;QAC5E,CAAC;QAED,gBAAgB;YACd,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,SAAS,EAAE,uBAAuB,CAAC,CAAC,CAAC;QAC5D,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACU,QAAA,SAAS,GAAG,mBAAI,CAAC,OAAO,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;AAE9D;;;;GAIG;AACH;IACE,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,IAAA,6BAAQ,EAAC,8BAA8B,EAAE;YACvD,QAAQ,EAAE,MAAM;YAChB,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;SAChC,CAAC,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,OAAO,CAAC;IACjB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,+DAA+D;AAClD,QAAA,mBAAmB,GAAG,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,SAAS,EAAE,kCAAkC,CAAC,CAAC,CAAC"}

package/lib/index.d.cts

@@ -12,5 +12,11 @@ export default function themeVantage(): Plugin;
  * ```
  */
 export declare const staticDir: string;
+/**
+ * Infer the project version from git tags via `git describe --tags --always`.
+ * Returns a string like "v0.3.1" (on a tag) or "v0.3.1-3-gabcdef" (between tags).
+ * Falls back to "dev" if git is unavailable or no tags exist.
+ */
+export declare function getProjectVersion(): string;
 export declare const rehypeTabsTransform: any;
 //# sourceMappingURL=index.d.cts.map

package/lib/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.cts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAEhD,MAAM,CAAC,OAAO,UAAU,YAAY,IAAI,MAAM,CAgB7C;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS,QAAuC,CAAC;AAG9D,eAAO,MAAM,mBAAmB,KAAuE,CAAC"}
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.cts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAEhD,MAAM,CAAC,OAAO,UAAU,YAAY,IAAI,MAAM,CAgB7C;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS,QAAuC,CAAC;AAE9D;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,MAAM,CAU1C;AAGD,eAAO,MAAM,mBAAmB,KAAuE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vantagecompute/docusaurus-theme",
-  "version": "0.2.3",
+  "version": "0.4.1",
   "description": "Shared Vantage Compute Docusaurus theme — design system, brand assets, and common theme overrides for all vantagecompute documentation sites.",
   "license": "MIT",
   "main": "lib/index.cjs",

package/src/css/custom.css

@@ -1881,6 +1881,23 @@ article {
 }
 
 
+/* ── Navbar version badge ──────────────────────────────────────────── */
+.navbar__brand-with-version {
+  display: flex;
+  align-items: center;
+  gap: 0;
+}
+
+.navbar__version-badge {
+  font-size: 0.7rem;
+  font-weight: 500;
+  opacity: 0.55;
+  color: var(--vantage-navbar-text);
+  white-space: nowrap;
+  letter-spacing: 0.01em;
+  padding-left: 6px;
+}
+
 /* Chat sidebar  -  push layout (navbar excluded) */
 .main-wrapper {
   transition: margin-right 0.3s ease-in-out;

package/src/index.cts

@@ -1,4 +1,5 @@
 import path from 'node:path';
+import { execSync } from 'node:child_process';
 import type { Plugin } from '@docusaurus/types';
 
 export default function themeVantage(): Plugin {
@@ -32,5 +33,22 @@ export default function themeVantage(): Plugin {
  */
 export const staticDir = path.resolve(__dirname, '../static');
 
+/**
+ * Infer the project version from git tags via `git describe --tags --always`.
+ * Returns a string like "v0.3.1" (on a tag) or "v0.3.1-3-gabcdef" (between tags).
+ * Falls back to "dev" if git is unavailable or no tags exist.
+ */
+export function getProjectVersion(): string {
+  try {
+    const version = execSync('git describe --tags --always', {
+      encoding: 'utf8',
+      stdio: ['pipe', 'pipe', 'pipe'],
+    }).trim();
+    return version;
+  } catch {
+    return 'dev';
+  }
+}
+
 // Re-export the rehype utility (plain JS, lives in src/utils/)
 export const rehypeTabsTransform = require(path.resolve(__dirname, '../src/utils/rehypeTabsTransform'));

package/src/theme/Navbar/Logo/index.jsx

@@ -0,0 +1,19 @@
+import React from 'react';
+import Logo from '@theme-original/Navbar/Logo';
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+
+export default function LogoWrapper(props) {
+  const {siteConfig} = useDocusaurusContext();
+  const version = siteConfig.customFields?.projectVersion;
+
+  return (
+    <div className="navbar__brand-with-version">
+      <Logo {...props} />
+      {version && (
+        <span className="navbar__version-badge">
+          {String(version).startsWith('v') ? version : `v${version}`}
+        </span>
+      )}
+    </div>
+  );
+}