@brillout/docpress 0.10.25 → 0.11.1

package/+config.ts

@@ -1,9 +1,15 @@
+export { config as default }
+
 import type { Config, ImportString } from 'vike/types'
 import type { Exports } from './config/resolvePageContext'
+import { viteConfig } from './vite.config.js'
+import type { Config as DocpressConfig } from './types/Config'
 
-export default {
-  // @ts-ignore Remove this ts-ignore once Vike's new version is released.
+const config = {
   name: '@brillout/docpress',
+  require: { vike: '>=0.4.222' },
+  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',
@@ -18,6 +24,10 @@ export default {
     TopNavigation: {
       env: { client: true, server: true },
     },
+    docpress: {
+      env: { server: true },
+      global: true,
+    },
   },
   prefetch: {
     staticAssets: 'hover',
@@ -35,6 +45,7 @@ declare global {
     interface Config {
       Layout?: ReactComponent | null | ImportString
       TopNavigation?: ReactComponent
+      docpress?: DocpressConfig
     }
   }
 }

package/components/Link.tsx

@@ -2,7 +2,6 @@ export { Link }
 export type { LinkData }
 
 import React from 'react'
-import { isRepoLink, RepoLink } from './RepoLink'
 import type { PageContextResolved } from '../config/resolvePageContext'
 import { usePageContext } from '../renderer/usePageContext'
 import { assert, assertUsage, assertWarning, determineSectionTitle, determineSectionUrlHash } from '../utils/server'
@@ -31,20 +30,16 @@ function Link({
   // assertWarning(!text, 'prop `text` is deprecated')
   text = text ?? children
 
-  if (isRepoLink(href)) {
-    return <RepoLink path={href} text={text} />
-  } else {
-    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>
+  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({

package/components/RepoLink.tsx

@@ -1,11 +1,10 @@
+export { RepoLink }
+export { getRepoHref }
+
 import React from 'react'
 import { assert } from '../utils/server'
 import { usePageContext } from '../renderer/usePageContext'
 
-export { RepoLink }
-export { isRepoLink }
-export { getRepoHref }
-
 function isRepoLink(href: string) {
   return ['/examples/', '/docs/', '/boilerplates/', '.github/', '/test/'].some((start) => href.startsWith(start))
 }

package/config/resolveHeadingsData.ts

@@ -9,7 +9,6 @@ import type {
   HeadingDetachedResolved,
 } from '../types/Heading'
 import type { Config } from '../types/Config'
-import { getConfig } from './getConfig'
 import type { NavItem } from '../NavItemComponent'
 import type { LinkData } from '../components'
 import type { Exports, PageContextOriginal } from './resolvePageContext'
@@ -33,7 +32,7 @@ type ActiveCategory = {
 }
 
 function resolveHeadingsData(pageContext: PageContextOriginal) {
-  const config = getConfig()
+  const config = pageContext.config.docpress!
 
   {
     const { headings, headingsDetached } = config

package/config/resolvePageContext.ts

@@ -6,7 +6,6 @@ export type { Exports }
 import { objectAssign } from '../utils/server'
 import type { PageContextServer } from 'vike/types'
 import type { PageSection } from '../parsePageSections'
-import { getConfig } from './getConfig'
 import { resolveHeadingsData } from './resolveHeadingsData'
 
 type Exports = {
@@ -22,7 +21,7 @@ function resolvePageContext(pageContext: PageContextOriginal) {
 
   objectAssign(pageContextResolved, resolveHeadingsData(pageContext))
 
-  const config = getConfig()
+  const config = pageContext.config.docpress!
   const {
     algolia,
     tagline,

package/dist/+config.d.ts

@@ -1,7 +1,16 @@
+export { config as default };
 import type { ImportString } from 'vike/types';
 import type { Exports } from './config/resolvePageContext';
-declare const _default: {
+import type { Config as DocpressConfig } from './types/Config';
+declare const config: {
     name: string;
+    require: {
+        vike: string;
+    };
+    vite: import("vite").UserConfig;
+    prerender: {
+        noExtraDir: true;
+    };
     onRenderHtml: "import:@brillout/docpress/renderer/onRenderHtml:onRenderHtml";
     onRenderClient: "import:@brillout/docpress/renderer/onRenderClient:onRenderClient";
     onBeforeRender: "import:@brillout/docpress/renderer/onBeforeRender:onBeforeRender";
@@ -22,13 +31,18 @@ declare const _default: {
                 server: true;
             };
         };
+        docpress: {
+            env: {
+                server: true;
+            };
+            global: true;
+        };
     };
     prefetch: {
         staticAssets: "hover";
         pageContext: number;
     };
 };
-export default _default;
 type ReactComponent = () => React.JSX.Element;
 declare global {
     namespace Vike {
@@ -39,6 +53,7 @@ declare global {
         interface Config {
             Layout?: ReactComponent | null | ImportString;
             TopNavigation?: ReactComponent;
+            docpress?: DocpressConfig;
         }
     }
 }

package/dist/+config.js

@@ -1,6 +1,10 @@
-export default {
-    // @ts-ignore Remove this ts-ignore once Vike's new version is released.
+export { config as default };
+import { viteConfig } from './vite.config.js';
+var config = {
     name: '@brillout/docpress',
+    require: { vike: '>=0.4.222' },
+    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',
@@ -15,6 +19,10 @@ export default {
         TopNavigation: {
             env: { client: true, server: true },
         },
+        docpress: {
+            env: { server: true },
+            global: true,
+        },
     },
     prefetch: {
         staticAssets: 'hover',

package/dist/components/Link.js

@@ -11,7 +11,6 @@ var __assign = (this && this.__assign) || function () {
 };
 export { Link };
 import React from 'react';
-import { isRepoLink, RepoLink } from './RepoLink';
 import { usePageContext } from '../renderer/usePageContext';
 import { assert, assertUsage, assertWarning, determineSectionTitle, determineSectionUrlHash } from '../utils/server';
 import { parseMarkdownMini } from '../parseMarkdownMini';
@@ -23,19 +22,14 @@ function Link(_a) {
     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 });
+    var linkTextData = getLinkTextData(href, pageContext, doNotInferSectionTitle);
+    if (!linkTextData) {
+        text = 'LINK-TARGET-NOT-FOUND';
     }
-    else {
-        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);
+    else if (!text) {
+        text = getLinkText(__assign({ noBreadcrumb: noBreadcrumb }, linkTextData));
     }
+    return React.createElement("a", { href: href }, text);
 }
 function getLinkText(_a) {
     var _b;

package/dist/components/RepoLink.d.ts

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

package/dist/components/RepoLink.js

@@ -1,9 +1,8 @@
+export { RepoLink };
+export { getRepoHref };
 import React from 'react';
 import { assert } from '../utils/server';
 import { usePageContext } from '../renderer/usePageContext';
-export { RepoLink };
-export { isRepoLink };
-export { getRepoHref };
 function isRepoLink(href) {
     return ['/examples/', '/docs/', '/boilerplates/', '.github/', '/test/'].some(function (start) { return href.startsWith(start); });
 }

package/dist/config/resolveHeadingsData.js

@@ -20,14 +20,13 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
 };
 export { resolveHeadingsData };
 import { assert, isBrowser, jsxToTextContent } from '../utils/server';
-import { getConfig } from './getConfig';
 import pc from '@brillout/picocolors';
 import { parseMarkdownMini } from '../parseMarkdownMini';
 import { determineNavItemsColumnLayout } from '../renderer/determineNavItemsColumnLayout';
 assert(!isBrowser());
 function resolveHeadingsData(pageContext) {
     var _a, _b;
-    var config = getConfig();
+    var config = pageContext.config.docpress;
     {
         var headings = config.headings, headingsDetached = config.headingsDetached;
         assertHeadingsDefinition(__spreadArray(__spreadArray([], headings, true), headingsDetached, true));

package/dist/config/resolvePageContext.js

@@ -1,12 +1,11 @@
 export { resolvePageContext };
 import { objectAssign } from '../utils/server';
-import { getConfig } from './getConfig';
 import { resolveHeadingsData } from './resolveHeadingsData';
 function resolvePageContext(pageContext) {
     var _a;
     var pageContextResolved = {};
     objectAssign(pageContextResolved, resolveHeadingsData(pageContext));
-    var config = getConfig();
+    var config = pageContext.config.docpress;
     var algolia = config.algolia, tagline = config.tagline, twitterHandle = config.twitterHandle, bannerUrl = config.bannerUrl, websiteUrl = config.websiteUrl, projectName = config.projectInfo.projectName;
     var logoUrl = (_a = config.logoUrl) !== null && _a !== void 0 ? _a : config.faviconUrl;
     objectAssign(pageContextResolved, {

package/dist/parsePageSections.d.ts

@@ -1,12 +1,9 @@
 export { parsePageSections };
 export type { PageSection };
+import type { PluginOption } from 'vite';
 type PageSection = {
     pageSectionTitle: string;
     pageSectionId: string | null;
     pageSectionLevel: number;
 };
-declare function parsePageSections(): {
-    name: string;
-    enforce: string;
-    transform: (code: string, id: string) => Promise<string | undefined>;
-};
+declare function parsePageSections(): PluginOption;

package/dist/utils/assert.js

@@ -72,8 +72,12 @@ function assertWarning(condition, msg) {
     }
     msg = '[DocPress][Warning] ' + msg;
     var err = new Error(msg);
-    console.warn(err);
-    if (isDevMode()) {
-        window.alert(err);
+    if (import.meta.env.DEV) {
+        console.warn(err);
+        if (isDevMode())
+            window.alert(err);
+    }
+    else {
+        throw err;
     }
 }

package/dist/vite.config.d.ts

@@ -1,3 +1,3 @@
-import { UserConfig } from 'vite';
+export { config as viteConfig };
+import type { UserConfig } from 'vite';
 declare const config: UserConfig;
-export default config;

package/dist/vite.config.js

@@ -1,6 +1,6 @@
+export { config as viteConfig };
 import mdx from '@mdx-js/rollup';
 import react from '@vitejs/plugin-react-swc';
-import vike from 'vike/plugin';
 import { parsePageSections } from './parsePageSections.js';
 import rehypePrettyCode from 'rehype-pretty-code';
 import remarkGfm from 'remark-gfm';
@@ -16,12 +16,6 @@ var config = {
         mdx({ rehypePlugins: rehypePlugins, remarkPlugins: remarkPlugins }),
         // @vitejs/plugin-react-swc needs to be added *after* the mdx plugins
         react(),
-        vike({
-            prerender: {
-                noExtraDir: true,
-            },
-            includeAssetsImportedByServer: true,
-        }),
     ],
     optimizeDeps: {
         include: ['react', 'react-dom', 'react-dom/client'],
@@ -30,6 +24,10 @@ var config = {
     ssr: {
         noExternal: ['@brillout/docpress', '@docsearch/react'],
     },
+    // Suppress following warning:
+    // ```
+    // ▲ [WARNING] Transforming this CSS nesting syntax is not supported in the configured target environment ("chrome87", "edge88", "es2020", "firefox78", "safari14") [unsupported-css-nesting]
+    // ```
+    build: { target: 'es2022' },
     clearScreen: false,
 };
-export default config;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brillout/docpress",
-  "version": "0.10.25",
+  "version": "0.11.1",
   "type": "module",
   "dependencies": {
     "@brillout/picocolors": "^1.0.10",
@@ -21,7 +21,7 @@
     "react": ">=18.0.0",
     "react-dom": ">=18.0.0",
     "typescript": ">=5.0.0",
-    "vike": ">=0.4.213",
+    "vike": ">=0.4.222",
     "vite": ">=5.2.0"
   },
   "peerDependenciesMeta": {
@@ -38,7 +38,6 @@
     "./renderer/onBeforeRender": "./renderer/onBeforeRender.ts",
     "./Layout": "./Layout.tsx",
     ".": "./index.ts",
-    "./vite-config": "./dist/vite.config.js",
     "./config": "./dist/+config.js",
     "./style": "./css/index.css",
     "./types": {
@@ -53,9 +52,6 @@
       "types": [
         "./types.d.ts"
       ],
-      "vite-config": [
-        "./dist/vite.config.d.ts"
-      ],
       "config": [
         "./dist/+config.d.ts"
       ]

package/parsePageSections.ts

@@ -1,6 +1,7 @@
 export { parsePageSections }
 export type { PageSection }
 
+import type { PluginOption } from 'vite'
 import { assert } from './utils/assert.js'
 import { determineSectionUrlHash } from './utils/determineSectionUrlHash.js'
 import os from 'os'
@@ -11,7 +12,7 @@ type PageSection = {
   pageSectionLevel: number
 }
 
-function parsePageSections() {
+function parsePageSections(): PluginOption {
   return {
     name: '@brillout/docpress:parsePageSections',
     enforce: 'pre',

package/renderer/onBeforeRender.ts

@@ -1,6 +1,6 @@
 export { onBeforeRender }
 
-import { resolvePageContext, type PageContextOriginal, type PageContextResolved } from '../config/resolvePageContext'
+import { resolvePageContext, type PageContextOriginal } from '../config/resolvePageContext'
 
 function onBeforeRender(pageContextOriginal: PageContextOriginal) {
   const pageContextResolved = resolvePageContext(pageContextOriginal)

package/utils/assert.ts

@@ -76,8 +76,10 @@ function assertWarning(condition: unknown, msg: string) {
   }
   msg = '[DocPress][Warning] ' + msg
   const err = new Error(msg)
-  console.warn(err)
-  if (isDevMode()) {
-    window.alert(err)
+  if (import.meta.env.DEV) {
+    console.warn(err)
+    if (isDevMode()) window.alert(err)
+  } else {
+    throw err
   }
 }

package/vite.config.ts

@@ -1,7 +1,8 @@
+export { config as viteConfig }
+
 import mdx from '@mdx-js/rollup'
 import react from '@vitejs/plugin-react-swc'
-import vike from 'vike/plugin'
-import { UserConfig } from 'vite'
+import type { PluginOption, UserConfig } from 'vite'
 import { parsePageSections } from './parsePageSections.js'
 import rehypePrettyCode from 'rehype-pretty-code'
 import remarkGfm from 'remark-gfm'
@@ -16,15 +17,9 @@ const config: UserConfig = {
   root,
   plugins: [
     parsePageSections(),
-    mdx({ rehypePlugins, remarkPlugins }),
+    mdx({ rehypePlugins, remarkPlugins }) as PluginOption,
     // @vitejs/plugin-react-swc needs to be added *after* the mdx plugins
     react(),
-    vike({
-      prerender: {
-        noExtraDir: true,
-      },
-      includeAssetsImportedByServer: true,
-    }),
   ],
   optimizeDeps: {
     include: ['react', 'react-dom', 'react-dom/client'],
@@ -33,7 +28,10 @@ const config: UserConfig = {
   ssr: {
     noExternal: ['@brillout/docpress', '@docsearch/react'],
   },
+  // Suppress following warning:
+  // ```
+  // ▲ [WARNING] Transforming this CSS nesting syntax is not supported in the configured target environment ("chrome87", "edge88", "es2020", "firefox78", "safari14") [unsupported-css-nesting]
+  // ```
+  build: { target: 'es2022' },
   clearScreen: false,
 }
-
-export default config

package/config/getConfig.ts

@@ -1,19 +0,0 @@
-export { getConfig }
-import { assert, assertUsage } from '../utils/server'
-import { Config } from '../types/Config'
-
-function getConfig(): Config {
-  // We use `@ts-ignore` because the DocPress user most likely didn't add `vite/client` in his `tsconfig.json`.
-  // @ts-ignore
-  const globResult = import.meta.glob('/**/docpress.config.*([a-zA-Z0-9])', { eager: true })
-  const files = Object.keys(globResult)
-  assertUsage(files.length >= 1, 'No DocPress config file found `docpress.config.(js|ts|tsx|...)`')
-  assertUsage(
-    files.length === 1,
-    `Found multiple \`docpress.config.js\` files: ${files.map((f) => `\`${f}\``).join(', ')}. Define only one instead.`,
-  )
-  const exports: any = Object.values(globResult)[0]
-  const config: Config = exports.default || exports.config
-  assert(config)
-  return config
-}

package/dist/config/getConfig.d.ts

@@ -1,3 +0,0 @@
-export { getConfig };
-import { Config } from '../types/Config';
-declare function getConfig(): Config;

package/dist/config/getConfig.js

@@ -1,14 +0,0 @@
-export { getConfig };
-import { assert, assertUsage } from '../utils/server';
-function getConfig() {
-    // We use `@ts-ignore` because the DocPress user most likely didn't add `vite/client` in his `tsconfig.json`.
-    // @ts-ignore
-    var globResult = import.meta.glob('/**/docpress.config.*([a-zA-Z0-9])', { eager: true });
-    var files = Object.keys(globResult);
-    assertUsage(files.length >= 1, 'No DocPress config file found `docpress.config.(js|ts|tsx|...)`');
-    assertUsage(files.length === 1, "Found multiple `docpress.config.js` files: ".concat(files.map(function (f) { return "`".concat(f, "`"); }).join(', '), ". Define only one instead."));
-    var exports = Object.values(globResult)[0];
-    var config = exports.default || exports.config;
-    assert(config);
-    return config;
-}