@hagicode/hagilight-starlight 0.2.0 → 0.2.1-dev.13.1.46152fe

package/ArticlePromotion.astro

@@ -0,0 +1,52 @@
+---
+import { getArticlePromotionCopy } from './article-promotion.mjs';
+
+const { lang } = Astro.props;
+const copy = getArticlePromotionCopy(lang);
+---
+
+<aside class="hagilight-article-promotion" aria-labelledby="hagilight-article-promotion-title">
+  <h2 id="hagilight-article-promotion-title">{copy.title}</h2>
+  <p>{copy.description}</p>
+  <a href="https://www.hagicode.com/">{copy.link}</a>
+</aside>
+
+<style>
+  .hagilight-article-promotion {
+    margin-block: 2.5rem;
+    padding: 1.25rem;
+    border: 1px solid var(--sl-color-gray-5);
+    border-radius: 0.75rem;
+    background: var(--sl-color-bg-nav);
+    color: var(--sl-color-text);
+  }
+
+  .hagilight-article-promotion h2 {
+    margin: 0;
+    font-size: var(--sl-text-h3);
+  }
+
+  .hagilight-article-promotion p {
+    margin-block: 0.75rem;
+  }
+
+  .hagilight-article-promotion a {
+    display: inline-block;
+    color: var(--sl-color-accent-high);
+    font-weight: 600;
+    text-decoration: underline;
+    text-underline-offset: 0.15em;
+  }
+
+  .hagilight-article-promotion a:focus-visible {
+    outline: 2px solid var(--sl-color-accent-high);
+    outline-offset: 3px;
+    border-radius: 2px;
+  }
+
+  @media (min-width: 40rem) {
+    .hagilight-article-promotion {
+      padding: 1.5rem 2rem;
+    }
+  }
+</style>

package/MarkdownContent.astro

@@ -1,19 +1,26 @@
 ---
 import { getCollection } from 'astro:content';
 import DefaultMarkdownContent from '@astrojs/starlight/components/MarkdownContent.astro';
+import ArticlePromotion from './ArticlePromotion.astro';
 import AIDisclosureNotice from './AIDisclosureNotice.astro';
 import {
   getSourcePath,
   isTranslationLocale,
   resolveAIDisclosureFlags,
 } from './ai-disclosures.mjs';
+import { resolveArticlePromotion } from './article-promotion.mjs';
 
-const { aiDisclosures = { isAITranslation: false, isAIAuthor: false, sourceLocale: 'root' } } = Astro.props;
+const {
+  aiDisclosures = { isAITranslation: false, isAIAuthor: false, sourceLocale: 'root' },
+  hagicodePromotionEnabled = true,
+} = Astro.props;
 const route = Astro.locals.starlightRoute;
 const isDocsEntry = route.entry.id !== '404' && !route.entry.id.endsWith('/404');
 const flags = isDocsEntry
   ? resolveAIDisclosureFlags(route.entry.data, aiDisclosures)
   : { isAITranslation: false, isAIAuthor: false };
+const showHagicodePromotion = isDocsEntry
+  && resolveArticlePromotion(route.entry.data.hagicodePromotion, hagicodePromotionEnabled);
 const showTranslation = flags.isAITranslation
   && isTranslationLocale(route.entryMeta.locale, aiDisclosures.sourceLocale);
 let sourceHref;
