docula 2.1.0 → 2.2.0

package/dist/docula.d.ts

@@ -202,6 +202,7 @@ type DoculaData = {
   }>;
   googleTagManager?: string;
   isGtag?: boolean;
+  googleTagManagerParams?: string;
   enableLlmsTxt?: boolean;
   enableSearch?: boolean;
   hasFeed?: boolean;
@@ -426,6 +427,16 @@ declare class DoculaOptions {
    * When set, injects the appropriate tracking script on every page.
    */
   googleTagManager?: string;
+  /**
+   * Google Tag Manager environment auth token (gtm_auth). Only applies to
+   * GTM container IDs; requires `googleTagManagerEnv` to also be set.
+   */
+  googleTagManagerAuth?: string;
+  /**
+   * Google Tag Manager environment name (gtm_preview), e.g., "env-3". Only
+   * applies to GTM container IDs; requires `googleTagManagerAuth` to also be set.
+   */
+  googleTagManagerEnv?: string;
   /**
    * AI-powered metadata enrichment configuration. When set, uses AI to fill
    * missing OpenGraph and HTML meta tag fields during the build.

package/dist/docula.js

@@ -17,7 +17,7 @@ import { CacheableNet } from "@cacheable/net";
 import os from "node:os";
 import sea from "node:sea";
 //#region package.json
-var version = "2.1.0";
+var version = "2.2.0";
 var package_default = {
 	name: "docula",
 	version,
@@ -731,6 +731,25 @@ function summarizeMarkdown(markdown, maxLength = 240) {
 function isRemoteUrl(url) {
 	return /^https?:\/\//i.test(url);
 }
+/**
+* Encode a value for use in a URL query string. Unlike `encodeURIComponent`,
+* this also escapes single quotes, so the result is safe to inject into a
+* single-quoted JavaScript string literal (e.g., inline template scripts)
+* where a raw quote would break the string.
+*/
+function encodeQueryStringValue(value) {
+	return encodeURIComponent(value).replace(/'/g, "%27");
+}
+/**
+* Build the extra query string appended to Google Tag Manager URLs when
+* targeting a GTM environment. A GTM environment is identified by both an
+* auth token and an environment name, so this returns `undefined` unless
+* both are set.
+*/
+function buildGtmEnvironmentParams(auth, env) {
+	if (!auth || !env) return;
+	return `&gtm_auth=${encodeQueryStringValue(auth)}&gtm_preview=${encodeQueryStringValue(env)}&gtm_cookies_win=x`;
+}
 //#endregion
 //#region src/builder-seo.ts
 const writrOptions$5 = {
@@ -1437,7 +1456,9 @@ function hashOptions(hash, options) {
 		apiPath: options.apiPath,
 		changelogPath: options.changelogPath,
 		ai: options.ai,
-		googleTagManager: options.googleTagManager
+		googleTagManager: options.googleTagManager,
+		googleTagManagerAuth: options.googleTagManagerAuth,
+		googleTagManagerEnv: options.googleTagManagerEnv
 	};
 	const optionsHash = hash.toHashSync(JSON.stringify(relevant));
 	const configHash = hashConfigFile(hash, options.sitePath);
@@ -3041,6 +3062,16 @@ var DoculaOptions = class {
 	*/
 	googleTagManager;
 	/**
+	* Google Tag Manager environment auth token (gtm_auth). Only applies to
+	* GTM container IDs; requires `googleTagManagerEnv` to also be set.
+	*/
+	googleTagManagerAuth;
+	/**
+	* Google Tag Manager environment name (gtm_preview), e.g., "env-3". Only
+	* applies to GTM container IDs; requires `googleTagManagerAuth` to also be set.
+	*/
+	googleTagManagerEnv;
+	/**
 	* AI-powered metadata enrichment configuration. When set, uses AI to fill
 	* missing OpenGraph and HTML meta tag fields during the build.
 	* Requires provider name and API key. Omit to disable AI enrichment.
@@ -3131,6 +3162,8 @@ var DoculaOptions = class {
 		if (options.autoReadme !== void 0 && typeof options.autoReadme === "boolean") this.autoReadme = options.autoReadme;
 		if (options.quiet !== void 0 && typeof options.quiet === "boolean") this.quiet = options.quiet;
 		if (options.googleTagManager !== void 0 && typeof options.googleTagManager === "string" && /^G[A-Z]*-[A-Z0-9]+$/i.test(options.googleTagManager)) this.googleTagManager = options.googleTagManager;
+		if (options.googleTagManagerAuth !== void 0 && typeof options.googleTagManagerAuth === "string" && options.googleTagManagerAuth.length > 0) this.googleTagManagerAuth = options.googleTagManagerAuth;
+		if (options.googleTagManagerEnv !== void 0 && typeof options.googleTagManagerEnv === "string" && options.googleTagManagerEnv.length > 0) this.googleTagManagerEnv = options.googleTagManagerEnv;
 		if (options.ai && typeof options.ai === "object" && typeof options.ai.provider === "string" && typeof options.ai.apiKey === "string") this.ai = options.ai;
 		if (options.cache && typeof options.cache === "object" && options.cache.github !== null && typeof options.cache.github === "object" && typeof options.cache.github.ttl === "number") this.cache = options.cache;
 		if (options.homeUrl !== void 0 && typeof options.homeUrl === "string") this.homeUrl = options.homeUrl === "/" ? "/" : trimTrailingSlashes(options.homeUrl);
@@ -3272,6 +3305,7 @@ var DoculaBuilder = class {
 			headerLinks: this.options.headerLinks,
 			googleTagManager: this.options.googleTagManager,
 			isGtag: this.options.googleTagManager?.startsWith("G-") ?? false,
+			googleTagManagerParams: buildGtmEnvironmentParams(this.options.googleTagManagerAuth, this.options.googleTagManagerEnv),
 			enableLlmsTxt: this.options.enableLlmsTxt,
 			homeUrl: this.options.homeUrl,
 			baseUrl: this.options.baseUrl,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docula",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Beautiful Website for Your Projects",
   "type": "module",
   "main": "./dist/docula.js",

package/templates/classic/includes/body-scripts.hbs

@@ -1,7 +1,7 @@
 {{#if googleTagManager}}
 {{#unless isGtag}}
 <!-- Google Tag Manager (noscript) -->
-<noscript><iframe src="https://www.googletagmanager.com/ns.html?id={{googleTagManager}}"
+<noscript><iframe src="https://www.googletagmanager.com/ns.html?id={{googleTagManager}}{{{googleTagManagerParams}}}"
 height="0" width="0" style="display:none !important;visibility:hidden !important"></iframe></noscript>
 <!-- End Google Tag Manager (noscript) -->
 {{/unless}}

package/templates/classic/includes/header.hbs

@@ -8,7 +8,7 @@
 <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
 new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
 j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
-'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+'https://www.googletagmanager.com/gtm.js?id='+i+dl+'{{{googleTagManagerParams}}}';f.parentNode.insertBefore(j,f);
 })(window,document,'script','dataLayer','{{googleTagManager}}');</script>
 <!-- End Google Tag Manager -->
 {{/if}}

package/templates/modern/includes/body-scripts.hbs

@@ -1,7 +1,7 @@
 {{#if googleTagManager}}
 {{#unless isGtag}}
 <!-- Google Tag Manager (noscript) -->
-<noscript><iframe src="https://www.googletagmanager.com/ns.html?id={{googleTagManager}}"
+<noscript><iframe src="https://www.googletagmanager.com/ns.html?id={{googleTagManager}}{{{googleTagManagerParams}}}"
 height="0" width="0" style="display:none !important;visibility:hidden !important"></iframe></noscript>
 <!-- End Google Tag Manager (noscript) -->
 {{/unless}}

package/templates/modern/includes/header.hbs

@@ -8,7 +8,7 @@
 <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
 new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
 j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
-'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+'https://www.googletagmanager.com/gtm.js?id='+i+dl+'{{{googleTagManagerParams}}}';f.parentNode.insertBefore(j,f);
 })(window,document,'script','dataLayer','{{googleTagManager}}');</script>
 <!-- End Google Tag Manager -->
 {{/if}}

package/templates/modern/includes/scripts.hbs

@@ -265,23 +265,34 @@
       });
     }
 
-    // Active header nav link highlighting
-    const navLinks = document.querySelectorAll('.header-bottom__item');
-    navLinks.forEach((link) => {
-      const href = link.getAttribute('href');
-      if (currentPath.startsWith(href)) {
-        link.classList.add('header-bottom__item--active');
-      }
-    });
-
-    // Active mobile nav link highlighting
-    const mobileNavLinks = document.querySelectorAll('.mobile-nav__item');
-    mobileNavLinks.forEach((link) => {
-      const href = link.getAttribute('href');
-      if (currentPath.startsWith(href)) {
-        link.classList.add('mobile-nav__item--active');
-      }
-    });
+    // Active nav link highlighting (header + mobile). Highlight only the
+    // single most-specific link: the one whose path is the longest prefix of
+    // the current path. A plain startsWith() check lights up every link whose
+    // path merely prefixes the current one, so when the site is embedded under
+    // a base path (e.g. served at /developer with docs at that root) the
+    // Documentation link — whose path is a prefix of every page — would stay
+    // highlighted everywhere. Trailing slashes are normalized so matches stop
+    // at a path boundary. We read the anchor's resolved origin/pathname so
+    // absolute, relative, and same-origin hrefs all work, while cross-origin
+    // links and non-anchor items (e.g. the mobile logout button) are skipped.
+    const withTrailingSlash = (p) => (p.endsWith('/') ? p : p + '/');
+    const here = withTrailingSlash(currentPath);
+    const markActiveNav = (selector, activeClass) => {
+      let bestLink = null;
+      let bestLength = -1;
+      document.querySelectorAll(selector).forEach((link) => {
+        // Only same-origin anchors can match the current pathname.
+        if (!link.href || link.origin !== window.location.origin) return;
+        const base = withTrailingSlash(link.pathname);
+        if (here.startsWith(base) && base.length > bestLength) {
+          bestLink = link;
+          bestLength = base.length;
+        }
+      });
+      if (bestLink) bestLink.classList.add(activeClass);
+    };
+    markActiveNav('.header-bottom__item', 'header-bottom__item--active');
+    markActiveNav('.mobile-nav__item', 'mobile-nav__item--active');
 
     // TOC extraction: move the inline TOC into the right sidebar and hide the original
     const tocHeading = document.getElementById('table-of-contents');