@brillout/docpress 0.11.3 → 0.11.5

package/Layout.tsx

@@ -86,7 +86,7 @@ function Layout({ children }: { children: React.ReactNode }) {
 function LayoutDocsPage({ children }: { children: React.ReactNode }) {
   const pageContext = usePageContext()
   const hideNavLeftAlways =
-    pageContext.hideMenuLeft || (pageContext.navItemsDetached && pageContext.navItemsDetached.length <= 1)
+    pageContext.pageDesign?.hideMenuLeft || (pageContext.navItemsDetached && pageContext.navItemsDetached.length <= 1)
   return (
     <>
       <Style>{getStyle()}</Style>
@@ -159,6 +159,7 @@ function PageContent({ children }: { children: React.ReactNode }) {
   const pageTitleParsed = pageTitle && parseMarkdownMini(pageTitle)
   const { globalNote } = pageContext.config
   const ifDocPage = (style: React.CSSProperties) => (isLandingPage ? {} : style)
+  const contentMaxWidth = pageContext.pageDesign?.contentMaxWidth ?? mainViewWidthMax
   return (
     <div
       className="page-wrapper low-prio-grow"
@@ -177,14 +178,14 @@ function PageContent({ children }: { children: React.ReactNode }) {
           // Also define --main-view-padding for landing page because it's used by <Contributors> and <Sponsors>
           ['--main-view-padding']: `${mainViewPadding}px`,
           ...ifDocPage({
-            width: `calc(${mainViewWidthMax}px + 2 * var(--main-view-padding))`,
+            width: `calc(${contentMaxWidth}px + 2 * var(--main-view-padding))`,
             maxWidth: '100%',
             padding: '20px var(--main-view-padding)',
           }),
         }}
       >
         {globalNote}
-        {pageTitleParsed && (
+        {pageTitleParsed && !pageContext.pageDesign?.hideTitle && (
           <div>
             <EditLink className="show-only-on-desktop" style={{ float: 'right', marginTop: 6, padding: 10 }} />
             <h1 id={`${pageContext.urlPathname.replace('/', '')}`}>{pageTitleParsed}</h1>

package/components/Algolia/Snippet.tsx

@@ -23,10 +23,28 @@ export function Snippet<TItem extends StoredDocSearchHit>({
   tagName = 'span',
   ...rest
 }: SnippetProps<TItem>) {
+  let title = ''
+  let lvl2 = ''
+
+  if (!hit.__docsearch_parent && hit.type !== 'lvl1' && attribute !== 'content') {
+    if (hit.type === 'content') {
+      const lvl0 =
+        getPropertyByPath(hit, `_snippetResult.hierarchy.lvl0.value`) || getPropertyByPath(hit, 'hierarchy.lvl0')
+      title = lvl0 ? `${lvl0} > ` : ''
+
+      lvl2 = getPropertyByPath(hit, `_snippetResult.hierarchy.lvl2.value`) || getPropertyByPath(hit, 'hierarchy.lvl2')
+      lvl2 = lvl2 ? ` > ${lvl2}` : ''
+    } else {
+      const lvl1 =
+        getPropertyByPath(hit, `_snippetResult.hierarchy.lvl1.value`) || getPropertyByPath(hit, 'hierarchy.lvl1')
+      title = lvl1 ? `${lvl1} > ` : ''
+    }
+  }
+
   return createElement(tagName, {
     ...rest,
     dangerouslySetInnerHTML: {
-      __html: getPropertyByPath(hit, `_snippetResult.${attribute}.value`) || getPropertyByPath(hit, attribute),
+      __html: `${title}${getPropertyByPath(hit, `_snippetResult.${attribute}.value`) || getPropertyByPath(hit, attribute)}${lvl2}`,
     },
   })
 }

package/components/Algolia/types.ts

@@ -1,8 +1,8 @@
 export type InternalDocSearchHit = DocSearchHit & {
-  __docsearch_parent: InternalDocSearchHit | null
+  __docsearch_parent?: InternalDocSearchHit | null
 }
 
-export type StoredDocSearchHit = Omit<DocSearchHit, '_highlightResult' | '_snippetResult'>
+export type StoredDocSearchHit = Omit<InternalDocSearchHit, '_highlightResult' | '_snippetResult'>
 
 type ContentType = 'content' | 'lvl0' | 'lvl1' | 'lvl2' | 'lvl3' | 'lvl4' | 'lvl5' | 'lvl6'
 

package/config/resolveHeadingsData.ts

@@ -92,7 +92,7 @@ function resolveHeadingsData(pageContext: PageContextOriginal) {
   const pageContextAddendum = {
     navItemsAll,
     navItemsDetached,
-    hideMenuLeft: activeHeading.hideMenuLeft,
+    pageDesign: activeHeading.pageDesign,
     linksAll,
     isLandingPage,
     pageTitle,

package/dist/config/resolveHeadingsData.d.ts

@@ -11,7 +11,11 @@ type ActiveCategory = {
 declare function resolveHeadingsData(pageContext: PageContextOriginal): {
     navItemsAll: NavItem[];
     navItemsDetached: NavItem[] | undefined;
-    hideMenuLeft: true | undefined;
+    pageDesign: {
+        hideTitle?: true;
+        hideMenuLeft?: true;
+        contentMaxWidth?: number;
+    } | undefined;
     linksAll: LinkData[];
     isLandingPage: boolean;
     pageTitle: string | null;

package/dist/config/resolveHeadingsData.js

@@ -64,7 +64,7 @@ function resolveHeadingsData(pageContext) {
     var pageContextAddendum = {
         navItemsAll: navItemsAll,
         navItemsDetached: navItemsDetached,
-        hideMenuLeft: activeHeading.hideMenuLeft,
+        pageDesign: activeHeading.pageDesign,
         linksAll: linksAll,
         isLandingPage: isLandingPage,
         pageTitle: pageTitle,

package/dist/config/resolvePageContext.d.ts

@@ -12,7 +12,11 @@ type PageContextResolved = ReturnType<typeof resolvePageContext>;
 declare function resolvePageContext(pageContext: PageContextOriginal): {
     navItemsAll: import("../NavItemComponent").NavItem[];
     navItemsDetached: import("../NavItemComponent").NavItem[] | undefined;
-    hideMenuLeft: true | undefined;
+    pageDesign: {
+        hideTitle?: true;
+        hideMenuLeft?: true;
+        contentMaxWidth?: number;
+    } | undefined;
     linksAll: import("../components").LinkData[];
     isLandingPage: boolean;
     pageTitle: string | null;

package/dist/types/Heading.d.ts

@@ -10,12 +10,17 @@ type HeadingResolved = {
     linkBreadcrumb: string[];
     sectionTitles?: string[];
     menuModalFullWidth?: true;
-    hideMenuLeft?: true;
+    pageDesign?: PageDesign;
     category?: string;
     color?: string;
     titleIcon?: string;
     titleIconStyle?: React.CSSProperties;
 } & Tmp;
+type PageDesign = {
+    hideTitle?: true;
+    hideMenuLeft?: true;
+    contentMaxWidth?: number;
+};
 type HeadingDetachedResolved = Omit<HeadingResolved, 'level' | 'linkBreadcrumb'> & {
     level: 2;
     linkBreadcrumb: null;
@@ -23,7 +28,7 @@ type HeadingDetachedResolved = Omit<HeadingResolved, 'level' | 'linkBreadcrumb'>
 type HeadingDefinitionCommon = {
     title: string;
     menuModalFullWidth?: true;
-    hideMenuLeft?: true;
+    pageDesign?: PageDesign;
 };
 type HeadingDetachedDefinition = HeadingDefinitionCommon & {
     url: string;

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@brillout/docpress",
-  "version": "0.11.3",
+  "version": "0.11.5",
   "type": "module",
   "dependencies": {
     "@brillout/picocolors": "^1.0.10",
-    "@docsearch/css": "^3.6.1",
+    "@docsearch/css": "3.6.1",
     "@docsearch/react": "3.6.1",
     "@mdx-js/mdx": "3.0.1",
     "@mdx-js/react": "3.0.1",

package/types/Heading.ts

@@ -11,13 +11,19 @@ type HeadingResolved = {
   linkBreadcrumb: string[]
   sectionTitles?: string[]
   menuModalFullWidth?: true
-  hideMenuLeft?: true
+  pageDesign?: PageDesign
   category?: string
   color?: string
   titleIcon?: string
   titleIconStyle?: React.CSSProperties
 } & Tmp
 
+type PageDesign = {
+  hideTitle?: true
+  hideMenuLeft?: true
+  contentMaxWidth?: number
+}
+
 type HeadingDetachedResolved = Omit<HeadingResolved, 'level' | 'linkBreadcrumb'> & {
   level: 2
   linkBreadcrumb: null
@@ -26,7 +32,7 @@ type HeadingDetachedResolved = Omit<HeadingResolved, 'level' | 'linkBreadcrumb'>
 type HeadingDefinitionCommon = {
   title: string
   menuModalFullWidth?: true
-  hideMenuLeft?: true
+  pageDesign?: PageDesign
 }
 
 type HeadingDetachedDefinition = HeadingDefinitionCommon & {