@@ -34,3 +41,4 @@ if (showTranslation) {
 {flags.isAIAuthor && <AIDisclosureNotice kind="author" lang={route.lang} />}
 <DefaultMarkdownContent><slot /></DefaultMarkdownContent>
 {showTranslation && <AIDisclosureNotice kind="translation" lang={route.lang} sourceHref={sourceHref} />}
+{showHagicodePromotion && <ArticlePromotion lang={route.lang} />}

package/article-promotion-schema.mjs

@@ -0,0 +1,8 @@
+import { z } from 'astro/zod';
+
+const articlePromotionSchema = z.object({
+  hagicodePromotion: z.boolean().optional(),
+});
+
+export { articlePromotionSchema };
+export default articlePromotionSchema;

package/article-promotion.mjs

@@ -0,0 +1,69 @@
+const COPY = {
+  'de-DE': {
+    title: 'Über HagiCode',
+    description: 'HagiCode entwickelt Werkzeuge und eine Community für Menschen, die gemeinsam Software bauen.',
+    link: 'HagiCode besuchen',
+  },
+  'en-US': {
+    title: 'About HagiCode',
+    description: 'HagiCode builds tools and a community for people creating software together.',
+    link: 'Visit HagiCode',
+  },
+  'es-ES': {
+    title: 'Acerca de HagiCode',
+    description: 'HagiCode crea herramientas y una comunidad para quienes desarrollan software en equipo.',
+    link: 'Visitar HagiCode',
+  },
+  'fr-FR': {
+    title: 'À propos de HagiCode',
+    description: 'HagiCode crée des outils et une communauté pour les personnes qui développent des logiciels ensemble.',
+    link: 'Découvrir HagiCode',
+  },
+  'ja-JP': {
+    title: 'HagiCodeについて',
+    description: 'HagiCodeは、ソフトウェアを共につくる人々のためのツールとコミュニティを提供します。',
+    link: 'HagiCodeを見る',
+  },
+  'ko-KR': {
+    title: 'HagiCode 소개',
+    description: 'HagiCode는 함께 소프트웨어를 만드는 사람들을 위한 도구와 커뮤니티를 만듭니다.',
+    link: 'HagiCode 방문하기',
+  },
+  'pt-BR': {
+    title: 'Sobre a HagiCode',
+    description: 'A HagiCode cria ferramentas e uma comunidade para pessoas que desenvolvem software em conjunto.',
+    link: 'Visite a HagiCode',
+  },
+  'ru-RU': {
+    title: 'О HagiCode',
+    description: 'HagiCode создаёт инструменты и сообщество для тех, кто вместе разрабатывает программное обеспечение.',
+    link: 'Посетить HagiCode',
+  },
+  'zh-CN': {
+    title: '关于 HagiCode',
+    description: 'HagiCode 为协作构建软件的人们提供工具与社区。',
+    link: '访问 HagiCode',
+  },
+  'zh-Hant': {
+    title: '關於 HagiCode',
+    description: 'HagiCode 為協作打造軟體的人們提供工具與社群。',
+    link: '造訪 HagiCode',
+  },
+};
+
+function resolveArticlePromotion(frontmatterValue, siteDefault = true) {
+  if (typeof siteDefault !== 'boolean') {
+    throw new TypeError('Hagilight hagicodePromotion enabled default must be a boolean.');
+  }
+  if (frontmatterValue !== undefined && typeof frontmatterValue !== 'boolean') {
+    throw new TypeError('Hagilight frontmatter hagicodePromotion must be a boolean.');
+  }
+  return frontmatterValue ?? siteDefault;
+}
+
+function getArticlePromotionCopy(lang) {
+  const language = lang?.split('-')[0];
+  return COPY[lang] ?? COPY[language] ?? COPY['en-US'];
+}
+
+export { COPY, getArticlePromotionCopy, resolveArticlePromotion };

package/index.mjs

@@ -63,6 +63,17 @@ function resolveAIDisclosures(config) {
   };
 }
 
+function resolveHagicodePromotion(config) {
+  if (config === undefined) return true;
+  if (!config || typeof config !== 'object' || Array.isArray(config)) {
+    throw new TypeError('Hagilight hagicodePromotion options must be an object.');
+  }
+  if (config.enabled !== undefined && typeof config.enabled !== 'boolean') {
+    throw new TypeError('Hagilight hagicodePromotion enabled option must be a boolean.');
+  }
+  return config.enabled ?? true;
+}
+
 function createConfiguredIntegration(instanceId, serializedOptions, componentIds) {
   const optionsId = `virtual:hagilight-starlight/${instanceId}/options`;
   const headerPath = componentIds.header
@@ -112,7 +123,10 @@ import MarkdownContent from ${JSON.stringify(markdownContentPath)};
 import options from '${optionsId}';
 ---
 
-<MarkdownContent aiDisclosures={options.aiDisclosures}><slot /></MarkdownContent>
+<MarkdownContent
+  aiDisclosures={options.aiDisclosures}
+  hagicodePromotionEnabled={options.hagicodePromotionEnabled}
+><slot /></MarkdownContent>
 `;
   const headSource = `---
 import DefaultHead from '@astrojs/starlight/components/Head.astro';
@@ -180,6 +194,7 @@ export default function hagilight(options = {}) {
   }
   const analytics = options.analytics ?? {};
   const aiDisclosures = resolveAIDisclosures(options.aiDisclosures);
+  const hagicodePromotionEnabled = resolveHagicodePromotion(options.hagicodePromotion);
   const googleAnalyticsMeasurementId = resolveProvider(analytics.googleAnalytics, {
     name: 'Google Analytics',
     idKey: 'measurementId',
@@ -211,6 +226,7 @@ export default function hagilight(options = {}) {
   };
   const serializedOptions = {
     promotoEnabled: options.promoto?.enabled !== false,
+    hagicodePromotionEnabled,
     links: options.links ?? {},
     googleAnalyticsMeasurementId,
     fiftyOneLaId,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hagicode/hagilight-starlight",
-  "version": "0.2.0",
+  "version": "0.2.1-dev.13.1.46152fe",
   "type": "module",
   "description": "Starlight customizations for HagiCode documentation",
   "repository": {
@@ -14,11 +14,13 @@
   },
   "exports": {
     ".": "./index.mjs",
+    "./article-promotion-schema": "./article-promotion-schema.mjs",
     "./ai-disclosure-schema": "./ai-disclosure-schema.mjs",
     "./ContentLayoutToggle": "./ContentLayoutToggle.astro",
     "./Header": "./Header.astro",
     "./Footer": "./Footer.astro",
     "./MarkdownContent": "./MarkdownContent.astro",
+    "./ArticlePromotion": "./ArticlePromotion.astro",
     "./PageTitle": "./PageTitle.astro",
     "./PromotoFooter": "./PromotoFooter.astro"
   },
@@ -29,7 +31,7 @@
     "*.astro"
   ],
   "dependencies": {
-    "@hagicode/hagilight": "0.2.0"
+    "@hagicode/hagilight": "0.2.1-dev.13.1.46152fe"
   },
   "peerDependencies": {
     "@astrojs/starlight": "^0.42.4",