@brillout/docpress 0.10.18 → 0.10.20

package/config/resolveHeadingsData.ts

@@ -1,4 +1,5 @@
 export { resolveHeadingsData }
+export type { ActiveCategory }
 
 import { assert, isBrowser, jsxToTextContent } from '../utils/server'
 import type {
@@ -7,7 +8,7 @@ import type {
   HeadingResolved,
   HeadingDetachedResolved,
 } from '../types/Heading'
-import type { Config } from '../types/Config'
+import type { Category, Config } from '../types/Config'
 import { getConfig } from './getConfig'
 import type { NavItem } from '../NavItemComponent'
 import type { LinkData } from '../components'
@@ -25,6 +26,12 @@ type PageSectionResolved = {
   pageSectionLevel: number
 }
 
+type ActiveCategory = {
+  name: string
+  order: NonNullable<Category['order']>
+  hide: Category['hide']
+}
+
 function resolveHeadingsData(pageContext: PageContextOriginal) {
   const config = getConfig()
 
@@ -37,7 +44,7 @@ function resolveHeadingsData(pageContext: PageContextOriginal) {
   const { headingsDetachedResolved } = resolved
   let { headingsResolved } = resolved
 
-  const { activeHeading, isDetachedPage, activeCategory } = getActiveHeading(
+  const { activeHeading, isDetachedPage, activeCategoryName } = getActiveHeading(
     headingsResolved,
     headingsDetachedResolved,
     pageContext,
@@ -72,6 +79,13 @@ function resolveHeadingsData(pageContext: PageContextOriginal) {
     }
   }
 
+  const categoryInfo = config.categories?.[activeCategoryName]
+  const activeCategory: ActiveCategory = {
+    name: activeCategoryName,
+    order: categoryInfo?.order ?? 0,
+    hide: categoryInfo?.hide,
+  }
+
   const pageContextAddendum = {
     navItemsAll,
     navItemsDetached,
@@ -150,7 +164,7 @@ function getActiveHeading(
   pageContext: { urlPathname: string; exports: Exports },
 ) {
   let activeHeading: HeadingResolved | HeadingDetachedResolved | null = null
-  let activeCategory = 'Miscellaneous'
+  let activeCategoryName = 'Miscellaneous'
   let headingCategory: string | undefined
   const { urlPathname } = pageContext
   assert(urlPathname)
@@ -161,7 +175,7 @@ function getActiveHeading(
     if (heading.url === urlPathname) {
       activeHeading = heading
       assert(headingCategory)
-      activeCategory = headingCategory
+      activeCategoryName = headingCategory
       assert(heading.level === 2, { pageUrl: urlPathname, heading })
       break
     }
@@ -183,8 +197,8 @@ function getActiveHeading(
       ].join('\n'),
     )
   }
-  if (activeHeading.category) activeCategory = activeHeading.category
-  return { activeHeading, isDetachedPage, activeCategory }
+  if (activeHeading.category) activeCategoryName = activeHeading.category
+  return { activeHeading, isDetachedPage, activeCategoryName }
 }
 
 function getPageSectionsResolved(

package/dist/config/resolveHeadingsData.d.ts

@@ -1,7 +1,14 @@
 export { resolveHeadingsData };
+export type { ActiveCategory };
+import type { Category } from '../types/Config';
 import type { NavItem } from '../NavItemComponent';
 import type { LinkData } from '../components';
 import type { PageContextOriginal } from './resolvePageContext';
+type ActiveCategory = {
+    name: string;
+    order: NonNullable<Category['order']>;
+    hide: Category['hide'];
+};
 declare function resolveHeadingsData(pageContext: PageContextOriginal): {
     navItemsAll: NavItem[];
     navItemsDetached: NavItem[] | undefined;
@@ -9,5 +16,5 @@ declare function resolveHeadingsData(pageContext: PageContextOriginal): {
     isLandingPage: boolean;
     pageTitle: string | null;
     documentTitle: string;
-    activeCategory: string;
+    activeCategory: ActiveCategory;
 };

package/dist/config/resolveHeadingsData.js

@@ -26,6 +26,7 @@ import { parseMarkdownMini } from '../parseMarkdownMini';
 import { determineNavItemsColumnLayout } from '../renderer/determineNavItemsColumnLayout';
 assert(!isBrowser());
 function resolveHeadingsData(pageContext) {
+    var _a, _b;
     var config = getConfig();
     {
         var headings = config.headings, headingsDetached = config.headingsDetached;
@@ -34,8 +35,8 @@ function resolveHeadingsData(pageContext) {
     var resolved = getHeadingsResolved(config);
     var headingsDetachedResolved = resolved.headingsDetachedResolved;
     var headingsResolved = resolved.headingsResolved;
-    var _a = getActiveHeading(headingsResolved, headingsDetachedResolved, pageContext), activeHeading = _a.activeHeading, isDetachedPage = _a.isDetachedPage, activeCategory = _a.activeCategory;
-    var _b = getTitles(activeHeading, pageContext, config), documentTitle = _b.documentTitle, isLandingPage = _b.isLandingPage, pageTitle = _b.pageTitle;
+    var _c = getActiveHeading(headingsResolved, headingsDetachedResolved, pageContext), activeHeading = _c.activeHeading, isDetachedPage = _c.isDetachedPage, activeCategoryName = _c.activeCategoryName;
+    var _d = getTitles(activeHeading, pageContext, config), documentTitle = _d.documentTitle, isLandingPage = _d.isLandingPage, pageTitle = _d.pageTitle;
     var pageSectionsResolved = getPageSectionsResolved(pageContext, activeHeading);
     var linksAll = __spreadArray(__spreadArray(__spreadArray([], pageSectionsResolved.map(pageSectionToLinkData), true), headingsResolved.map(headingToLinkData), true), headingsDetachedResolved.map(headingToLinkData), true);
     var navItemsAll;
@@ -57,6 +58,12 @@ function resolveHeadingsData(pageContext) {
             });
         }
     }
+    var categoryInfo = (_a = config.categories) === null || _a === void 0 ? void 0 : _a[activeCategoryName];
+    var activeCategory = {
+        name: activeCategoryName,
+        order: (_b = categoryInfo === null || categoryInfo === void 0 ? void 0 : categoryInfo.order) !== null && _b !== void 0 ? _b : 0,
+        hide: categoryInfo === null || categoryInfo === void 0 ? void 0 : categoryInfo.hide,
+    };
     var pageContextAddendum = {
         navItemsAll: navItemsAll,
         navItemsDetached: navItemsDetached,
@@ -121,7 +128,7 @@ function getTitles(activeHeading, pageContext, config) {
 function getActiveHeading(headingsResolved, headingsDetachedResolved, pageContext) {
     var _a;
     var activeHeading = null;
-    var activeCategory = 'Miscellaneous';
+    var activeCategoryName = 'Miscellaneous';
     var headingCategory;
     var urlPathname = pageContext.urlPathname;
     assert(urlPathname);
@@ -133,7 +140,7 @@ function getActiveHeading(headingsResolved, headingsDetachedResolved, pageContex
         if (heading.url === urlPathname) {
             activeHeading = heading;
             assert(headingCategory);
-            activeCategory = headingCategory;
+            activeCategoryName = headingCategory;
             assert(heading.level === 2, { pageUrl: urlPathname, heading: heading });
             break;
         }
@@ -156,8 +163,8 @@ function getActiveHeading(headingsResolved, headingsDetachedResolved, pageContex
         ].join('\n'));
     }
     if (activeHeading.category)
-        activeCategory = activeHeading.category;
-    return { activeHeading: activeHeading, isDetachedPage: isDetachedPage, activeCategory: activeCategory };
+        activeCategoryName = activeHeading.category;
+    return { activeHeading: activeHeading, isDetachedPage: isDetachedPage, activeCategoryName: activeCategoryName };
 }
 function getPageSectionsResolved(pageContext, activeHeading) {
     var _a;

package/dist/config/resolvePageContext.d.ts

@@ -16,7 +16,7 @@ declare function resolvePageContext(pageContext: PageContextOriginal): {
     isLandingPage: boolean;
     pageTitle: string | null;
     documentTitle: string;
-    activeCategory: string;
+    activeCategory: import("./resolveHeadingsData").ActiveCategory;
 } & {
     urlPathname: string;
     meta: {

package/dist/types/Config.d.ts

@@ -1,4 +1,5 @@
 export type { Config };
+export type { Category };
 import type { HeadingDefinition, HeadingDetachedDefinition } from './Heading';
 type Config = {
     projectInfo: {
@@ -20,6 +21,7 @@ type Config = {
     };
     headings: HeadingDefinition[];
     headingsDetached: HeadingDetachedDefinition[];
+    categories?: Record<string, Category>;
     /** Sets `<meta name="description" content="${tagline}" />` */
     tagline: string;
     websiteUrl: string;
@@ -34,3 +36,9 @@ type Config = {
     navLogoStyle?: React.CSSProperties;
     navLogoTextStyle?: React.CSSProperties;
 };
+type Category = {
+    /** Order in Algolia search results */
+    order?: number;
+    /** Hide from Algolia search */
+    hide?: boolean;
+};

package/dist/types/Heading.d.ts

@@ -26,6 +26,7 @@ type HeadingDefinitionCommon = {
 type HeadingDetachedDefinition = HeadingDefinitionCommon & {
     url: string;
     sectionTitles?: string[];
+    category?: string;
 };
 type HeadingDefinition = HeadingDefinitionCommon & {
     url?: null | string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brillout/docpress",
-  "version": "0.10.18",
+  "version": "0.10.20",
   "type": "module",
   "dependencies": {
     "@brillout/picocolors": "^1.0.10",

package/renderer/onRenderHtml.tsx

@@ -6,6 +6,7 @@ import { assert } from '../utils/server'
 import type { PageContextResolved } from '../config/resolvePageContext'
 import { getPageElement } from './getPageElement'
 import type { OnRenderHtmlAsync } from 'vike/types'
+import { ActiveCategory } from '../config/resolveHeadingsData'
 
 const onRenderHtml: OnRenderHtmlAsync = async (
   pageContext,
@@ -32,7 +33,7 @@ Promise<Awaited<ReturnType<OnRenderHtmlAsync>>> => {
         ${descriptionTag}
         <meta name="viewport" content="width=device-width,initial-scale=1">
         ${getOpenGraphTags(pageContext.urlPathname, pageContextResolved.documentTitle, pageContextResolved.meta)}
-        <meta name="docsearch:category" content="${pageContextResolved.activeCategory}" />
+        ${getAlgoliaTags(pageContextResolved.activeCategory)}
       </head>
       <body>
         <div id="page-view">${dangerouslySkipEscape(pageHtml)}</div>
@@ -40,6 +41,15 @@ Promise<Awaited<ReturnType<OnRenderHtmlAsync>>> => {
     </html>`
 }
 
+function getAlgoliaTags(activeCategory: ActiveCategory) {
+  const categoryNameTag = escapeInject`<meta name="algolia:category" content="${activeCategory.name}">`
+  if (activeCategory.hide) {
+    return escapeInject`${categoryNameTag}<meta name="algolia:category:hide"> `
+  } else {
+    return escapeInject`${categoryNameTag}<meta name="algolia:category:order" content="${activeCategory.order.toString()}"> `
+  }
+}
+
 function getOpenGraphTags(
   url: string,
   documentTitle: string,

package/types/Config.ts

@@ -1,4 +1,5 @@
 export type { Config }
+export type { Category }
 
 import type { HeadingDefinition, HeadingDetachedDefinition } from './Heading'
 
@@ -22,6 +23,7 @@ type Config = {
   }
   headings: HeadingDefinition[]
   headingsDetached: HeadingDetachedDefinition[]
+  categories?: Record<string, Category>
   /** Sets `<meta name="description" content="${tagline}" />` */
   tagline: string
   websiteUrl: string
@@ -36,3 +38,10 @@ type Config = {
   navLogoStyle?: React.CSSProperties
   navLogoTextStyle?: React.CSSProperties
 }
+
+type Category = {
+  /** Order in Algolia search results */
+  order?: number
+  /** Hide from Algolia search */
+  hide?: boolean
+}

package/types/Heading.ts

@@ -30,6 +30,7 @@ type HeadingDefinitionCommon = {
 type HeadingDetachedDefinition = HeadingDefinitionCommon & {
   url: string
   sectionTitles?: string[]
+  category?: string
 }
 
 type HeadingDefinition = HeadingDefinitionCommon & {