@blackwork/docs 0.4.2 → 0.6.0

package/dist/theme/components/shell-shared.mjs

@@ -1,9 +1,9 @@
 /**
  * name: @blackwork/docs
- * version: v0.4.2
+ * version: v0.6.0
  * description: Next-first documentation framework for Blackwork projects.
  * author: chengpeiquan <chengpeiquan@chengpeiquan.com>
  * homepage: https://chengpeiquan.com
  * license: MIT
  */
-const e={layout:`docs`,sidebar:`auto`},t=e=>e.site.title||`Documentation`,n=(e,t)=>e.site.description||t.description||`Browse the available documentation.`,r=(e,t,n)=>typeof e==`string`?e:e?.[t]??n,i=(e,t)=>({collapseLabel:r(e.theme.toc?.collapseLabel,t,`Collapse outline`),expandLabel:r(e.theme.toc?.expandLabel,t,`Expand outline`),openLabel:r(e.theme.toc?.openLabel,t,`Open outline`),title:r(e.theme.toc?.title,t,`On This Page`)}),a=(e,t,n)=>t===e.href?!0:n.length===0?!1:n.every((t,n)=>e.slugSegments[n]===t),o=(e,t)=>t.filter(e=>e.depth===0).map(t=>({href:t.href,label:t.title,current:a(e,t.href,t.slugSegments)})),s=e=>e.flatMap(e=>{let t=e.children?s(e.children):[];return(e.depth??0)<=1?t:[{depth:e.depth??2,id:e.id,title:e.value??e.id},...t]}),c=e=>e.slugSegments[0],l=(e,t)=>{let n=c(t);return n?e.filter(e=>e.slugSegments[0]===n):e},u=(t,n)=>{let r=c(n);if(!r)return e;let i=t.content?.sections?.[r],a=i?.layout??e.layout;return{layout:a,sidebar:i?.sidebar??(a===`content`?!1:e.sidebar)}},d=e=>e?.trim(),f=e=>{let t=e.split(/[-_]/u).map(e=>d(e)).filter(e=>!!e);return{language:t[0]?.toLowerCase(),region:t.slice(1).find(e=>/^(?:[A-Za-z]{2}|\d{3})$/u.test(e))?.toUpperCase()}},p=({kind:e=`docs`,layout:t,locale:n,section:r})=>{let{language:i,region:a}=f(n);return{kind:e,locale:n,...i?{language:i}:{},...a?{region:a}:{},...r?{section:r}:{},...t?{layout:t}:{}}},m=e=>Object.entries(e).map(([e,t])=>`${e}:${t}`);export{u as getEntrySectionConfig,c as getEntrySectionKey,n as getFooterDescription,m as getPagefindFilterEntries,p as getPagefindFilters,l as getSectionEntries,t as getSiteTitle,s as getTocHeadings,i as getTocLabels,o as toNavigation};
+const e={layout:`docs`,sidebar:`auto`},t=e=>e.site.title||`Documentation`,n=(e,t)=>e.site.description||t.description||`Browse the available documentation.`,r=(e,t,n)=>typeof e==`string`?e:e?.[t]??n,i=(e,t)=>({collapseLabel:r(e.theme.toc?.collapseLabel,t,`Collapse outline`),expandLabel:r(e.theme.toc?.expandLabel,t,`Expand outline`),openLabel:r(e.theme.toc?.openLabel,t,`Open outline`),title:r(e.theme.toc?.title,t,`On This Page`)}),a=(e,t)=>({changeLanguage:r(e.theme.labels?.changeLanguage,t,`Change language`),documentationPages:r(e.theme.labels?.documentationPages,t,`Documentation pages`),documentPager:r(e.theme.labels?.documentPager,t,`Document pager`),next:r(e.theme.labels?.next,t,`Next`),openSectionNavigation:r(e.theme.labels?.openSectionNavigation,t,`Open section navigation`),openSiteNavigation:r(e.theme.labels?.openSiteNavigation,t,`Open site navigation`),previous:r(e.theme.labels?.previous,t,`Previous`),primaryNavigation:r(e.theme.labels?.primaryNavigation,t,`Primary navigation`),scrollToTop:r(e.theme.labels?.scrollToTop,t,`Scroll to top`),sections:r(e.theme.labels?.sections,t,`Sections`),toggleTheme:r(e.theme.labels?.toggleTheme,t,`Toggle theme`)}),o=new Set([`github`,`x`,`twitter`,`instagram`,`zhihu`,`rss`]),s=(e,t)=>Array.isArray(e.theme.socialLinks)?e.theme.socialLinks.flatMap(e=>!e||typeof e.link!=`string`||e.link.length===0||!o.has(e.type)?[]:[{type:e.type,link:e.link,...e.label?{label:r(e.label,t,``)}:{},...e.ariaLabel?{ariaLabel:r(e.ariaLabel,t,``)}:{}}]):[],c=e=>e.flatMap(e=>{let t=e.children?c(e.children):[];return(e.depth??0)<=1?t:[{depth:e.depth??2,id:e.id,title:e.value??e.id},...t]}),l=e=>e.slugSegments[0],u=(e,t)=>{let n=l(t);return n?e.filter(e=>e.slugSegments[0]===n):e},d=(t,n)=>{let r=l(n);if(!r)return e;let i=t.content?.sections?.[r],a=i?.layout??e.layout;return{layout:a,sidebar:i?.sidebar??(a===`content`?!1:e.sidebar)}},f=e=>e?.trim(),p=e=>{let t=e.split(/[-_]/u).map(e=>f(e)).filter(e=>!!e);return{language:t[0]?.toLowerCase(),region:t.slice(1).find(e=>/^(?:[A-Za-z]{2}|\d{3})$/u.test(e))?.toUpperCase()}},m=({kind:e=`docs`,layout:t,locale:n,section:r})=>{let{language:i,region:a}=p(n);return{kind:e,locale:n,...i?{language:i}:{},...a?{region:a}:{},...r?{section:r}:{},...t?{layout:t}:{}}},h=e=>Object.entries(e).map(([e,t])=>`${e}:${t}`);export{d as getEntrySectionConfig,l as getEntrySectionKey,n as getFooterDescription,h as getPagefindFilterEntries,m as getPagefindFilters,u as getSectionEntries,t as getSiteTitle,a as getThemeLabels,s as getThemeSocialLinks,c as getTocHeadings,i as getTocLabels};

