@brillout/docpress 0.13.1 → 0.14.0

package/+config.ts

@@ -1,31 +1,24 @@
 export { config as default }
 
-import type { Config, ImportString } from 'vike/types'
-import type { Exports } from './config/resolvePageContext'
+import type { Config } from 'vike/types'
 import { viteConfig } from './vite.config.js'
 import type { Config as DocpressConfig } from './types/Config'
+import type { PageSection } from './parsePageSections'
+import type { Conf } from './resolveConf.js'
 
 const config = {
   name: '@brillout/docpress',
-  require: { vike: '>=0.4.222' },
+  require: { vike: '>=0.4.234' },
   vite: viteConfig as Record<string, unknown>,
   prerender: { noExtraDir: true },
   onRenderHtml: 'import:@brillout/docpress/renderer/onRenderHtml:onRenderHtml',
   onRenderClient: 'import:@brillout/docpress/renderer/onRenderClient:onRenderClient',
-  onBeforeRender: 'import:@brillout/docpress/renderer/onBeforeRender:onBeforeRender',
-  Layout: 'import:@brillout/docpress/Layout:Layout',
+  onCreatePageContext: 'import:@brillout/docpress/renderer/onCreatePageContext:onCreatePageContext',
   clientRouting: true,
   hydrationCanBeAborted: true,
-  passToClient: ['pageContextResolved'],
   meta: {
-    Layout: {
-      env: { client: true, server: true },
-    },
-    TopNavigation: {
-      env: { client: true, server: true },
-    },
     docpress: {
-      env: { server: true },
+      env: { server: true, client: true },
       global: true,
     },
   },
@@ -40,12 +33,14 @@ declare global {
   namespace Vike {
     interface PageContext {
       Page: ReactComponent
-      exports: Exports
+      conf: Conf
     }
     interface Config {
-      Layout?: ReactComponent | null | ImportString
-      TopNavigation?: ReactComponent
       docpress?: DocpressConfig
     }
+    interface ConfigResolved {
+      docpress: DocpressConfig
+      pageSectionsExport: PageSection[] | undefined
+    }
   }
 }

package/EditLink.tsx

@@ -22,7 +22,8 @@ function EditLink({ className, style }: { className?: string; style: React.CSSPr
   )
   const { urlPathname } = pageContext
   const fsPath = urlPathname === '/' ? '/index/+Page.tsx' : `${urlPathname}/+Page.mdx`
-  const editLink = getRepoHref(`/docs/pages${fsPath}`, true)
+  const docsDir = pageContext.globalContext.config.docpress.docsDir ?? 'docs'
+  const editLink = getRepoHref(`/${docsDir}/pages${fsPath}`, true)
   return (
     <a href={editLink} className={className} style={{ display: 'flex', alignItems: 'center', ...style }}>
       {icon} Edit this page

package/ExternalLinks.tsx

@@ -12,7 +12,7 @@ import '@docsearch/css'
 
 function ExternalLinks(props: { style?: React.CSSProperties }) {
   const pageContext = usePageContext()
-  const { projectInfo, i18n } = pageContext.config
+  const { projectInfo, i18n } = pageContext.globalContext.config.docpress
   const iconI18n = !i18n ? null : (
     <LinkIcon
       className="decolorize-4"
@@ -50,7 +50,7 @@ function ExternalLinks(props: { style?: React.CSSProperties }) {
 
 function ChangelogButton() {
   const pageContext = usePageContext()
-  const { projectInfo } = pageContext.config
+  const { projectInfo } = pageContext.globalContext.config.docpress
   return (
     <a
       href={`${projectInfo.githubRepository}/blob/main/CHANGELOG.md`}

package/Layout.tsx

@@ -10,7 +10,7 @@ export { blockMargin }
 import React from 'react'
 import { getNavItemsWithComputed, NavItem, NavItemComponent } from './NavItemComponent'
 import { parseMarkdownMini } from './parseMarkdownMini'
-import { usePageContext, usePageContext2 } from './renderer/usePageContext'
+import { usePageContext } from './renderer/usePageContext'
 import { ExternalLinks } from './ExternalLinks'
 import { coseMenuModalOnMouseLeave, openMenuModal, toggleMenuModal } from './MenuModal/toggleMenuModal'
 import { MenuModal } from './MenuModal'
@@ -47,7 +47,7 @@ const whitespaceBuster2: React.CSSProperties = {
 
 function Layout({ children }: { children: React.ReactNode }) {
   const pageContext = usePageContext()
-  const { isLandingPage } = pageContext
+  const { isLandingPage } = pageContext.conf
 
   let content: React.JSX.Element
   if (isLandingPage) {
@@ -86,7 +86,8 @@ function Layout({ children }: { children: React.ReactNode }) {
 function LayoutDocsPage({ children }: { children: React.ReactNode }) {
   const pageContext = usePageContext()
   const hideNavLeftAlways =
-    pageContext.pageDesign?.hideMenuLeft || (pageContext.navItemsDetached && pageContext.navItemsDetached.length <= 1)
+    pageContext.conf.pageDesign?.hideMenuLeft ||
+    (pageContext.conf.navItemsDetached && pageContext.conf.navItemsDetached.length <= 1)
   return (
     <>
       <Style>{getStyle()}</Style>
@@ -155,11 +156,13 @@ function LayoutLandingPage({ children }: { children: React.ReactNode }) {
 
 function PageContent({ children }: { children: React.ReactNode }) {
   const pageContext = usePageContext()
-  const { isLandingPage, pageTitle } = pageContext
+  const { isLandingPage, pageTitle } = pageContext.conf
   const pageTitleParsed = pageTitle && parseMarkdownMini(pageTitle)
-  const { globalNote } = pageContext.config
+  /*
+  const { globalNote } = pageContext.globalContext.config.docpress
+  */
   const ifDocPage = (style: React.CSSProperties) => (isLandingPage ? {} : style)
-  const contentMaxWidth = pageContext.pageDesign?.contentMaxWidth ?? mainViewWidthMax
+  const contentMaxWidth = pageContext.conf.pageDesign?.contentMaxWidth ?? mainViewWidthMax
   return (
     <div
       className="page-wrapper low-prio-grow"
@@ -184,8 +187,8 @@ function PageContent({ children }: { children: React.ReactNode }) {
           }),
         }}
       >
-        {globalNote}
-        {pageTitleParsed && !pageContext.pageDesign?.hideTitle && (
+        {/* globalNote */}
+        {pageTitleParsed && !pageContext.conf.pageDesign?.hideTitle && (
           <div>
             <EditLink className="show-only-on-desktop" style={{ float: 'right', marginTop: 6, padding: 10 }} />
             <h1 id={`${pageContext.urlPathname.replace('/', '')}`}>{pageTitleParsed}</h1>
@@ -199,7 +202,7 @@ function PageContent({ children }: { children: React.ReactNode }) {
 
 function NavLeft() {
   const pageContext = usePageContext()
-  const { navItemsAll, navItemsDetached } = pageContext
+  const { navItemsAll, navItemsDetached } = pageContext.conf
   return (
     <>
       <div
@@ -278,12 +281,12 @@ const menuLinkStyle: React.CSSProperties = {
 
 function NavHead({ isNavLeft }: { isNavLeft?: true }) {
   const pageContext = usePageContext()
-  const pageContext2 = usePageContext2()
-  const { projectName } = pageContext.meta
-  const { isLandingPage } = pageContext
-  const { navMaxWidth } = pageContext.config
+  const { isLandingPage } = pageContext.conf
+  const {
+    navMaxWidth,
+    projectInfo: { projectName },
+  } = pageContext.globalContext.config.docpress
 
-  const TopNavigation = pageContext2.config.TopNavigation || PassThrough
   const navSecondaryContent = (
     <div
       className={isNavLeft ? 'show-on-nav-hover add-transition' : 'hide-on-shrink desktop-grow'}
@@ -302,7 +305,7 @@ function NavHead({ isNavLeft }: { isNavLeft?: true }) {
             }),
       }}
     >
-      <TopNavigation />
+      {pageContext.globalContext.config.docpress.topNavigation}
       {!isNavLeft && <div className="desktop-grow" />}
       <ExternalLinks
         style={{
@@ -483,8 +486,8 @@ function NavHeaderLeftFullWidthBackground() {
 
 function NavLogo({ className }: { className: string }) {
   const pageContext = usePageContext()
-  const iconSize = pageContext.config.navLogoSize ?? 39
-  const { projectName } = pageContext.meta
+  const iconSize = pageContext.globalContext.config.docpress.navLogoSize ?? 39
+  const { projectName } = pageContext.globalContext.config.docpress.projectInfo
   return (
     <a
       className={cls(['nav-logo', className])}
@@ -497,14 +500,14 @@ function NavLogo({ className }: { className: string }) {
       href="/"
     >
       <img
-        src={pageContext.meta.logoUrl}
+        src={pageContext.globalContext.config.docpress.logoUrl}
         style={{
           height: iconSize,
           width: iconSize,
-          ...pageContext.config.navLogoStyle,
+          ...pageContext.globalContext.config.docpress.navLogoStyle,
         }}
         onContextMenu={(ev) => {
-          if (!pageContext.config.pressKit) return // no /press page
+          if (!pageContext.globalContext.config.docpress.pressKit) return // no /press page
           if (window.location.pathname === '/press') return
           ev.preventDefault()
           navigate('/press#logo')
@@ -514,7 +517,7 @@ function NavLogo({ className }: { className: string }) {
         style={{
           marginLeft: `calc(var(--icon-text-padding) + 2px)`,
           fontSize: isProjectNameShort(projectName) ? '1.65em' : '1.3em',
-          ...pageContext.config.navLogoTextStyle,
+          ...pageContext.globalContext.config.docpress.navLogoTextStyle,
         }}
       >
         {projectName}

package/MenuModal.tsx

@@ -73,7 +73,7 @@ function BorderBottom() {
 }
 function Nav() {
   const pageContext = usePageContext()
-  const navItems = pageContext.navItemsAll
+  const navItems = pageContext.conf.navItemsAll
   return <NavigationWithColumnLayout navItems={navItems} />
 }
 

package/NavItemComponent.tsx

@@ -56,7 +56,7 @@ function NavItemComponent({
       [
         `${jsxToTextContent(titleInNavJsx)} is missing a URL hash.`,
         `Add a URL hash with: \`## ${sectionTitle}{#some-hash}\`.`,
-        /* TODO/eventually: not implemented yet.
+        /* TO-DO/eventually: not implemented yet.
         `Use \`<h2 id="url-hash">${sectionTitle}</h2>\` instead of \`## ${sectionTitle}\`.`,
         */
       ].join(' '),

package/components/Link.tsx

@@ -2,11 +2,11 @@ export { Link }
 export type { LinkData }
 
 import React from 'react'
-import type { PageContextResolved } from '../config/resolvePageContext'
 import { usePageContext } from '../renderer/usePageContext'
 import { assert, assertUsage, assertWarning, determineSectionTitle, determineSectionUrlHash } from '../utils/server'
 import { parseMarkdownMini } from '../parseMarkdownMini'
 import pc from '@brillout/picocolors'
+import type { PageContext } from 'vike/types'
 
 function Link({
   href,
@@ -90,7 +90,7 @@ function getLinkTextData({
   noWarning,
 }: {
   href: string
-  pageContext: PageContextResolved
+  pageContext: PageContext
   doNotInferSectionTitle?: boolean
   noWarning?: boolean
 }) {
@@ -138,10 +138,10 @@ type LinkData = {
 }
 function findLinkData(
   href: string,
-  { pageContext, noWarning }: { pageContext: PageContextResolved; noWarning?: boolean },
+  { pageContext, noWarning }: { pageContext: PageContext; noWarning?: boolean },
 ): LinkData | null {
   assert(href.startsWith('/') || href.startsWith('#'))
-  const { linksAll } = pageContext
+  const { linksAll } = pageContext.conf
   const linkData = linksAll.find(({ url }) => href === url)
   if (href.startsWith('#')) {
     if (!noWarning) {

package/components/RepoLink.tsx

@@ -11,20 +11,20 @@ function isRepoLink(href: string) {
   )
 }
 
-function RepoLink({ path, text, editMode }: { path: string; text?: string | React.ReactNode; editMode?: true }) {
+function RepoLink({ path, text }: { path: string; text?: string | React.ReactNode }) {
   text = text || path
-  const href = getRepoHref(path, editMode)
+  const href = getRepoHref(path)
   return <a href={href}>{text}</a>
 }
 
-function getRepoHref(path: string, editMode?: true) {
+function getRepoHref(path: string, editMode = false) {
   const pageContext = usePageContext()
   assert(isRepoLink(path), { path })
   if (!path.startsWith('/')) {
     path = '/' + path
   }
   const viewMode = path.endsWith('/') && !editMode ? 'tree' : 'blob'
-  const { githubRepository } = pageContext.config.projectInfo
+  const { githubRepository } = pageContext.globalContext.config.docpress.projectInfo
   assert(githubRepository.startsWith('https://github.com/'))
   let href = `${githubRepository}/${viewMode}/main${path}`
   if (editMode) href += '?plain=1'

package/{renderer/determineNavItemsColumnLayout.ts → determineNavItemsColumnLayout.ts}

@@ -3,9 +3,8 @@ export { determineNavItemsColumnLayout }
 // A CSS-only solution doesn't seem to exist.
 // - https://github.com/brillout/docpress/blob/2e41d8b9df098ff8312b02f7e9d41a202548e2b9/src/renderer/getStyleColumnLayout.ts#L4-L26
 
-import { type NavItem } from '../NavItemComponent'
-import { assert, assertUsage, isBrowser } from '../utils/server'
-assert(!isBrowser())
+import type { NavItem } from './NavItemComponent'
+import { assert, assertUsage } from './utils/assert'
 
 function determineNavItemsColumnLayout(navItems: NavItem[]): undefined {
   const columnLayouts = getColumnEntries(navItems)

package/dist/+config.d.ts

@@ -1,7 +1,7 @@
 export { config as default };
-import type { ImportString } from 'vike/types';
-import type { Exports } from './config/resolvePageContext';
 import type { Config as DocpressConfig } from './types/Config';
+import type { PageSection } from './parsePageSections';
+import type { Conf } from './resolveConf.js';
 declare const config: {
     name: string;
     require: {
@@ -13,27 +13,14 @@ declare const config: {
     };
     onRenderHtml: "import:@brillout/docpress/renderer/onRenderHtml:onRenderHtml";
     onRenderClient: "import:@brillout/docpress/renderer/onRenderClient:onRenderClient";
-    onBeforeRender: "import:@brillout/docpress/renderer/onBeforeRender:onBeforeRender";
-    Layout: "import:@brillout/docpress/Layout:Layout";
+    onCreatePageContext: "import:@brillout/docpress/renderer/onCreatePageContext:onCreatePageContext";
     clientRouting: true;
     hydrationCanBeAborted: true;
-    passToClient: string[];
     meta: {
-        Layout: {
-            env: {
-                client: true;
-                server: true;
-            };
-        };
-        TopNavigation: {
-            env: {
-                client: true;
-                server: true;
-            };
-        };
         docpress: {
             env: {
                 server: true;
+                client: true;
             };
             global: true;
         };
@@ -48,12 +35,14 @@ declare global {
     namespace Vike {
         interface PageContext {
             Page: ReactComponent;
-            exports: Exports;
+            conf: Conf;
         }
         interface Config {
-            Layout?: ReactComponent | null | ImportString;
-            TopNavigation?: ReactComponent;
             docpress?: DocpressConfig;
         }
+        interface ConfigResolved {
+            docpress: DocpressConfig;
+            pageSectionsExport: PageSection[] | undefined;
+        }
     }
 }

package/dist/+config.js

@@ -2,25 +2,17 @@ export { config as default };
 import { viteConfig } from './vite.config.js';
 var config = {
     name: '@brillout/docpress',
-    require: { vike: '>=0.4.222' },
+    require: { vike: '>=0.4.234' },
     vite: viteConfig,
     prerender: { noExtraDir: true },
     onRenderHtml: 'import:@brillout/docpress/renderer/onRenderHtml:onRenderHtml',
     onRenderClient: 'import:@brillout/docpress/renderer/onRenderClient:onRenderClient',
-    onBeforeRender: 'import:@brillout/docpress/renderer/onBeforeRender:onBeforeRender',
-    Layout: 'import:@brillout/docpress/Layout:Layout',
+    onCreatePageContext: 'import:@brillout/docpress/renderer/onCreatePageContext:onCreatePageContext',
     clientRouting: true,
     hydrationCanBeAborted: true,
-    passToClient: ['pageContextResolved'],
     meta: {
-        Layout: {
-            env: { client: true, server: true },
-        },
-        TopNavigation: {
-            env: { client: true, server: true },
-        },
         docpress: {
-            env: { server: true },
+            env: { server: true, client: true },
             global: true,
         },
     },

package/dist/NavItemComponent.js

@@ -33,7 +33,7 @@ function NavItemComponent(_a) {
         assertWarning(navItem.url, [
             "".concat(jsxToTextContent(titleInNavJsx), " is missing a URL hash."),
             "Add a URL hash with: `## ".concat(sectionTitle, "{#some-hash}`."),
-            /* TODO/eventually: not implemented yet.
+            /* TO-DO/eventually: not implemented yet.
             `Use \`<h2 id="url-hash">${sectionTitle}</h2>\` instead of \`## ${sectionTitle}\`.`,
             */
         ].join(' '));

package/dist/components/Link.js

@@ -91,7 +91,7 @@ function getLinkTextData(_a) {
 function findLinkData(href, _a) {
     var pageContext = _a.pageContext, noWarning = _a.noWarning;
     assert(href.startsWith('/') || href.startsWith('#'));
-    var linksAll = pageContext.linksAll;
+    var linksAll = pageContext.conf.linksAll;
     var linkData = linksAll.find(function (_a) {
         var url = _a.url;
         return href === url;

package/dist/components/RepoLink.d.ts

@@ -1,9 +1,8 @@
 export { RepoLink };
 export { getRepoHref };
 import React from 'react';
-declare function RepoLink({ path, text, editMode }: {
+declare function RepoLink({ path, text }: {
     path: string;
     text?: string | React.ReactNode;
-    editMode?: true;
 }): React.JSX.Element;
-declare function getRepoHref(path: string, editMode?: true): string;
+declare function getRepoHref(path: string, editMode?: boolean): string;

package/dist/components/RepoLink.js

@@ -9,19 +9,20 @@ function isRepoLink(href) {
     });
 }
 function RepoLink(_a) {
-    var path = _a.path, text = _a.text, editMode = _a.editMode;
+    var path = _a.path, text = _a.text;
     text = text || path;
-    var href = getRepoHref(path, editMode);
+    var href = getRepoHref(path);
     return React.createElement("a", { href: href }, text);
 }
 function getRepoHref(path, editMode) {
+    if (editMode === void 0) { editMode = false; }
     var pageContext = usePageContext();
     assert(isRepoLink(path), { path: path });
     if (!path.startsWith('/')) {
         path = '/' + path;
     }
     var viewMode = path.endsWith('/') && !editMode ? 'tree' : 'blob';
-    var githubRepository = pageContext.config.projectInfo.githubRepository;
+    var githubRepository = pageContext.globalContext.config.docpress.projectInfo.githubRepository;
     assert(githubRepository.startsWith('https://github.com/'));
     var href = "".concat(githubRepository, "/").concat(viewMode, "/main").concat(path);
     if (editMode)

package/dist/{renderer/determineNavItemsColumnLayout.d.ts → determineNavItemsColumnLayout.d.ts}

@@ -1,3 +1,3 @@
 export { determineNavItemsColumnLayout };
-import { type NavItem } from '../NavItemComponent';
+import type { NavItem } from './NavItemComponent';
 declare function determineNavItemsColumnLayout(navItems: NavItem[]): undefined;

package/dist/{renderer/determineNavItemsColumnLayout.js → determineNavItemsColumnLayout.js}

@@ -19,8 +19,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 };
 export { determineNavItemsColumnLayout };
-import { assert, assertUsage, isBrowser } from '../utils/server';
-assert(!isBrowser());
+import { assert, assertUsage } from './utils/assert';
 function determineNavItemsColumnLayout(navItems) {
     var columnLayouts = getColumnEntries(navItems);
     columnLayouts.forEach(function (columnEntries) {

package/dist/parsePageSections.js

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

package/dist/renderer/usePageContext.d.ts

@@ -1,17 +1,24 @@
-export { usePageContext };
 export { PageContextProvider };
+export { usePageContext };
+export { usePageContextLegacy };
 import React from 'react';
-import type { PageContextResolved } from '../config/resolvePageContext';
 import type { PageContext } from 'vike/types';
+declare function usePageContextLegacy(): {
+    navItemsAll: import("../NavItemComponent").NavItem[];
+    navItemsDetached: import("../NavItemComponent").NavItem[] | undefined;
+    pageDesign: {
+        hideTitle?: true;
+        hideMenuLeft?: true;
+        contentMaxWidth?: number;
+    } | undefined;
+    linksAll: import("../components").LinkData[];
+    isLandingPage: boolean;
+    pageTitle: string | null;
+    documentTitle: string;
+    activeCategoryName: string;
+};
+declare function usePageContext(): PageContext;
 declare function PageContextProvider({ pageContext, children, }: {
-    pageContext: PageContextResolved;
-    children: React.ReactNode;
-}): React.JSX.Element;
-declare function usePageContext(): PageContextResolved;
-export { PageContextProvider2 };
-export { usePageContext2 };
-declare function usePageContext2(): PageContext;
-declare function PageContextProvider2({ pageContext, children, }: {
     pageContext: PageContext;
     children: React.ReactNode;
 }): React.JSX.Element;

package/dist/renderer/usePageContext.js

@@ -1,30 +1,22 @@
-export { usePageContext };
 export { PageContextProvider };
+export { usePageContext };
+export { usePageContextLegacy };
 import React, { useContext } from 'react';
 import { getGlobalObject } from '../utils/getGlobalObject';
 var globalObject = getGlobalObject('usePageContext.ts', {
-    Context: React.createContext(undefined),
-    Context2: React.createContext(undefined),
+    Ctx: React.createContext(undefined),
 });
-function PageContextProvider(_a) {
-    var pageContext = _a.pageContext, children = _a.children;
-    var Context = globalObject.Context;
-    return React.createElement(Context.Provider, { value: pageContext }, children);
+function usePageContextLegacy() {
+    var Ctx = globalObject.Ctx;
+    var pageContext = useContext(Ctx);
+    return pageContext.conf;
 }
 function usePageContext() {
-    var Context = globalObject.Context;
-    var pageContext = useContext(Context);
+    var pageContext = useContext(globalObject.Ctx);
     return pageContext;
 }
-export { PageContextProvider2 };
-// TODO/refactor: rename to usePageContext and remove old implementation
-export { usePageContext2 };
-function usePageContext2() {
-    var pageContext = useContext(globalObject.Context2);
-    return pageContext;
-}
-function PageContextProvider2(_a) {
+function PageContextProvider(_a) {
     var pageContext = _a.pageContext, children = _a.children;
-    var Context2 = globalObject.Context2;
-    return React.createElement(Context2.Provider, { value: pageContext }, children);
+    var Ctx = globalObject.Ctx;
+    return React.createElement(Ctx.Provider, { value: pageContext }, children);
 }

package/dist/resolveConf.d.ts

@@ -0,0 +1,19 @@
+export { resolveConf };
+export type Conf = ReturnType<typeof resolveConf>;
+import type { NavItem } from './NavItemComponent';
+import type { LinkData } from './components';
+import type { PageContextServer } from 'vike/types';
+declare function resolveConf(pageContext: PageContextServer): {
+    navItemsAll: NavItem[];
+    navItemsDetached: NavItem[] | undefined;
+    pageDesign: {
+        hideTitle?: true;
+        hideMenuLeft?: true;
+        contentMaxWidth?: number;
+    } | undefined;
+    linksAll: LinkData[];
+    isLandingPage: boolean;
+    pageTitle: string | null;
+    documentTitle: string;
+    activeCategoryName: string;
+};