@hagicode/hagilight-docusaurus 0.9.1 → 0.9.2-dev.102.1.daf22c1

package/README.md

@@ -71,6 +71,12 @@ An analytics object enables its provider when it contains an ID. Set `enabled` e
 - `seo.organization.url` and `seo.organization.logo` must be absolute HTTP(S) URLs.
 - The Organization and WebSite JSON-LD is still emitted when a site replaces `SiteMetadata`.
 
+## Build line
+
+The Hagilight footer shows `Branch:`, `Commit:`, and `Built:` after the attribution. The values are resolved from the site directory: `HAGILIGHT_BUILD_BRANCH` and `HAGILIGHT_BUILD_COMMIT`, then Git, then `unknown`; the core README gives the order. The line belongs to the Hagilight footer, so it is absent when `footer` is disabled. For a detached-HEAD CI checkout, set `HAGILIGHT_BUILD_BRANCH` in the build step as shown in the Astro README.
+
+Docusaurus evaluates the plugin again for each locale it builds, so each locale resolves its own `Built:` time. Pages within one locale share that time, but two locales built in the same run can differ by a few seconds.
+
 ## Locale catalog
 
 `@hagicode/hagilight-docusaurus/locales` exports the locale table used by the plugin:

package/dist/client/promoto.js

@@ -1,4 +1,4 @@
-import { definePromotoBannerElement } from '@hagicode/hagilight-core/promoto-banner';
+import { definePromotoBannerElement, recordSiteVisit } from '@hagicode/hagilight-core/promoto-banner';
 import { PROMOTO_SHELL_MARKUP } from './promoto-markup.js';
 const ELEMENT_NAME = 'hagilight-promoto-banner';
 const DEFAULT_LOCALE = 'en-US';