package/dist/theme/create-home-data.cjs

@@ -1,9 +1,9 @@
 /**
  * name: @blackwork/docs
- * version: v0.4.2
+ * version: v0.6.0
  * description: Next-first documentation framework for Blackwork projects.
  * author: chengpeiquan <chengpeiquan@chengpeiquan.com>
  * homepage: https://chengpeiquan.com
  * license: MIT
  */
-const e=require(`../config/define-config.cjs`),t=e=>typeof e==`object`&&!!e,n=e=>typeof e==`string`&&e.trim()||void 0,r=e=>{if(e!==!1)return n(e)},i=e=>{let t=e.search(/[?#]/u);return t<0?{pathname:e,suffix:``}:{pathname:e.slice(0,t),suffix:e.slice(t)}},a=(e,t)=>{let[,n]=e.match(/^\/([^/]+)(?:\/|$)/u)??[];return t.getLocaleCodes().find(e=>e===n)},o=(e,t,n)=>{if(!e.startsWith(`/`)||e.startsWith(`//`))return e;let{pathname:r,suffix:o}=i(e);if(a(r,n))return e;let s=n.getDefaultLocale(),c=s?n.getEntries(s).find(e=>e.href===r):n.getLocaleCodes().flatMap(e=>n.getEntries(e)).find(e=>e.href===r);if(!c)return e;let l=n.getEntry(t,c.slugSegments);return l?`${l.href}${o}`:e},s=(e,r,i)=>{if(!t(e))return;let a=n(e.href),s=n(e.label);if(!(!a||!s))return{href:o(a,r,i),label:s}},c=(e,r,i)=>{if(e===!1)return[];if(Array.isArray(e))return e.flatMap(e=>{if(!t(e))return[];let a=n(e.href),s=n(e.title),c=n(e.description);return a&&s&&c?[{href:o(a,r,i),title:s,description:c}]:[]})},l=e=>e.site.title||`Documentation`,u=(e,t,n)=>{let r=n.getEntries(t),i=n.getCanonicalHref(t,[]),a=n.getEntry(t,[])??r[0],o=r.find(e=>e.href!==a?.href),s=e.site.description||a?.description||`Browse the available documentation.`;return{mode:`auto`,badge:`${r.length} page${r.length===1?``:`s`}`,eyebrow:a?.title||`Documentation`,title:l(e),description:s,homeHref:i,primaryAction:{href:a?.href??i,label:a?`Read ${a.title}`:`Browse docs`},...o?{secondaryAction:{href:o.href,label:o.title}}:{},highlights:[]}},d=e=>[e.badge,e.eyebrow,e.title,e.description,e.primaryAction,e.secondaryAction,e.highlights].some(e=>e!==void 0);function f({config:t,locale:i,source:a}){let o=e.defineConfig(t),l=u(o,i,a);return d(o.home)?{...l,mode:`configured`,badge:r(o.home.badge),eyebrow:r(o.home.eyebrow),title:n(o.home.title)||l.title,description:n(o.home.description)||l.description,primaryAction:s(o.home.primaryAction,i,a)||l.primaryAction,secondaryAction:s(o.home.secondaryAction,i,a)||l.secondaryAction,highlights:c(o.home.highlights,i,a)??[]}:l}exports.createHomeData=f;
+const e=require(`../config/define-config.cjs`),t=e=>typeof e==`object`&&!!e,n=e=>typeof e==`string`&&e.trim()||void 0,r=(e,r)=>t(e)?n(e[r]):n(e),i=(e,t)=>{if(e!==!1)return r(e,t)},a=(e,i)=>{if(e!==!1){if(t(e)&&`src`in e){let t=r(e.alt,i),a=n(e.href),o=n(e.src);return!t||!o?void 0:{alt:t,...a?{href:a}:{},src:o}}return r(e,i)}},o=e=>{let t=e.search(/[?#]/u);return t<0?{pathname:e,suffix:``}:{pathname:e.slice(0,t),suffix:e.slice(t)}},s=(e,t)=>{let[,n]=e.match(/^\/([^/]+)(?:\/|$)/u)??[];return t.getLocaleCodes().find(e=>e===n)},c=(e,t,n)=>{if(!e.startsWith(`/`)||e.startsWith(`//`))return e;let{pathname:r,suffix:i}=o(e);if(s(r,n))return e;let a=n.getDefaultLocale(),c=a?n.getEntries(a).find(e=>e.href===r):n.getLocaleCodes().flatMap(e=>n.getEntries(e)).find(e=>e.href===r);if(!c)return e;let l=n.getEntry(t,c.slugSegments);return l?`${l.href}${i}`:e},l=(e,i,a)=>{if(!t(e))return;let o=n(e.href),s=r(e.label,i);if(!(!o||!s))return{href:c(o,i,a),label:s}},u=(e,i,a)=>{if(e===!1)return[];if(Array.isArray(e))return e.flatMap(e=>{if(!t(e))return[];let o=n(e.href),s=r(e.title,i),l=r(e.description,i);return o&&s&&l?[{href:c(o,i,a),title:s,description:l}]:[]})},d=e=>e.site.title||`Documentation`,f=(e,t,n)=>{let r=n.getEntries(t),i=n.getCanonicalHref(t,[]),a=n.getEntry(t,[])??r[0],o=r.find(e=>e.href!==a?.href),s=e.site.description||a?.description||`Browse the available documentation.`;return{mode:`auto`,badge:`${r.length} page${r.length===1?``:`s`}`,eyebrow:a?.title||`Documentation`,title:d(e),description:s,homeHref:i,primaryAction:{href:a?.href??i,label:a?`Read ${a.title}`:`Browse docs`},...o?{secondaryAction:{href:o.href,label:o.title}}:{},highlights:[]}},p=e=>[e.badge,e.eyebrow,e.title,e.description,e.primaryAction,e.secondaryAction,e.highlights].some(e=>e!==void 0);function m({config:t,locale:n,source:o}){let s=e.defineConfig(t),c=f(s,n,o);return p(s.home)?{...c,mode:`configured`,badge:a(s.home.badge,n),eyebrow:i(s.home.eyebrow,n),title:r(s.home.title,n)||c.title,description:r(s.home.description,n)||c.description,primaryAction:l(s.home.primaryAction,n,o)||c.primaryAction,secondaryAction:l(s.home.secondaryAction,n,o)||c.secondaryAction,highlights:u(s.home.highlights,n,o)??[]}:c}exports.createHomeData=m;

package/dist/theme/create-home-data.mjs

@@ -1,9 +1,9 @@
 /**
  * name: @blackwork/docs
- * version: v0.4.2
+ * version: v0.6.0
  * description: Next-first documentation framework for Blackwork projects.
  * author: chengpeiquan <chengpeiquan@chengpeiquan.com>
  * homepage: https://chengpeiquan.com
  * license: MIT
  */
-import{defineConfig as e}from"../config/define-config.mjs";const t=e=>typeof e==`object`&&!!e,n=e=>typeof e==`string`&&e.trim()||void 0,r=e=>{if(e!==!1)return n(e)},i=e=>{let t=e.search(/[?#]/u);return t<0?{pathname:e,suffix:``}:{pathname:e.slice(0,t),suffix:e.slice(t)}},a=(e,t)=>{let[,n]=e.match(/^\/([^/]+)(?:\/|$)/u)??[];return t.getLocaleCodes().find(e=>e===n)},o=(e,t,n)=>{if(!e.startsWith(`/`)||e.startsWith(`//`))return e;let{pathname:r,suffix:o}=i(e);if(a(r,n))return e;let s=n.getDefaultLocale(),c=s?n.getEntries(s).find(e=>e.href===r):n.getLocaleCodes().flatMap(e=>n.getEntries(e)).find(e=>e.href===r);if(!c)return e;let l=n.getEntry(t,c.slugSegments);return l?`${l.href}${o}`:e},s=(e,r,i)=>{if(!t(e))return;let a=n(e.href),s=n(e.label);if(!(!a||!s))return{href:o(a,r,i),label:s}},c=(e,r,i)=>{if(e===!1)return[];if(Array.isArray(e))return e.flatMap(e=>{if(!t(e))return[];let a=n(e.href),s=n(e.title),c=n(e.description);return a&&s&&c?[{href:o(a,r,i),title:s,description:c}]:[]})},l=e=>e.site.title||`Documentation`,u=(e,t,n)=>{let r=n.getEntries(t),i=n.getCanonicalHref(t,[]),a=n.getEntry(t,[])??r[0],o=r.find(e=>e.href!==a?.href),s=e.site.description||a?.description||`Browse the available documentation.`;return{mode:`auto`,badge:`${r.length} page${r.length===1?``:`s`}`,eyebrow:a?.title||`Documentation`,title:l(e),description:s,homeHref:i,primaryAction:{href:a?.href??i,label:a?`Read ${a.title}`:`Browse docs`},...o?{secondaryAction:{href:o.href,label:o.title}}:{},highlights:[]}},d=e=>[e.badge,e.eyebrow,e.title,e.description,e.primaryAction,e.secondaryAction,e.highlights].some(e=>e!==void 0);function f({config:t,locale:i,source:a}){let o=e(t),l=u(o,i,a);return d(o.home)?{...l,mode:`configured`,badge:r(o.home.badge),eyebrow:r(o.home.eyebrow),title:n(o.home.title)||l.title,description:n(o.home.description)||l.description,primaryAction:s(o.home.primaryAction,i,a)||l.primaryAction,secondaryAction:s(o.home.secondaryAction,i,a)||l.secondaryAction,highlights:c(o.home.highlights,i,a)??[]}:l}export{f as createHomeData};
+import{defineConfig as e}from"../config/define-config.mjs";const t=e=>typeof e==`object`&&!!e,n=e=>typeof e==`string`&&e.trim()||void 0,r=(e,r)=>t(e)?n(e[r]):n(e),i=(e,t)=>{if(e!==!1)return r(e,t)},a=(e,i)=>{if(e!==!1){if(t(e)&&`src`in e){let t=r(e.alt,i),a=n(e.href),o=n(e.src);return!t||!o?void 0:{alt:t,...a?{href:a}:{},src:o}}return r(e,i)}},o=e=>{let t=e.search(/[?#]/u);return t<0?{pathname:e,suffix:``}:{pathname:e.slice(0,t),suffix:e.slice(t)}},s=(e,t)=>{let[,n]=e.match(/^\/([^/]+)(?:\/|$)/u)??[];return t.getLocaleCodes().find(e=>e===n)},c=(e,t,n)=>{if(!e.startsWith(`/`)||e.startsWith(`//`))return e;let{pathname:r,suffix:i}=o(e);if(s(r,n))return e;let a=n.getDefaultLocale(),c=a?n.getEntries(a).find(e=>e.href===r):n.getLocaleCodes().flatMap(e=>n.getEntries(e)).find(e=>e.href===r);if(!c)return e;let l=n.getEntry(t,c.slugSegments);return l?`${l.href}${i}`:e},l=(e,i,a)=>{if(!t(e))return;let o=n(e.href),s=r(e.label,i);if(!(!o||!s))return{href:c(o,i,a),label:s}},u=(e,i,a)=>{if(e===!1)return[];if(Array.isArray(e))return e.flatMap(e=>{if(!t(e))return[];let o=n(e.href),s=r(e.title,i),l=r(e.description,i);return o&&s&&l?[{href:c(o,i,a),title:s,description:l}]:[]})},d=e=>e.site.title||`Documentation`,f=(e,t,n)=>{let r=n.getEntries(t),i=n.getCanonicalHref(t,[]),a=n.getEntry(t,[])??r[0],o=r.find(e=>e.href!==a?.href),s=e.site.description||a?.description||`Browse the available documentation.`;return{mode:`auto`,badge:`${r.length} page${r.length===1?``:`s`}`,eyebrow:a?.title||`Documentation`,title:d(e),description:s,homeHref:i,primaryAction:{href:a?.href??i,label:a?`Read ${a.title}`:`Browse docs`},...o?{secondaryAction:{href:o.href,label:o.title}}:{},highlights:[]}},p=e=>[e.badge,e.eyebrow,e.title,e.description,e.primaryAction,e.secondaryAction,e.highlights].some(e=>e!==void 0);function m({config:t,locale:n,source:o}){let s=e(t),c=f(s,n,o);return p(s.home)?{...c,mode:`configured`,badge:a(s.home.badge,n),eyebrow:i(s.home.eyebrow,n),title:r(s.home.title,n)||c.title,description:r(s.home.description,n)||c.description,primaryAction:l(s.home.primaryAction,n,o)||c.primaryAction,secondaryAction:l(s.home.secondaryAction,n,o)||c.secondaryAction,highlights:u(s.home.highlights,n,o)??[]}:c}export{m as createHomeData};

package/dist/theme/slots.cjs

@@ -1,9 +1,9 @@
 /**
  * name: @blackwork/docs
- * version: v0.4.2
+ * version: v0.6.0
  * description: Next-first documentation framework for Blackwork projects.
  * author: chengpeiquan <chengpeiquan@chengpeiquan.com>
  * homepage: https://chengpeiquan.com
  * license: MIT
  */
-const e=e=>typeof e==`object`&&!!e,t=e=>typeof e==`function`,n=e=>typeof e==`function`,r=e=>typeof e==`function`,i=e=>typeof e==`function`;function a(a){return e(a)?{...r(a.contentHeaderMeta)?{contentHeaderMeta:a.contentHeaderMeta}:{},...t(a.footer)?{footer:a.footer}:{},...n(a.headerActions)?{headerActions:a.headerActions}:{},...i(a.link)?{link:a.link}:{}}:{}}exports.resolveThemeSlots=a;
+const e=e=>typeof e==`object`&&!!e,t=e=>typeof e==`function`,n=e=>typeof e==`function`,r=e=>typeof e==`function`,i=e=>typeof e==`function`;function a(a){return e(a)?{...typeof a.homePreview==`function`?{homePreview:a.homePreview}:{},...r(a.contentHeaderMeta)?{contentHeaderMeta:a.contentHeaderMeta}:{},...t(a.footer)?{footer:a.footer}:{},...n(a.headerActions)?{headerActions:a.headerActions}:{},...i(a.link)?{link:a.link}:{}}:{}}exports.resolveThemeSlots=a;

package/dist/theme/slots.mjs

@@ -1,9 +1,9 @@
 /**
  * name: @blackwork/docs
- * version: v0.4.2
+ * version: v0.6.0
  * description: Next-first documentation framework for Blackwork projects.
  * author: chengpeiquan <chengpeiquan@chengpeiquan.com>
  * homepage: https://chengpeiquan.com
  * license: MIT
  */
-const e=e=>typeof e==`object`&&!!e,t=e=>typeof e==`function`,n=e=>typeof e==`function`,r=e=>typeof e==`function`,i=e=>typeof e==`function`;function a(a){return e(a)?{...r(a.contentHeaderMeta)?{contentHeaderMeta:a.contentHeaderMeta}:{},...t(a.footer)?{footer:a.footer}:{},...n(a.headerActions)?{headerActions:a.headerActions}:{},...i(a.link)?{link:a.link}:{}}:{}}export{a as resolveThemeSlots};
+const e=e=>typeof e==`object`&&!!e,t=e=>typeof e==`function`,n=e=>typeof e==`function`,r=e=>typeof e==`function`,i=e=>typeof e==`function`;function a(a){return e(a)?{...typeof a.homePreview==`function`?{homePreview:a.homePreview}:{},...r(a.contentHeaderMeta)?{contentHeaderMeta:a.contentHeaderMeta}:{},...t(a.footer)?{footer:a.footer}:{},...n(a.headerActions)?{headerActions:a.headerActions}:{},...i(a.link)?{link:a.link}:{}}:{}}export{a as resolveThemeSlots};

package/dist/theme/types.d.mts

@@ -37,7 +37,11 @@ interface DocsThemeHeaderActionsProps {
 interface DocsThemeContentHeaderMetaProps {
   entry: DocEntry;
 }
+interface DocsThemeHomePreviewProps {
+  locale: string;
+}
 interface DocsThemeSlots {
+  homePreview?: ComponentType<DocsThemeHomePreviewProps>;
   contentHeaderMeta?: ComponentType<DocsThemeContentHeaderMetaProps>;
   footer?: ComponentType<DocsThemeFooterSlotProps>;
   headerActions?: ComponentType<DocsThemeHeaderActionsProps>;
@@ -52,8 +56,13 @@ interface DocsThemeHomeHighlight {
   title: string;
   description: string;
 }
+interface DocsThemeHomeBadgeImage {
+  alt: string;
+  href?: string;
+  src: string;
+}
 interface DocsThemeHomeData {
-  badge?: string;
+  badge?: string | DocsThemeHomeBadgeImage;
   description: string;
   eyebrow?: string;
   highlights: DocsThemeHomeHighlight[];
@@ -63,15 +72,30 @@ interface DocsThemeHomeData {
   secondaryAction?: DocsThemeHomeAction;
   title: string;
 }
+type DocsThemeLocalizedText = string | Record<string, string>;
+interface DocsHomeBadgeImageConfig {
+  alt: DocsThemeLocalizedText;
+  href?: string;
+  src: string;
+}
+interface DocsHomeActionConfig {
+  href: string;
+  label: DocsThemeLocalizedText;
+}
+interface DocsHomeHighlightConfig {
+  href: string;
+  title: DocsThemeLocalizedText;
+  description: DocsThemeLocalizedText;
+}
 interface DocsHomeConfig {
-  badge?: string | false;
-  eyebrow?: string | false;
-  title?: string;
-  description?: string;
-  primaryAction?: DocsThemeHomeAction;
-  secondaryAction?: DocsThemeHomeAction;
-  highlights?: DocsThemeHomeHighlight[] | false;
+  badge?: DocsHomeBadgeImageConfig | DocsThemeLocalizedText | false;
+  eyebrow?: DocsThemeLocalizedText | false;
+  title?: DocsThemeLocalizedText;
+  description?: DocsThemeLocalizedText;
+  primaryAction?: DocsHomeActionConfig;
+  secondaryAction?: DocsHomeActionConfig;
+  highlights?: DocsHomeHighlightConfig[] | false;
 }
 type DocsSlotsConfig = DocsThemeSlots;
 //#endregion
-export { DocsHomeConfig, DocsSlotsConfig, DocsThemeContentHeaderMetaProps, DocsThemeFooterSlotProps, DocsThemeHeaderActionsProps, DocsThemeHomeAction, DocsThemeHomeData, DocsThemeHomeHighlight, DocsThemeLinkComponent, DocsThemeLinkProps, DocsThemeLocaleLink, DocsThemeNavItem, DocsThemeSlots };
+export { DocsHomeConfig, DocsSlotsConfig, DocsThemeContentHeaderMetaProps, DocsThemeFooterSlotProps, DocsThemeHeaderActionsProps, DocsThemeHomeAction, DocsThemeHomeData, DocsThemeHomeHighlight, DocsThemeHomePreviewProps, DocsThemeLinkComponent, DocsThemeLinkProps, DocsThemeLocaleLink, DocsThemeLocalizedText, DocsThemeNavItem, DocsThemeSlots };

package/dist/theme/types.d.ts

@@ -37,7 +37,11 @@ interface DocsThemeHeaderActionsProps {
 interface DocsThemeContentHeaderMetaProps {
   entry: DocEntry;
 }
+interface DocsThemeHomePreviewProps {
+  locale: string;
+}
 interface DocsThemeSlots {
+  homePreview?: ComponentType<DocsThemeHomePreviewProps>;
   contentHeaderMeta?: ComponentType<DocsThemeContentHeaderMetaProps>;
   footer?: ComponentType<DocsThemeFooterSlotProps>;
   headerActions?: ComponentType<DocsThemeHeaderActionsProps>;
@@ -52,8 +56,13 @@ interface DocsThemeHomeHighlight {
   title: string;
   description: string;
 }
+interface DocsThemeHomeBadgeImage {
+  alt: string;
+  href?: string;
+  src: string;
+}
 interface DocsThemeHomeData {
-  badge?: string;
+  badge?: string | DocsThemeHomeBadgeImage;
   description: string;
   eyebrow?: string;
   highlights: DocsThemeHomeHighlight[];
@@ -63,15 +72,30 @@ interface DocsThemeHomeData {
   secondaryAction?: DocsThemeHomeAction;
   title: string;
 }
+type DocsThemeLocalizedText = string | Record<string, string>;
+interface DocsHomeBadgeImageConfig {
+  alt: DocsThemeLocalizedText;
+  href?: string;
+  src: string;
+}
+interface DocsHomeActionConfig {
+  href: string;
+  label: DocsThemeLocalizedText;
+}
+interface DocsHomeHighlightConfig {
+  href: string;
+  title: DocsThemeLocalizedText;
+  description: DocsThemeLocalizedText;
+}
 interface DocsHomeConfig {
-  badge?: string | false;
-  eyebrow?: string | false;
-  title?: string;
-  description?: string;
-  primaryAction?: DocsThemeHomeAction;
-  secondaryAction?: DocsThemeHomeAction;
-  highlights?: DocsThemeHomeHighlight[] | false;
+  badge?: DocsHomeBadgeImageConfig | DocsThemeLocalizedText | false;
+  eyebrow?: DocsThemeLocalizedText | false;
+  title?: DocsThemeLocalizedText;
+  description?: DocsThemeLocalizedText;
+  primaryAction?: DocsHomeActionConfig;
+  secondaryAction?: DocsHomeActionConfig;
+  highlights?: DocsHomeHighlightConfig[] | false;
 }
 type DocsSlotsConfig = DocsThemeSlots;
 //#endregion
-export { DocsHomeConfig, DocsSlotsConfig, DocsThemeContentHeaderMetaProps, DocsThemeFooterSlotProps, DocsThemeHeaderActionsProps, DocsThemeHomeAction, DocsThemeHomeData, DocsThemeHomeHighlight, DocsThemeLinkComponent, DocsThemeLinkProps, DocsThemeLocaleLink, DocsThemeNavItem, DocsThemeSlots };
+export { DocsHomeConfig, DocsSlotsConfig, DocsThemeContentHeaderMetaProps, DocsThemeFooterSlotProps, DocsThemeHeaderActionsProps, DocsThemeHomeAction, DocsThemeHomeData, DocsThemeHomeHighlight, DocsThemeHomePreviewProps, DocsThemeLinkComponent, DocsThemeLinkProps, DocsThemeLocaleLink, DocsThemeLocalizedText, DocsThemeNavItem, DocsThemeSlots };

package/dist/theme.cjs

@@ -1,9 +1,9 @@
 /**
  * name: @blackwork/docs
- * version: v0.4.2
+ * version: v0.6.0
  * description: Next-first documentation framework for Blackwork projects.
  * author: chengpeiquan <chengpeiquan@chengpeiquan.com>
  * homepage: https://chengpeiquan.com
  * license: MIT
  */
-Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require(`./theme/components/link.cjs`),t=require(`./theme/components/footer.cjs`),n=require(`./theme/components/header.cjs`),r=require(`./theme/components/docs-toc.cjs`),i=require(`./theme/components/content-layout.cjs`),a=require(`./theme/slots.cjs`),o=require(`./theme/components/content-shell.cjs`),s=require(`./theme/components/docs-shell.cjs`),c=require(`./theme/create-home-data.cjs`),l=require(`./theme/components/home-shell.cjs`);exports.DefaultContentLayout=i.DefaultContentLayout,exports.DefaultContentShell=o.DefaultContentShell,exports.DefaultDocsFooter=t.DefaultDocsFooter,exports.DefaultDocsHeader=n.DefaultDocsHeader,exports.DefaultDocsLink=e.DefaultDocsLink,exports.DefaultDocsShell=s.DefaultDocsShell,exports.DefaultDocsToc=r.DefaultDocsToc,exports.DefaultHomeShell=l.DefaultHomeShell,exports.MobileDocsToc=r.MobileDocsToc,exports.createHomeData=c.createHomeData,exports.resolveThemeSlots=a.resolveThemeSlots;
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require(`./theme/components/footer.cjs`),t=require(`./theme/components/link.cjs`),n=require(`./theme/components/header.cjs`),r=require(`./theme/components/docs-toc.cjs`),i=require(`./theme/components/content-layout.cjs`),a=require(`./theme/slots.cjs`),o=require(`./theme/components/content-shell.cjs`),s=require(`./theme/components/docs-shell.cjs`),c=require(`./theme/create-home-data.cjs`),l=require(`./theme/components/home-shell.cjs`);exports.DefaultContentLayout=i.DefaultContentLayout,exports.DefaultContentShell=o.DefaultContentShell,exports.DefaultDocsFooter=e.DefaultDocsFooter,exports.DefaultDocsHeader=n.DefaultDocsHeader,exports.DefaultDocsLink=t.DefaultDocsLink,exports.DefaultDocsShell=s.DefaultDocsShell,exports.DefaultDocsToc=r.DefaultDocsToc,exports.DefaultHomeShell=l.DefaultHomeShell,exports.MobileDocsToc=r.MobileDocsToc,exports.createHomeData=c.createHomeData,exports.resolveThemeSlots=a.resolveThemeSlots;

package/dist/theme.d.mts

@@ -1,13 +1,13 @@
 
-import { DocsHomeConfig, DocsSlotsConfig, DocsThemeContentHeaderMetaProps, DocsThemeFooterSlotProps, DocsThemeHeaderActionsProps, DocsThemeHomeAction, DocsThemeHomeData, DocsThemeHomeHighlight, DocsThemeLinkComponent, DocsThemeLinkProps, DocsThemeLocaleLink, DocsThemeNavItem, DocsThemeSlots } from "./theme/types.mjs";
+import { DocsHomeConfig, DocsSlotsConfig, DocsThemeContentHeaderMetaProps, DocsThemeFooterSlotProps, DocsThemeHeaderActionsProps, DocsThemeHomeAction, DocsThemeHomeData, DocsThemeHomeHighlight, DocsThemeHomePreviewProps, DocsThemeLinkComponent, DocsThemeLinkProps, DocsThemeLocaleLink, DocsThemeNavItem, DocsThemeSlots } from "./theme/types.mjs";
 import { DefaultDocsFooter, DefaultDocsFooterProps } from "./theme/components/footer.mjs";
+import { DefaultDocsToc, DefaultDocsTocProps, DocsTocHeading, MobileDocsToc, MobileDocsTocProps } from "./theme/components/docs-toc.mjs";
 import { DefaultDocsHeader, DefaultDocsHeaderProps } from "./theme/components/header.mjs";
 import { DefaultDocsLink, DefaultDocsLinkProps } from "./theme/components/link.mjs";
-import { DefaultDocsToc, DefaultDocsTocProps, DocsTocHeading, MobileDocsToc, MobileDocsTocProps } from "./theme/components/docs-toc.mjs";
 import { DefaultContentLayout, DefaultContentLayoutProps } from "./theme/components/content-layout.mjs";
 import { DefaultContentShell, DefaultContentShellProps } from "./theme/components/content-shell.mjs";
 import { DefaultDocsShell, DefaultDocsShellProps } from "./theme/components/docs-shell.mjs";
 import { DefaultHomeShell, DefaultHomeShellProps } from "./theme/components/home-shell.mjs";
 import { CreateHomeDataOptions, createHomeData } from "./theme/create-home-data.mjs";
 import { resolveThemeSlots } from "./theme/slots.mjs";
-export { type CreateHomeDataOptions, DefaultContentLayout, type DefaultContentLayoutProps, DefaultContentShell, type DefaultContentShellProps, DefaultDocsFooter, type DefaultDocsFooterProps, DefaultDocsHeader, type DefaultDocsHeaderProps, DefaultDocsLink, type DefaultDocsLinkProps, DefaultDocsShell, type DefaultDocsShellProps, DefaultDocsToc, type DefaultDocsTocProps, DefaultHomeShell, type DefaultHomeShellProps, type DocsHomeConfig, type DocsSlotsConfig, type DocsThemeContentHeaderMetaProps, type DocsThemeFooterSlotProps, type DocsThemeHeaderActionsProps, type DocsThemeHomeAction, type DocsThemeHomeData, type DocsThemeHomeHighlight, type DocsThemeLinkComponent, type DocsThemeLinkProps, type DocsThemeLocaleLink, type DocsThemeNavItem, type DocsThemeSlots, type DocsTocHeading, MobileDocsToc, type MobileDocsTocProps, createHomeData, resolveThemeSlots };
+export { type CreateHomeDataOptions, DefaultContentLayout, type DefaultContentLayoutProps, DefaultContentShell, type DefaultContentShellProps, DefaultDocsFooter, type DefaultDocsFooterProps, DefaultDocsHeader, type DefaultDocsHeaderProps, DefaultDocsLink, type DefaultDocsLinkProps, DefaultDocsShell, type DefaultDocsShellProps, DefaultDocsToc, type DefaultDocsTocProps, DefaultHomeShell, type DefaultHomeShellProps, type DocsHomeConfig, type DocsSlotsConfig, type DocsThemeContentHeaderMetaProps, type DocsThemeFooterSlotProps, type DocsThemeHeaderActionsProps, type DocsThemeHomeAction, type DocsThemeHomeData, type DocsThemeHomeHighlight, type DocsThemeHomePreviewProps, type DocsThemeLinkComponent, type DocsThemeLinkProps, type DocsThemeLocaleLink, type DocsThemeNavItem, type DocsThemeSlots, type DocsTocHeading, MobileDocsToc, type MobileDocsTocProps, createHomeData, resolveThemeSlots };

package/dist/theme.d.ts

@@ -1,13 +1,13 @@
 
-import { DocsHomeConfig, DocsSlotsConfig, DocsThemeContentHeaderMetaProps, DocsThemeFooterSlotProps, DocsThemeHeaderActionsProps, DocsThemeHomeAction, DocsThemeHomeData, DocsThemeHomeHighlight, DocsThemeLinkComponent, DocsThemeLinkProps, DocsThemeLocaleLink, DocsThemeNavItem, DocsThemeSlots } from "./theme/types.js";
+import { DocsHomeConfig, DocsSlotsConfig, DocsThemeContentHeaderMetaProps, DocsThemeFooterSlotProps, DocsThemeHeaderActionsProps, DocsThemeHomeAction, DocsThemeHomeData, DocsThemeHomeHighlight, DocsThemeHomePreviewProps, DocsThemeLinkComponent, DocsThemeLinkProps, DocsThemeLocaleLink, DocsThemeNavItem, DocsThemeSlots } from "./theme/types.js";
 import { DefaultDocsFooter, DefaultDocsFooterProps } from "./theme/components/footer.js";
+import { DefaultDocsToc, DefaultDocsTocProps, DocsTocHeading, MobileDocsToc, MobileDocsTocProps } from "./theme/components/docs-toc.js";
 import { DefaultDocsHeader, DefaultDocsHeaderProps } from "./theme/components/header.js";
 import { DefaultDocsLink, DefaultDocsLinkProps } from "./theme/components/link.js";
-import { DefaultDocsToc, DefaultDocsTocProps, DocsTocHeading, MobileDocsToc, MobileDocsTocProps } from "./theme/components/docs-toc.js";
 import { DefaultContentLayout, DefaultContentLayoutProps } from "./theme/components/content-layout.js";
 import { DefaultContentShell, DefaultContentShellProps } from "./theme/components/content-shell.js";
 import { DefaultDocsShell, DefaultDocsShellProps } from "./theme/components/docs-shell.js";
 import { DefaultHomeShell, DefaultHomeShellProps } from "./theme/components/home-shell.js";
 import { CreateHomeDataOptions, createHomeData } from "./theme/create-home-data.js";
 import { resolveThemeSlots } from "./theme/slots.js";
-export { type CreateHomeDataOptions, DefaultContentLayout, type DefaultContentLayoutProps, DefaultContentShell, type DefaultContentShellProps, DefaultDocsFooter, type DefaultDocsFooterProps, DefaultDocsHeader, type DefaultDocsHeaderProps, DefaultDocsLink, type DefaultDocsLinkProps, DefaultDocsShell, type DefaultDocsShellProps, DefaultDocsToc, type DefaultDocsTocProps, DefaultHomeShell, type DefaultHomeShellProps, type DocsHomeConfig, type DocsSlotsConfig, type DocsThemeContentHeaderMetaProps, type DocsThemeFooterSlotProps, type DocsThemeHeaderActionsProps, type DocsThemeHomeAction, type DocsThemeHomeData, type DocsThemeHomeHighlight, type DocsThemeLinkComponent, type DocsThemeLinkProps, type DocsThemeLocaleLink, type DocsThemeNavItem, type DocsThemeSlots, type DocsTocHeading, MobileDocsToc, type MobileDocsTocProps, createHomeData, resolveThemeSlots };
+export { type CreateHomeDataOptions, DefaultContentLayout, type DefaultContentLayoutProps, DefaultContentShell, type DefaultContentShellProps, DefaultDocsFooter, type DefaultDocsFooterProps, DefaultDocsHeader, type DefaultDocsHeaderProps, DefaultDocsLink, type DefaultDocsLinkProps, DefaultDocsShell, type DefaultDocsShellProps, DefaultDocsToc, type DefaultDocsTocProps, DefaultHomeShell, type DefaultHomeShellProps, type DocsHomeConfig, type DocsSlotsConfig, type DocsThemeContentHeaderMetaProps, type DocsThemeFooterSlotProps, type DocsThemeHeaderActionsProps, type DocsThemeHomeAction, type DocsThemeHomeData, type DocsThemeHomeHighlight, type DocsThemeHomePreviewProps, type DocsThemeLinkComponent, type DocsThemeLinkProps, type DocsThemeLocaleLink, type DocsThemeNavItem, type DocsThemeSlots, type DocsTocHeading, MobileDocsToc, type MobileDocsTocProps, createHomeData, resolveThemeSlots };

package/dist/theme.mjs

@@ -1,9 +1,9 @@
 /**
  * name: @blackwork/docs
- * version: v0.4.2
+ * version: v0.6.0
  * description: Next-first documentation framework for Blackwork projects.
  * author: chengpeiquan <chengpeiquan@chengpeiquan.com>
  * homepage: https://chengpeiquan.com
  * license: MIT
  */
-import{DefaultDocsLink as e}from"./theme/components/link.mjs";import{DefaultDocsFooter as t}from"./theme/components/footer.mjs";import{DefaultDocsHeader as n}from"./theme/components/header.mjs";import{DefaultDocsToc as r,MobileDocsToc as i}from"./theme/components/docs-toc.mjs";import{DefaultContentLayout as a}from"./theme/components/content-layout.mjs";import{resolveThemeSlots as o}from"./theme/slots.mjs";import{DefaultContentShell as s}from"./theme/components/content-shell.mjs";import{DefaultDocsShell as c}from"./theme/components/docs-shell.mjs";import{createHomeData as l}from"./theme/create-home-data.mjs";import{DefaultHomeShell as u}from"./theme/components/home-shell.mjs";export{a as DefaultContentLayout,s as DefaultContentShell,t as DefaultDocsFooter,n as DefaultDocsHeader,e as DefaultDocsLink,c as DefaultDocsShell,r as DefaultDocsToc,u as DefaultHomeShell,i as MobileDocsToc,l as createHomeData,o as resolveThemeSlots};
+import{DefaultDocsFooter as e}from"./theme/components/footer.mjs";import{DefaultDocsLink as t}from"./theme/components/link.mjs";import{DefaultDocsHeader as n}from"./theme/components/header.mjs";import{DefaultDocsToc as r,MobileDocsToc as i}from"./theme/components/docs-toc.mjs";import{DefaultContentLayout as a}from"./theme/components/content-layout.mjs";import{resolveThemeSlots as o}from"./theme/slots.mjs";import{DefaultContentShell as s}from"./theme/components/content-shell.mjs";import{DefaultDocsShell as c}from"./theme/components/docs-shell.mjs";import{createHomeData as l}from"./theme/create-home-data.mjs";import{DefaultHomeShell as u}from"./theme/components/home-shell.mjs";export{a as DefaultContentLayout,s as DefaultContentShell,e as DefaultDocsFooter,n as DefaultDocsHeader,t as DefaultDocsLink,c as DefaultDocsShell,r as DefaultDocsToc,u as DefaultHomeShell,i as MobileDocsToc,l as createHomeData,o as resolveThemeSlots};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blackwork/docs",
-  "version": "0.4.2",
+  "version": "0.6.0",
   "description": "Next-first documentation framework for Blackwork projects.",
   "author": "chengpeiquan <chengpeiquan@chengpeiquan.com>",
   "homepage": "https://chengpeiquan.com",
@@ -52,10 +52,11 @@
   "dependencies": {
     "chokidar": "^4.0.3",
     "jiti": "^1.21.7",
-    "@blackwork/machine": "0.2.1"
+    "lucide-react": "^1.31.0",
+    "@blackwork/machine": "0.2.2"
   },
   "peerDependencies": {
-    "blackwork": ">=0.11.0",
+    "blackwork": ">=0.13.0",
     "next": ">=16.0.0",
     "react": ">=19.0.0",
     "react-dom": ">=19.0.0"
@@ -63,13 +64,18 @@
   "devDependencies": {
     "@bassist/build-config": "^0.2.0",
     "@bassist/tsconfig": "^0.1.1",
-    "@types/node": "^25.5.2",
-    "eslint": "^10.2.1",
+    "@types/node": "^25.9.5",
+    "@types/react": "^19.2.18",
+    "@types/react-dom": "^19.2.4",
+    "eslint": "^10.8.1",
     "jsdom": "^26.1.0",
-    "tsdown": "^0.21.7",
-    "typescript": "^6.0.2",
-    "vitest": "^4.0.7",
-    "blackwork": "0.11.0"
+    "next": "^16.3.1",
+    "react": "^19.2.8",
+    "react-dom": "^19.2.8",
+    "tsdown": "^0.21.10",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.10",
+    "blackwork": "0.13.0"
   },
   "scripts": {
     "build": "tsdown && node ./scripts/copy-css.mjs",