@brillout/docpress 0.10.8 → 0.10.10

package/Layout.tsx

@@ -485,8 +485,11 @@ function NavLogo({ className }: { className: string }) {
     >
       <img
         src={pageContext.meta.logoUrl}
-        height={iconSize}
-        width={iconSize}
+        style={{
+          height: iconSize,
+          width: iconSize,
+          ...pageContext.config.navLogoStyle,
+        }}
         onContextMenu={(ev) => {
           if (!pageContext.config.pressKit) return // no /press page
           if (window.location.pathname === '/press') return

package/components/Link.tsx

@@ -5,7 +5,7 @@ import React from 'react'
 import { isRepoLink, RepoLink } from './RepoLink'
 import type { PageContextResolved } from '../config/resolvePageContext'
 import { usePageContext } from '../renderer/usePageContext'
-import { assert, assertUsage, determineSectionTitle, determineSectionUrlHash } from '../utils/server'
+import { assert, assertUsage, assertWarning, determineSectionTitle, determineSectionUrlHash } from '../utils/server'
 import { parseMarkdownMini } from '../parseMarkdownMini'
 import pc from '@brillout/picocolors'
 
@@ -17,55 +17,86 @@ function Link({
   children,
 }: {
   href: string
-  text?: string | JSX.Element
+  text?: string | React.ReactNode
   noBreadcrumb?: true
   doNotInferSectionTitle?: true
   children?: React.ReactNode
 }) {
+  const pageContext = usePageContext()
   assertUsage(
     href.startsWith('/') || href.startsWith('#'),
     `<Link href /> prop \`href==='${href}'\` but should start with '/' or '#'`,
   )
   assertUsage(!text || !children, 'Cannot use both `text` or `children`')
+  assertWarning(!text, 'prop `text` is deprecated')
+  text = text ?? children
 
   if (isRepoLink(href)) {
     return <RepoLink path={href} text={text} />
   } else {
-    const pageContext = usePageContext()
-    return (
-      <a href={href}>{children || text || getLinkText({ href, noBreadcrumb, pageContext, doNotInferSectionTitle })}</a>
-    )
+    const linkTextData = getLinkTextData(href, pageContext, doNotInferSectionTitle)
+    if (!linkTextData) {
+      text = 'LINK-TARGET-NOT-FOUND'
+    } else if (!text) {
+      text = getLinkText({
+        noBreadcrumb,
+        ...linkTextData,
+      })
+    }
+    return <a href={href}>{text}</a>
   }
 }
 
 function getLinkText({
-  href,
   noBreadcrumb,
-  pageContext,
-  doNotInferSectionTitle,
+  linkData,
+  sectionTitle,
+  isLinkOnSamePage,
 }: {
-  href: string
   noBreadcrumb: true | undefined
-  pageContext: PageContextResolved
-  doNotInferSectionTitle: true | undefined
+  linkData: LinkData
+  sectionTitle: JSX.Element | null
+  isLinkOnSamePage: boolean
 }): JSX.Element {
-  const { hrefPathname, hrefHash } = parseHref(href)
-
-  const linkData = findLinkData(hrefPathname || pageContext.urlPathname, pageContext)
-  const isLinkOnSamePage = linkData.url === pageContext.urlPathname
-  if (!hrefPathname) assert(isLinkOnSamePage)
-
   const breadcrumbParts: JSX.Element[] = []
   if (linkData.linkBreadcrumb) {
     breadcrumbParts.push(...(linkData.linkBreadcrumb ?? []).slice().reverse().map(parseMarkdownMini))
   }
   breadcrumbParts.push(parseMarkdownMini(linkData.title))
+  if (sectionTitle) breadcrumbParts.push(sectionTitle)
+
+  if (noBreadcrumb || isLinkOnSamePage) {
+    return breadcrumbParts[breadcrumbParts.length - 1]
+  }
+  return (
+    <>
+      {breadcrumbParts.map((title, i) => {
+        const seperator = i === 0 ? <></> : ' > '
+        return (
+          <React.Fragment key={i}>
+            {seperator}
+            {title}
+          </React.Fragment>
+        )
+      })}
+    </>
+  )
+}
+
+function getLinkTextData(href: string, pageContext: PageContextResolved, doNotInferSectionTitle?: boolean) {
+  const { hrefPathname, hrefHash } = parseHref(href)
 
+  const linkData = findLinkData(hrefPathname || pageContext.urlPathname, pageContext)
+  assert(linkData)
+  const isLinkOnSamePage = linkData.url === pageContext.urlPathname
+  if (!hrefPathname) assert(isLinkOnSamePage)
+
+  let sectionTitle: JSX.Element | null = null
   if (hrefHash) {
-    let sectionTitle: JSX.Element | undefined = undefined
     assert(!hrefHash.startsWith('#'))
     if (isLinkOnSamePage) {
       const linkDataPageSection = findLinkData(`#${hrefHash}`, pageContext)
+      if (!linkDataPageSection) return null
       sectionTitle = parseMarkdownMini(linkDataPageSection.title)
     } else if ('sectionTitles' in linkData && linkData.sectionTitles) {
       linkData.sectionTitles.forEach((title) => {
@@ -75,34 +106,18 @@ function getLinkText({
       })
     }
     if (!sectionTitle) {
-      assertUsage(
-        !doNotInferSectionTitle,
-        `Page section title not found for <Link href="\`${href}\`" doNotInferSectionTitle={true} />.`,
-      )
+      if (doNotInferSectionTitle) {
+        assertWarning(
+          false,
+          `Page section title not found for <Link href="\`${href}\`" doNotInferSectionTitle={true} />.`,
+        )
+        return null
+      }
       sectionTitle = <>{determineSectionTitle(href)}</>
     }
-    breadcrumbParts.push(sectionTitle)
-  }
-
-  {
-    if (noBreadcrumb || isLinkOnSamePage) {
-      return breadcrumbParts[breadcrumbParts.length - 1]
-    }
   }
 
-  return (
-    <>
-      {breadcrumbParts.map((title, i) => {
-        const seperator = i === 0 ? <></> : ' > '
-        return (
-          <React.Fragment key={i}>
-            {seperator}
-            {title}
-          </React.Fragment>
-        )
-      })}
-    </>
-  )
+  return { linkData, sectionTitle, isLinkOnSamePage }
 }
 
 type LinkData = {
@@ -111,15 +126,14 @@ type LinkData = {
   linkBreadcrumb: null | string[]
   sectionTitles?: string[]
 }
-
-function findLinkData(href: string, pageContext: PageContextResolved): LinkData {
+function findLinkData(href: string, pageContext: PageContextResolved): LinkData | null {
   assert(href.startsWith('/') || href.startsWith('#'))
   const { linksAll } = pageContext
   const linkData = linksAll.find(({ url }) => href === url)
   if (href.startsWith('#')) {
-    assertUsage(linkData, `Couldn't find ${href} in ${pageContext.urlPathname}, does it exist?`)
+    assertWarning(linkData, `Couldn't find ${href} in ${pageContext.urlPathname}, does it exist?`)
   } else {
-    assertUsage(
+    assertWarning(
       linkData,
       [
         `Couldn't find page with URL ${pc.bold(href)}`,
@@ -136,7 +150,7 @@ function findLinkData(href: string, pageContext: PageContextResolved): LinkData
       ].join(' '),
     )
   }
-  return linkData
+  return linkData ?? null
 }
 
 function parseHref(href: string) {

package/components/RepoLink.tsx

@@ -10,7 +10,7 @@ function isRepoLink(href: string) {
   return ['/examples/', '/docs/', '/boilerplates/', '.github/', '/test/'].some((start) => href.startsWith(start))
 }
 
-function RepoLink({ path, text, editMode }: { path: string; text?: string | JSX.Element; editMode?: true }) {
+function RepoLink({ path, text, editMode }: { path: string; text?: string | React.ReactNode; editMode?: true }) {
   text = text || path
   const href = getRepoHref(path, editMode)
   return <a href={href}>{text}</a>

package/dist/components/Link.d.ts

@@ -3,7 +3,7 @@ export type { LinkData };
 import React from 'react';
 declare function Link({ href, text, noBreadcrumb, doNotInferSectionTitle, children, }: {
     href: string;
-    text?: string | JSX.Element;
+    text?: string | React.ReactNode;
     noBreadcrumb?: true;
     doNotInferSectionTitle?: true;
     children?: React.ReactNode;

package/dist/components/Link.js

@@ -1,66 +1,94 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 export { Link };
 import React from 'react';
 import { isRepoLink, RepoLink } from './RepoLink';
 import { usePageContext } from '../renderer/usePageContext';
-import { assert, assertUsage, determineSectionTitle, determineSectionUrlHash } from '../utils/server';
+import { assert, assertUsage, assertWarning, determineSectionTitle, determineSectionUrlHash } from '../utils/server';
 import { parseMarkdownMini } from '../parseMarkdownMini';
 import pc from '@brillout/picocolors';
 function Link(_a) {
     var href = _a.href, text = _a.text, noBreadcrumb = _a.noBreadcrumb, doNotInferSectionTitle = _a.doNotInferSectionTitle, children = _a.children;
+    var pageContext = usePageContext();
     assertUsage(href.startsWith('/') || href.startsWith('#'), "<Link href /> prop `href==='".concat(href, "'` but should start with '/' or '#'"));
     assertUsage(!text || !children, 'Cannot use both `text` or `children`');
+    assertWarning(!text, 'prop `text` is deprecated');
+    text = text !== null && text !== void 0 ? text : children;
     if (isRepoLink(href)) {
         return React.createElement(RepoLink, { path: href, text: text });
     }
     else {
-        var pageContext = usePageContext();
-        return (React.createElement("a", { href: href }, children || text || getLinkText({ href: href, noBreadcrumb: noBreadcrumb, pageContext: pageContext, doNotInferSectionTitle: doNotInferSectionTitle })));
+        var linkTextData = getLinkTextData(href, pageContext, doNotInferSectionTitle);
+        if (!linkTextData) {
+            text = 'LINK-TARGET-NOT-FOUND';
+        }
+        else if (!text) {
+            text = getLinkText(__assign({ noBreadcrumb: noBreadcrumb }, linkTextData));
+        }
+        return React.createElement("a", { href: href }, text);
     }
 }
 function getLinkText(_a) {
     var _b;
-    var href = _a.href, noBreadcrumb = _a.noBreadcrumb, pageContext = _a.pageContext, doNotInferSectionTitle = _a.doNotInferSectionTitle;
-    var _c = parseHref(href), hrefPathname = _c.hrefPathname, hrefHash = _c.hrefHash;
-    var linkData = findLinkData(hrefPathname || pageContext.urlPathname, pageContext);
-    var isLinkOnSamePage = linkData.url === pageContext.urlPathname;
-    if (!hrefPathname)
-        assert(isLinkOnSamePage);
+    var noBreadcrumb = _a.noBreadcrumb, linkData = _a.linkData, sectionTitle = _a.sectionTitle, isLinkOnSamePage = _a.isLinkOnSamePage;
     var breadcrumbParts = [];
     if (linkData.linkBreadcrumb) {
         breadcrumbParts.push.apply(breadcrumbParts, ((_b = linkData.linkBreadcrumb) !== null && _b !== void 0 ? _b : []).slice().reverse().map(parseMarkdownMini));
     }
     breadcrumbParts.push(parseMarkdownMini(linkData.title));
+    if (sectionTitle)
+        breadcrumbParts.push(sectionTitle);
+    if (noBreadcrumb || isLinkOnSamePage) {
+        return breadcrumbParts[breadcrumbParts.length - 1];
+    }
+    return (React.createElement(React.Fragment, null, breadcrumbParts.map(function (title, i) {
+        var seperator = i === 0 ? React.createElement(React.Fragment, null) : ' > ';
+        return (React.createElement(React.Fragment, { key: i },
+            seperator,
+            title));
+    })));
+}
+function getLinkTextData(href, pageContext, doNotInferSectionTitle) {
+    var _a = parseHref(href), hrefPathname = _a.hrefPathname, hrefHash = _a.hrefHash;
+    var linkData = findLinkData(hrefPathname || pageContext.urlPathname, pageContext);
+    assert(linkData);
+    var isLinkOnSamePage = linkData.url === pageContext.urlPathname;
+    if (!hrefPathname)
+        assert(isLinkOnSamePage);
+    var sectionTitle = null;
     if (hrefHash) {
-        var sectionTitle_1 = undefined;
         assert(!hrefHash.startsWith('#'));
         if (isLinkOnSamePage) {
             var linkDataPageSection = findLinkData("#".concat(hrefHash), pageContext);
-            sectionTitle_1 = parseMarkdownMini(linkDataPageSection.title);
+            if (!linkDataPageSection)
+                return null;
+            sectionTitle = parseMarkdownMini(linkDataPageSection.title);
         }
         else if ('sectionTitles' in linkData && linkData.sectionTitles) {
             linkData.sectionTitles.forEach(function (title) {
                 if (determineSectionUrlHash(title) === hrefHash) {
-                    sectionTitle_1 = parseMarkdownMini(title);
+                    sectionTitle = parseMarkdownMini(title);
                 }
             });
         }
-        if (!sectionTitle_1) {
-            assertUsage(!doNotInferSectionTitle, "Page section title not found for <Link href=\"`".concat(href, "`\" doNotInferSectionTitle={true} />."));
-            sectionTitle_1 = React.createElement(React.Fragment, null, determineSectionTitle(href));
-        }
-        breadcrumbParts.push(sectionTitle_1);
-    }
-    {
-        if (noBreadcrumb || isLinkOnSamePage) {
-            return breadcrumbParts[breadcrumbParts.length - 1];
+        if (!sectionTitle) {
+            if (doNotInferSectionTitle) {
+                assertWarning(false, "Page section title not found for <Link href=\"`".concat(href, "`\" doNotInferSectionTitle={true} />."));
+                return null;
+            }
+            sectionTitle = React.createElement(React.Fragment, null, determineSectionTitle(href));
         }
     }
-    return (React.createElement(React.Fragment, null, breadcrumbParts.map(function (title, i) {
-        var seperator = i === 0 ? React.createElement(React.Fragment, null) : ' > ';
-        return (React.createElement(React.Fragment, { key: i },
-            seperator,
-            title));
-    })));
+    return { linkData: linkData, sectionTitle: sectionTitle, isLinkOnSamePage: isLinkOnSamePage };
 }
 function findLinkData(href, pageContext) {
     assert(href.startsWith('/') || href.startsWith('#'));
@@ -70,10 +98,10 @@ function findLinkData(href, pageContext) {
         return href === url;
     });
     if (href.startsWith('#')) {
-        assertUsage(linkData, "Couldn't find ".concat(href, " in ").concat(pageContext.urlPathname, ", does it exist?"));
+        assertWarning(linkData, "Couldn't find ".concat(href, " in ").concat(pageContext.urlPathname, ", does it exist?"));
     }
     else {
-        assertUsage(linkData, [
+        assertWarning(linkData, [
             "Couldn't find page with URL ".concat(pc.bold(href)),
             "\u2014 did you define it in",
             [
@@ -87,7 +115,7 @@ function findLinkData(href, pageContext) {
             ].join(''),
         ].join(' '));
     }
-    return linkData;
+    return linkData !== null && linkData !== void 0 ? linkData : null;
 }
 function parseHref(href) {
     var hrefHash = null;

package/dist/components/RepoLink.d.ts

@@ -5,7 +5,7 @@ export { getRepoHref };
 declare function isRepoLink(href: string): boolean;
 declare function RepoLink({ path, text, editMode }: {
     path: string;
-    text?: string | JSX.Element;
+    text?: string | React.ReactNode;
     editMode?: true;
 }): React.JSX.Element;
 declare function getRepoHref(path: string, editMode?: true): string;

package/dist/types/Config.d.ts

@@ -30,5 +30,6 @@ type Config = {
     sponsorGithubAccount?: string;
     navMaxWidth?: number;
     navLogoSize?: number;
+    navLogoStyle?: React.CSSProperties;
     navLogoTextStyle?: React.CSSProperties;
 };

package/dist/utils/assert.d.ts

@@ -3,4 +3,4 @@ export { assertUsage };
 export { assertWarning };
 declare function assert(condition: unknown, debugInfo?: unknown): asserts condition;
 declare function assertUsage(condition: unknown, msg: string): asserts condition;
-declare function assertWarning(condition: unknown, msg: string): asserts condition;
+declare function assertWarning(condition: unknown, msg: string): void;

package/dist/utils/assert.js

@@ -12,12 +12,12 @@ if (isBrowser()) {
     ]
         .filter(Boolean)
         .join(' '));
-    if (isDevMode()) {
-        window.onerror = function (err) {
-            window.alert(err);
-            window.onerror = null;
-        };
-    }
+}
+if (isDevMode()) {
+    window.onerror = function (err) {
+        window.alert(err);
+        window.onerror = null;
+    };
 }
 function assert(condition, debugInfo) {
     if (condition) {
@@ -48,7 +48,7 @@ function isBrowser() {
     return typeof window !== 'undefined';
 }
 function isDevMode() {
-    return !!window.localStorage[devModeKey] || isLocalhost();
+    return isBrowser() && (!!window.localStorage[devModeKey] || isLocalhost());
 }
 function isLocalhost() {
     var _a;
@@ -71,10 +71,9 @@ function assertWarning(condition, msg) {
         return;
     }
     msg = '[DocPress][Warning] ' + msg;
-    if (isBrowser() && isDevMode()) {
-        throw new Error(msg);
-    }
-    else {
-        console.warn(msg);
+    var err = new Error(msg);
+    console.warn(err);
+    if (isDevMode()) {
+        window.alert(err);
     }
 }

package/package.json

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

package/renderer/onRenderHtml.tsx

@@ -27,7 +27,7 @@ Promise<Awaited<ReturnType<OnRenderHtmlAsync>>> => {
     <html>
       <head>
         <meta charset="UTF-8" />
-        <link rel="icon" href="${faviconUrl}" />
+        <link rel="icon" href="${faviconUrl ?? ''}" />
         <title>${pageContextResolved.documentTitle}</title>
         ${descriptionTag}
         <meta name="viewport" content="width=device-width,initial-scale=1,user-scalable=no" />

package/types/Config.ts

@@ -32,5 +32,6 @@ type Config = {
   sponsorGithubAccount?: string
   navMaxWidth?: number
   navLogoSize?: number
+  navLogoStyle?: React.CSSProperties
   navLogoTextStyle?: React.CSSProperties
 }

package/utils/assert.ts

@@ -15,11 +15,11 @@ if (isBrowser()) {
       .filter(Boolean)
       .join(' '),
   )
-  if (isDevMode()) {
-    window.onerror = (err) => {
-      window.alert(err)
-      window.onerror = null
-    }
+}
+if (isDevMode()) {
+  window.onerror = (err) => {
+    window.alert(err)
+    window.onerror = null
   }
 }
 
@@ -54,7 +54,7 @@ function isBrowser() {
   return typeof window !== 'undefined'
 }
 function isDevMode() {
-  return !!window.localStorage[devModeKey] || isLocalhost()
+  return isBrowser() && (!!window.localStorage[devModeKey] || isLocalhost())
 }
 function isLocalhost() {
   return window?.location?.port !== ''
@@ -70,14 +70,14 @@ function toggleDevMode() {
   console.log(`DEV MODE ${isEnabled() ? 'enabled' : 'disabled'}`)
 }
 
-function assertWarning(condition: unknown, msg: string): asserts condition {
+function assertWarning(condition: unknown, msg: string) {
   if (condition) {
     return
   }
   msg = '[DocPress][Warning] ' + msg
-  if (isBrowser() && isDevMode()) {
-    throw new Error(msg)
-  } else {
-    console.warn(msg)
+  const err = new Error(msg)
+  console.warn(err)
+  if (isDevMode()) {
+    window.alert(err)
   }
 }