@brillout/docpress 0.13.1 → 0.14.0

package/dist/{config/resolveHeadingsData.js → resolveConf.js}

@@ -18,15 +18,17 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     }
     return to.concat(ar || Array.prototype.slice.call(from));
 };
-export { resolveHeadingsData };
-import { assert, isBrowser, jsxToTextContent } from '../utils/server';
+export { resolveConf };
+import { assert } from './utils/assert';
+import { jsxToTextContent } from './utils/jsxToTextContent';
 import pc from '@brillout/picocolors';
-import { parseMarkdownMini } from '../parseMarkdownMini';
-import { determineNavItemsColumnLayout } from '../renderer/determineNavItemsColumnLayout';
-assert(!isBrowser());
-function resolveHeadingsData(pageContext) {
-    var _a, _b;
-    var config = pageContext.config.docpress;
+import { parseMarkdownMini } from './parseMarkdownMini';
+import { determineNavItemsColumnLayout } from './determineNavItemsColumnLayout';
+function resolveConf(pageContext) {
+    var _a;
+    var config = pageContext.globalContext.config.docpress;
+    var urlPathname = pageContext.urlPathname;
+    var pageSections = (_a = pageContext.config.pageSectionsExport) !== null && _a !== void 0 ? _a : [];
     {
         var headings = config.headings, headingsDetached = config.headingsDetached;
         assertHeadingsDefinition(__spreadArray(__spreadArray([], headings, true), headingsDetached, true));
@@ -34,10 +36,12 @@ function resolveHeadingsData(pageContext) {
     var resolved = getHeadingsResolved(config);
     var headingsDetachedResolved = resolved.headingsDetachedResolved;
     var headingsResolved = resolved.headingsResolved;
-    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 _b = getActiveHeading(headingsResolved, headingsDetachedResolved, urlPathname), activeHeading = _b.activeHeading, isDetachedPage = _b.isDetachedPage, activeCategoryName = _b.activeCategoryName;
+    var _c = getTitles(activeHeading, urlPathname, config), documentTitle = _c.documentTitle, isLandingPage = _c.isLandingPage, pageTitle = _c.pageTitle;
+    var pageSectionsResolved = getPageSectionsResolved(pageSections, activeHeading);
+    var linksGlobal = __spreadArray(__spreadArray([], headingsResolved.map(headingToLinkData), true), headingsDetachedResolved.map(headingToLinkData), true);
+    var linksPage = pageSectionsResolved.map(pageSectionToLinkData);
+    var linksAll = __spreadArray(__spreadArray([], linksPage, true), linksGlobal, true);
     var navItemsAll;
     var navItemsDetached;
     {
@@ -50,18 +54,14 @@ function resolveHeadingsData(pageContext) {
             navItemsDetached = __spreadArray([headingToNavItem(activeHeading)], navItemsPageSections, true);
         }
         else {
-            var activeHeadingIndex_1 = navItemsAll.findIndex(function (navItem) { return navItem.url === pageContext.urlPathname; });
+            var activeHeadingIndex_1 = navItemsAll.findIndex(function (navItem) { return navItem.url === urlPathname; });
             assert(activeHeadingIndex_1 >= 0);
             navItemsPageSections.forEach(function (navItem, i) {
                 navItemsAll.splice(activeHeadingIndex_1 + 1 + i, 0, navItem);
             });
         }
     }
-    var activeCategory = (_b = (_a = config.categories) === null || _a === void 0 ? void 0 : _a.map(function (c, i) { return (__assign({ order: i }, (typeof c === 'string' ? { name: c } : c))); }).find(function (c) { return c.name === activeCategoryName; })) !== null && _b !== void 0 ? _b : {
-        name: activeCategoryName,
-        order: 99999999999,
-    };
-    var pageContextAddendum = {
+    var conf = {
         navItemsAll: navItemsAll,
         navItemsDetached: navItemsDetached,
         pageDesign: activeHeading.pageDesign,
@@ -69,10 +69,9 @@ function resolveHeadingsData(pageContext) {
         isLandingPage: isLandingPage,
         pageTitle: pageTitle,
         documentTitle: documentTitle,
-        // TODO: don't pass to client-side
-        activeCategory: activeCategory,
+        activeCategoryName: activeCategoryName,
     };
-    return pageContextAddendum;
+    return conf;
 }
 function headingToNavItem(heading) {
     return {
@@ -109,9 +108,8 @@ function pageSectionToLinkData(pageSection) {
         linkBreadcrumb: pageSection.linkBreadcrumb,
     };
 }
-function getTitles(activeHeading, pageContext, config) {
-    var url = pageContext.urlPathname;
-    var isLandingPage = url === '/';
+function getTitles(activeHeading, urlPathname, config) {
+    var isLandingPage = urlPathname === '/';
     var title = activeHeading.title;
     var pageTitle = isLandingPage ? null : title;
     var documentTitle = activeHeading.titleDocument || jsxToTextContent(parseMarkdownMini(title));
@@ -123,12 +121,11 @@ function getTitles(activeHeading, pageContext, config) {
     }
     return { documentTitle: documentTitle, isLandingPage: isLandingPage, pageTitle: pageTitle };
 }
-function getActiveHeading(headingsResolved, headingsDetachedResolved, pageContext) {
+function getActiveHeading(headingsResolved, headingsDetachedResolved, urlPathname) {
     var _a;
     var activeHeading = null;
     var activeCategoryName = 'Miscellaneous';
     var headingCategory;
-    var urlPathname = pageContext.urlPathname;
     assert(urlPathname);
     for (var _i = 0, headingsResolved_1 = headingsResolved; _i < headingsResolved_1.length; _i++) {
         var heading = headingsResolved_1[_i];
@@ -164,9 +161,7 @@ function getActiveHeading(headingsResolved, headingsDetachedResolved, pageContex
         activeCategoryName = activeHeading.category;
     return { activeHeading: activeHeading, isDetachedPage: isDetachedPage, activeCategoryName: activeCategoryName };
 }
-function getPageSectionsResolved(pageContext, activeHeading) {
-    var _a;
-    var pageSections = (_a = pageContext.exports.pageSectionsExport) !== null && _a !== void 0 ? _a : [];
+function getPageSectionsResolved(pageSections, activeHeading) {
     var pageSectionsResolved = pageSections.map(function (pageSection) {
         var _a;
         var pageSectionTitle = pageSection.pageSectionTitle;

package/dist/types/Config.d.ts

@@ -11,6 +11,7 @@ type Config = {
         twitterProfile: string;
         blueskyHandle?: string;
     };
+    docsDir?: string;
     logoUrl?: string;
     faviconUrl?: string;
     algolia: null | {
@@ -27,6 +28,7 @@ type Config = {
     bannerUrl?: string;
     twitterHandle: string;
     globalNote?: React.ReactNode;
+    topNavigation?: React.ReactNode;
     i18n?: true;
     pressKit?: true;
     sponsorGithubAccount?: string;

package/dist/types/Heading.d.ts

@@ -15,7 +15,8 @@ type HeadingResolved = {
     color?: string;
     titleIcon?: string;
     titleIconStyle?: React.CSSProperties;
-} & Tmp;
+    titleDocument?: string;
+};
 type PageDesign = {
     hideTitle?: true;
     hideMenuLeft?: true;
@@ -35,16 +36,7 @@ type HeadingDetachedDefinition = HeadingDefinitionCommon & {
     sectionTitles?: string[];
     category?: string;
 };
-type HeadingDefinition = HeadingDefinitionCommon & {
-    url?: null | string;
-    titleInNav?: string;
-} & HeadingDefinitionLevel & Tmp;
-type IsCategory = {
-    url?: undefined;
-    titleDocument?: undefined;
-    titleInNav?: undefined;
-};
-type HeadingDefinitionLevel = ({
+type HeadingDefinition = HeadingDefinitionCommon & {} & (({
     level: 1;
     color: string;
     titleIcon?: string;
@@ -53,9 +45,12 @@ type HeadingDefinitionLevel = ({
     level: 4;
 } & IsCategory) | {
     level: 2;
+    titleInNav?: string;
+    titleDocument?: string;
     sectionTitles?: string[];
     url: null | string;
-};
-type Tmp = {
-    titleDocument?: string;
+});
+type IsCategory = {
+    url?: undefined;
+    titleInNav?: undefined;
 };

package/docsearch/DocSearchInstall.tsx

@@ -7,7 +7,7 @@ import { Hit } from '../components/Algolia/Hit'
 
 function DocSearchInstall() {
   const pageContext = usePageContext()
-  const { algolia } = pageContext.meta
+  const { algolia } = pageContext.globalContext.config.docpress
   if (!algolia) return null
   return (
     <div style={{ display: 'none' }}>

package/index.ts

@@ -8,7 +8,11 @@ export {
   Emoji,
 } from './components'
 export { MenuToggle } from './Layout'
-export { usePageContext, usePageContext2 } from './renderer/usePageContext'
+
+// The only place usePageContext() is used at:
+// https://github.com/vikejs/vike/blob/0b1b109f64aafbed23a1c2ac2630e6146a270ec0/packages/vike.dev/components/CommunityNote.tsx#L4
+export { usePageContext } from './renderer/usePageContext'
+
 export * from './components/Note'
 export * from './icons/index'
 export { assert } from './utils/assert'

package/installSectionUrlHashs.ts

@@ -2,6 +2,7 @@ export { installSectionUrlHashs }
 
 import { assert } from './utils/client'
 
+// TO-DO/eventually: use React instead of manually installing click handlers?
 function installSectionUrlHashs() {
   {
     const isLandingPage = window.location.pathname === '/'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brillout/docpress",
-  "version": "0.13.1",
+  "version": "0.14.0",
   "type": "module",
   "dependencies": {
     "@brillout/picocolors": "^1.0.10",
@@ -10,18 +10,18 @@
     "@mdx-js/react": "3.0.1",
     "@mdx-js/rollup": "3.0.1",
     "@shikijs/transformers": "1.2.0",
-    "@vitejs/plugin-react-swc": ">=3.0.0",
+    "@vitejs/plugin-react-swc": "^3.10.2",
     "rehype-pretty-code": "0.13.0",
     "remark-gfm": "4.0.0",
     "shiki": "1.2.0",
-    "vite": ">=5.2.0"
+    "vite": "^6.3.5"
   },
   "peerDependencies": {
     "@vitejs/plugin-react-swc": ">=3.0.0",
     "react": ">=18.0.0",
     "react-dom": ">=18.0.0",
     "typescript": ">=5.0.0",
-    "vike": ">=0.4.222",
+    "vike": ">=0.4.234",
     "vite": ">=5.2.0"
   },
   "peerDependenciesMeta": {
@@ -35,8 +35,7 @@
   "exports": {
     "./renderer/onRenderHtml": "./renderer/onRenderHtml.tsx",
     "./renderer/onRenderClient": "./renderer/onRenderClient.tsx",
-    "./renderer/onBeforeRender": "./renderer/onBeforeRender.ts",
-    "./Layout": "./Layout.tsx",
+    "./renderer/onCreatePageContext": "./renderer/onCreatePageContext.ts",
     ".": "./index.ts",
     "./config": "./dist/+config.js",
     "./style": "./css/index.css",
@@ -73,9 +72,8 @@
     "// Build vite.config.ts and +config.ts (other files don't need to be built as @brillout/docpress is noExternal)": "",
     "build": "rm -rf dist/ && tsc --project tsconfig.config.json",
     "======== Develop": "",
-    "dev": "tsc --watch --project tsconfig.config.json",
-    "// Check types of all source files while developing": "",
-    "typecheck": "tsc --noEmit --watch",
+    "// Typecheck + build vite.config.ts and +config.ts": "",
+    "dev": "tsc --watch",
     "========= Release": "",
     "release": "release-me patch",
     "release:minor": "release-me minor",

package/parsePageSections.ts

@@ -47,7 +47,7 @@ function transform(code: string) {
 
       if (
         line.startsWith('#')
-        /* TODO/eventually: implement.
+        /* TO-DO/eventually: implement.
         || line.startsWith('<h2')
         */
       ) {

package/renderer/getPageElement.tsx

@@ -1,18 +1,16 @@
 export { getPageElement }
 
 import type { PageContext } from 'vike/types'
-import type { PageContextResolved } from '../config/resolvePageContext'
-import { PageContextProvider, PageContextProvider2 } from './usePageContext'
+import { PageContextProvider } from './usePageContext'
 import React from 'react'
 import { DocSearchInstall } from '../docsearch/DocSearchInstall'
-import { PassThrough } from '../utils/PassTrough'
+import { Layout } from '../Layout'
 
-function getPageElement(pageContext: PageContext, pageContextResolved: PageContextResolved) {
+function getPageElement(pageContext: PageContext) {
   const { Page } = pageContext
-  const Layout = pageContext.config.Layout || PassThrough
   const page = (
-    <Wrapper {...{ pageContext, pageContextResolved }}>
-      <Layout pageContext={pageContextResolved} pageContext2={pageContext}>
+    <Wrapper {...{ pageContext }}>
+      <Layout>
         <Page />
       </Layout>
       <DocSearchInstall />
@@ -21,16 +19,10 @@ function getPageElement(pageContext: PageContext, pageContextResolved: PageConte
   return page
 }
 
-function Wrapper({
-  children,
-  pageContext,
-  pageContextResolved,
-}: { children: React.ReactNode; pageContext: PageContext; pageContextResolved: PageContextResolved }) {
+function Wrapper({ children, pageContext }: { children: React.ReactNode; pageContext: PageContext }) {
   return (
     <React.StrictMode>
-      <PageContextProvider2 pageContext={pageContext}>
-        <PageContextProvider pageContext={pageContextResolved}>{children}</PageContextProvider>
-      </PageContextProvider2>
+      <PageContextProvider pageContext={pageContext}>{children}</PageContextProvider>
     </React.StrictMode>
   )
 }

package/renderer/onCreatePageContext.ts

@@ -0,0 +1,8 @@
+export { onCreatePageContext }
+
+import type { PageContextServer } from 'vike/types'
+import { resolveConf } from '../resolveConf'
+
+function onCreatePageContext(pageContext: PageContextServer) {
+  pageContext.conf = resolveConf(pageContext)
+}

package/renderer/onRenderClient.tsx

@@ -3,7 +3,6 @@ export { onRenderClient }
 import React, { useEffect } from 'react'
 import type { PageContextClient } from 'vike/types'
 import ReactDOM from 'react-dom/client'
-import { PageContextResolved } from '../config/resolvePageContext'
 import { getPageElement } from './getPageElement'
 import { closeMenuModal } from '../MenuModal/toggleMenuModal'
 import '../css/index.css'
@@ -25,13 +24,11 @@ initOnNavigation()
 async function onRenderClient(pageContext: PageContextClient) {
   onRenderStart()
 
-  // TODO: stop using any
-  const pageContextResolved: PageContextResolved = (pageContext as any).pageContextResolved
   let renderPromiseResolve!: () => void
   const renderPromise = new Promise<void>((r) => {
     renderPromiseResolve = r
   })
-  let page = getPageElement(pageContext, pageContextResolved)
+  let page = getPageElement(pageContext)
   page = <OnRenderDoneHook renderPromiseResolve={renderPromiseResolve}>{page}</OnRenderDoneHook>
   const container = document.getElementById('page-view')!
   if (pageContext.isHydration) {
@@ -49,9 +46,7 @@ async function onRenderClient(pageContext: PageContextClient) {
 }
 
 function applyHead(pageContext: PageContextClient) {
-  // TODO: stop using any
-  const pageContextResolved: PageContextResolved = (pageContext as any).pageContextResolved
-  document.title = pageContextResolved.documentTitle
+  document.title = pageContext.conf.documentTitle
 }
 
 function onRenderStart() {
@@ -61,7 +56,6 @@ function onRenderStart() {
 
 function onRenderDone(renderPromiseResolve: () => void) {
   autoScrollNav()
-  // TODO/refactor: use React?
   installSectionUrlHashs()
   setHydrationIsFinished()
   renderPromiseResolve()

package/renderer/onRenderHtml.tsx

@@ -3,37 +3,36 @@ export { onRenderHtml }
 import ReactDOMServer from 'react-dom/server'
 import { escapeInject, dangerouslySkipEscape } from 'vike/server'
 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'
+import type { PageContextServer } from 'vike/types'
 
-const onRenderHtml: OnRenderHtmlAsync = async (
-  pageContext,
-): // TODO: Why is Promise<Awaited<>> needed?
-Promise<Awaited<ReturnType<OnRenderHtmlAsync>>> => {
-  const pageContextResolved: PageContextResolved = (pageContext as any).pageContextResolved
+async function onRenderHtml(pageContext: PageContextServer): Promise<any> {
+  const page = getPageElement(pageContext)
 
-  const page = getPageElement(pageContext, pageContextResolved)
-
-  const descriptionTag = pageContextResolved.isLandingPage
-    ? dangerouslySkipEscape(`<meta name="description" content="${pageContextResolved.meta.tagline}" />`)
-    : ''
+  const { isLandingPage } = pageContext.conf
+  assert(typeof isLandingPage === 'boolean')
+  const { tagline } = pageContext.globalContext.config.docpress
+  assert(tagline)
+  const descriptionTag = isLandingPage ? escapeInject`<meta name="description" content="${tagline}" />` : ''
 
   const pageHtml = ReactDOMServer.renderToString(page)
 
-  const faviconUrl = pageContextResolved.config.faviconUrl ?? pageContextResolved.config.logoUrl
+  const faviconUrl =
+    pageContext.globalContext.config.docpress.faviconUrl ?? pageContext.globalContext.config.docpress.logoUrl
+  assert(faviconUrl)
 
+  const { documentTitle } = pageContext.conf
+  assert(documentTitle)
   return escapeInject`<!DOCTYPE html>
     <html>
       <head>
         <meta charset="UTF-8" />
         <link rel="icon" href="${faviconUrl ?? ''}" />
-        <title>${pageContextResolved.documentTitle}</title>
+        <title>${documentTitle}</title>
         ${descriptionTag}
         <meta name="viewport" content="width=device-width,initial-scale=1">
-        ${getOpenGraphTags(pageContext.urlPathname, pageContextResolved.documentTitle, pageContextResolved.meta)}
-        ${getAlgoliaTags(pageContextResolved.activeCategory)}
+        ${getOpenGraphTags(pageContext.urlPathname, documentTitle, pageContext.globalContext.config.docpress)}
+        ${getAlgoliaTags(pageContext)}
       </head>
       <body>
         <div id="page-view">${dangerouslySkipEscape(pageHtml)}</div>
@@ -41,7 +40,8 @@ Promise<Awaited<ReturnType<OnRenderHtmlAsync>>> => {
     </html>`
 }
 
-function getAlgoliaTags(activeCategory: ActiveCategory) {
+function getAlgoliaTags(pageContext: PageContextServer) {
+  const activeCategory = getActiveCategory(pageContext)
   const categoryNameTag = escapeInject`<meta name="algolia:category" content="${activeCategory.name}">`
   if (activeCategory.hide) {
     return escapeInject`${categoryNameTag}<meta name="algolia:category:hide"> `
@@ -49,6 +49,28 @@ function getAlgoliaTags(activeCategory: ActiveCategory) {
     return escapeInject`${categoryNameTag}<meta name="algolia:category:order" content="${activeCategory.order.toString()}"> `
   }
 }
+type ActiveCategory = {
+  name: string
+  order: number
+  hide?: boolean
+}
+function getActiveCategory(pageContext: PageContextServer) {
+  const config = pageContext.globalContext.config.docpress
+  const { activeCategoryName } = pageContext.conf
+
+  const activeCategory: ActiveCategory = config.categories
+    // normalize
+    ?.map((c, i) => ({
+      order: i,
+      ...(typeof c === 'string' ? { name: c } : c),
+    }))
+    .find((c) => c.name === activeCategoryName) ?? {
+    name: activeCategoryName,
+    order: 99999999999,
+  }
+
+  return activeCategory
+}
 
 function getOpenGraphTags(
   url: string,
@@ -56,18 +78,26 @@ function getOpenGraphTags(
   meta: { tagline: string; websiteUrl: string; twitterHandle: string; bannerUrl?: string },
 ) {
   const { tagline, websiteUrl, twitterHandle, bannerUrl } = meta
-
   assert(url.startsWith('/'))
-  if (!bannerUrl) return ''
 
+  const metaBanner = !bannerUrl
+    ? ''
+    : escapeInject`
+    <meta property="og:image" content="${bannerUrl}">
+    <meta name="twitter:card" content="summary_large_image">
+  `
+  const metaTwitter = !twitterHandle
+    ? ''
+    : escapeInject`
+    <meta name="twitter:site" content="${twitterHandle}">
+  `
   // See view-source:https://vitejs.dev/
   return escapeInject`
     <meta property="og:type" content="website">
     <meta property="og:title" content="${documentTitle}">
-    <meta property="og:image" content="${bannerUrl}">
     <meta property="og:url" content="${websiteUrl}">
     <meta property="og:description" content="${tagline}">
-    <meta name="twitter:card" content="summary_large_image">
-    <meta name="twitter:site" content="${twitterHandle}">
+    ${metaBanner}
+    ${metaTwitter}
   `
 }

package/renderer/usePageContext.tsx

@@ -1,48 +1,32 @@
-export { usePageContext }
 export { PageContextProvider }
+export { usePageContext }
+export { usePageContextLegacy }
 
 import React, { useContext } from 'react'
-import type { PageContextResolved } from '../config/resolvePageContext'
 import type { PageContext } from 'vike/types'
 import { getGlobalObject } from '../utils/getGlobalObject'
 
 const globalObject = getGlobalObject('usePageContext.ts', {
-  Context: React.createContext<PageContextResolved>(undefined as any),
-  Context2: React.createContext<PageContext>(undefined as any),
+  Ctx: React.createContext<PageContext>(undefined as any),
 })
 
-function PageContextProvider({
-  pageContext,
-  children,
-}: {
-  pageContext: PageContextResolved
-  children: React.ReactNode
-}) {
-  const { Context } = globalObject
-  return <Context.Provider value={pageContext}>{children}</Context.Provider>
-}
-
-function usePageContext(): PageContextResolved {
-  const { Context } = globalObject
-  const pageContext = useContext(Context)
-  return pageContext
+function usePageContextLegacy() {
+  const { Ctx } = globalObject
+  const pageContext = useContext(Ctx)
+  return pageContext.conf
 }
 
-export { PageContextProvider2 }
-// TODO/refactor: rename to usePageContext and remove old implementation
-export { usePageContext2 }
-
-function usePageContext2(): PageContext {
-  const pageContext = useContext(globalObject.Context2)
+function usePageContext(): PageContext {
+  const pageContext = useContext(globalObject.Ctx)
   return pageContext
 }
-function PageContextProvider2({
+function PageContextProvider({
   pageContext,
   children,
 }: {
   pageContext: PageContext
   children: React.ReactNode
 }) {
-  const { Context2 } = globalObject
-  return <Context2.Provider value={pageContext}>{children}</Context2.Provider>
+  const { Ctx } = globalObject
+  return <Ctx.Provider value={pageContext}>{children}</Ctx.Provider>
 }