@@ -20,4 +20,5 @@ export function mountPromotoBanner(doc, locale) {
 export function onRouteDidUpdate() {
     definePromotoBannerElement();
     mountPromotoBanner(document, document.documentElement.lang || DEFAULT_LOCALE);
+    recordSiteVisit();
 }

package/dist/global-data.d.ts

@@ -1,8 +1,10 @@
 import type { LoadContext } from '@docusaurus/types';
+import type { BuildInfo } from '@hagicode/hagilight-core/build-info';
 import type { ResolvedHagilightOptions } from './options.js';
 export declare const PLUGIN_NAME = "@hagicode/hagilight-docusaurus";
 export interface HagilightGlobalData {
     version: string;
     options: ResolvedHagilightOptions;
     i18n: LoadContext['i18n'];
+    buildInfo: BuildInfo;
 }

package/dist/index.js

@@ -1,5 +1,6 @@
 import { readFileSync } from 'node:fs';
 import { fileURLToPath } from 'node:url';
+import { resolveBuildInfo } from '@hagicode/hagilight-core/build-info-resolver';
 import { fiftyOneLaHeadTags, googleAnalyticsHeadTags } from './analytics.js';
 import { collectFeedItems, feedHeadTags, writeDiscoveryOutputs } from './discovery.js';
 import { PLUGIN_NAME } from './global-data.js';
@@ -35,6 +36,7 @@ function createPlugin(context, options) {
         version: PACKAGE_VERSION,
         options,
         i18n: context.i18n,
+        buildInfo: resolveBuildInfo({ root: context.siteDir }),
     };
     const themeEnabled = options.footer || options.seo.enabled;
     const site = {

package/dist/theme/Footer/FooterView.d.ts

@@ -1,8 +1,10 @@
-import type { ReactElement } from 'react';
+import { type ReactElement } from 'react';
+import { type BuildInfo } from '@hagicode/hagilight-core/build-info';
 import type { FooterLinks } from '../../footer.js';
 export interface FooterViewProps {
     links: FooterLinks;
     version: string;
     year: number;
+    buildInfo?: BuildInfo;
 }
-export declare function FooterView({ links, version, year }: FooterViewProps): ReactElement;
+export declare function FooterView({ links, version, year, buildInfo }: FooterViewProps): ReactElement;

package/dist/theme/Footer/FooterView.js

@@ -1,9 +1,12 @@
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { Fragment } from 'react';
 import { siteLinkGaAttributes } from '@hagicode/hagilight-core/analytics-events';
+import { buildInfoItems } from '@hagicode/hagilight-core/build-info';
 function LinkSection({ heading, navLabel, links, tagged }) {
     return (_jsxs("section", { children: [_jsx("h2", { children: heading }), _jsx("nav", { "aria-label": navLabel, children: _jsx("ul", { children: links.map((link) => (_jsx("li", { children: _jsx("a", { href: link.href, target: link.target, rel: link.rel, "aria-label": link.ariaLabel, ...(tagged ? siteLinkGaAttributes(link, 'footer') : {}), children: link.label }) }, link.id))) }) })] }));
 }
-export function FooterView({ links, version, year }) {
+export function FooterView({ links, version, year, buildInfo }) {
     const { labels } = links;
-    return (_jsxs("footer", { className: "hagilight-footer", children: [_jsxs("div", { className: "hagilight-footer__sections", children: [links.relatedSites.length > 0 && (_jsxs("section", { children: [_jsx("h2", { children: labels.relatedSites }), _jsx("nav", { "aria-label": labels.navigation.relatedSites, children: _jsx("ul", { children: links.relatedSites.map((site) => (_jsx("li", { children: _jsx("a", { href: site.href, target: site.target, rel: site.rel, children: site.name }) }, site.id))) }) })] })), _jsx(LinkSection, { heading: labels.quickLinks, navLabel: labels.navigation.quickLinks, links: links.quick, tagged: true }), _jsx(LinkSection, { heading: labels.community, navLabel: labels.navigation.community, links: links.community, tagged: true })] }), links.filings.length > 0 && (_jsx("nav", { className: "hagilight-footer__filings", "aria-label": labels.navigation.filings, children: links.filings.map((link) => (_jsx("a", { href: link.href, target: link.target, rel: link.rel, "aria-label": link.ariaLabel, children: link.label }, link.id))) })), _jsxs("p", { className: "hagilight-footer__copyright", children: [_jsxs("span", { children: ["\u00A9 ", year, " HagiCode"] }), ' | ', _jsxs("span", { className: "hagilight-footer__attribution", children: ["Powered By hagilight-docusaurus@", version] })] })] }));
+    const buildItems = buildInfoItems(buildInfo);
+    return (_jsxs("footer", { className: "hagilight-footer", children: [_jsxs("div", { className: "hagilight-footer__sections", children: [links.relatedSites.length > 0 && (_jsxs("section", { children: [_jsx("h2", { children: labels.relatedSites }), _jsx("nav", { "aria-label": labels.navigation.relatedSites, children: _jsx("ul", { children: links.relatedSites.map((site) => (_jsx("li", { children: _jsx("a", { href: site.href, target: site.target, rel: site.rel, children: site.name }) }, site.id))) }) })] })), _jsx(LinkSection, { heading: labels.quickLinks, navLabel: labels.navigation.quickLinks, links: links.quick, tagged: true }), _jsx(LinkSection, { heading: labels.community, navLabel: labels.navigation.community, links: links.community, tagged: true })] }), links.filings.length > 0 && (_jsx("nav", { className: "hagilight-footer__filings", "aria-label": labels.navigation.filings, children: links.filings.map((link) => (_jsx("a", { href: link.href, target: link.target, rel: link.rel, "aria-label": link.ariaLabel, children: link.label }, link.id))) })), _jsxs("p", { className: "hagilight-footer__copyright", children: [_jsxs("span", { children: ["\u00A9 ", year, " HagiCode"] }), ' | ', _jsxs("span", { className: "hagilight-footer__attribution", children: ["Powered By hagilight-docusaurus@", version] }), buildItems.map((item) => (_jsxs(Fragment, { children: [' | ', _jsxs("span", { className: "hagilight-footer__build", "data-build-field": item.field, title: item.title, "data-build-commit": item.title, children: [item.label, ": ", item.datetime ? _jsx("time", { dateTime: item.datetime, children: item.text }) : item.text] })] }, item.field)))] })] }));
 }

package/dist/theme/Footer/index.js

@@ -7,7 +7,7 @@ import { PLUGIN_NAME } from '../../global-data.js';
 import { FooterView } from './FooterView.js';
 export default function Footer() {
     const { i18n, siteConfig } = useDocusaurusContext();
-    const { version, options } = usePluginData(PLUGIN_NAME);
+    const { version, options, buildInfo } = usePluginData(PLUGIN_NAME);
     if (!options.footer)
         return _jsx(FooterDefaults, {});
     const links = resolveFooterLinks({
@@ -16,5 +16,5 @@ export default function Footer() {
         links: options.links,
         rssEnabled: options.rss.enabled,
     });
-    return _jsx(FooterView, { links: links, version: version, year: new Date().getFullYear() });
+    return (_jsx(FooterView, { links: links, version: version, year: new Date().getFullYear(), buildInfo: buildInfo }));
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hagicode/hagilight-docusaurus",
-  "version": "0.9.1",
+  "version": "0.9.2-dev.102.1.daf22c1",
   "type": "module",
   "description": "Docusaurus plugin for HagiCode site features: footer, analytics, promote card, locales, SEO, sitemap, robots.txt, and RSS",
   "repository": {
@@ -38,7 +38,7 @@
   ],
   "dependencies": {
     "@docusaurus/types": "^3.9.2",
-    "@hagicode/hagilight-core": "0.9.1"
+    "@hagicode/hagilight-core": "0.9.2-dev.102.1.daf22c1"
   },
   "peerDependencies": {
     "@docusaurus/core": "^3.9.2",

package/promoto.css

@@ -39,7 +39,8 @@
   transition: opacity 0.24s ease, visibility 0s linear;
 }
 
-.hagilight-promoto[data-state='footer-hidden'] .hagilight-promoto__shell {
+.hagilight-promoto[data-state='footer-hidden'] .hagilight-promoto__shell,
+.hagilight-promoto[data-state='top-hidden'] .hagilight-promoto__shell {
   opacity: 0;
   visibility: hidden;
   pointer-events: none;

package/styles.css

@@ -70,6 +70,10 @@
   overflow-wrap: anywhere;
 }
 
+.hagilight-footer__build {
+  overflow-wrap: anywhere;
+}
+
 @media (max-width: 40rem) {
   .hagilight-footer__sections {
     grid-template-columns: 1fr;