@brillout/docpress 0.5.38 → 0.5.40-commit-1ba896e

package/css/table.css

@@ -0,0 +1,14 @@
+table th {
+  background-color: #f7f7f7;
+}
+table {
+  border-collapse: collapse;
+}
+table td,
+table th {
+  padding: 8px;
+  border: 1px solid #ccc;
+}
+table th {
+  text-align: left;
+}

package/css/tooltip.css

@@ -0,0 +1,11 @@
+@import 'balloon-css';
+
+:root {
+  --balloon-color: #444;
+  --balloon-move: 2px;
+  --balloon-font-size: 14px;
+  --balloon-border-radius: 5px;
+}
+[aria-label][data-balloon-pos]:after {
+  font-family: 'Inter';
+}

package/data/maintainersList.tsx

@@ -0,0 +1,92 @@
+export { maintainers }
+
+import React from 'react'
+
+type Maintainer = {
+  username: string
+  firstName: string
+  roles: React.ReactNode[]
+  consultingUrl?: string
+}
+
+const maintainers: Maintainer[] = [
+  {
+    username: 'brillout',
+    firstName: 'Rom',
+    roles: [
+      <>Vike Core (Lead Maintainer, Creator)</>,
+      <>
+        <code>vike-react</code> (Lead Maintainer, Creator)
+      </>,
+      <>
+        <code>vike-vue</code> (Contributor)
+      </>
+    ]
+  },
+  {
+    username: 'magne4000',
+    firstName: 'Joël',
+    roles: [
+      <>Bati (Lead Maintainer, Creator)</>,
+      <>
+        <code>vike-solid</code> (Lead Maintainer, Creator)
+      </>,
+      <>Vike Core (Contributor)</>
+    ]
+  },
+  {
+    username: 'AurelienLourot',
+    firstName: 'Aurélien',
+    roles: [
+      <>
+        <code>vike-vue</code> (Lead Maintainer, Creator)
+      </>,
+      <>
+        <code>vike-react</code> (Contributor)
+      </>,
+      <>Vike Core (Contributor)</>
+    ]
+    // consultingUrl: 'https://lourot.dev/'
+  },
+  {
+    username: 'nitedani',
+    firstName: 'Dániel',
+    roles: [
+      <>
+        <code>vike-react-query</code> (Lead Maintainer, Creator)
+      </>,
+      <>
+        <code>vike-angular</code> (Lead Maintainer, Creator)
+      </>,
+      <>Vike Core (Contributor)</>
+    ]
+  },
+  {
+    username: 'phonzammi',
+    firstName: 'Muhammad',
+    roles: [
+      <>
+        <code>vike-vue</code> (Contributor)
+      </>,
+      <>
+        <code>vike-solid</code> (Contributor)
+      </>,
+      <>
+        <code>vike-react</code> (Contributor)
+      </>
+    ]
+  },
+  {
+    username: '4350pChris',
+    firstName: 'Chris',
+    roles: [
+      <>
+        <code>vike-pinia</code> (Lead Maintainer, Creator)
+      </>,
+      <>
+        <code>vike-vue</code> (Contributor)
+      </>,
+      <>Vike Core (Contributor)</>
+    ]
+  }
+]

package/data/sponsorsList.ts

@@ -0,0 +1,147 @@
+export { sponsorsList }
+
+import type { Sponsor } from '../components/Sponsors'
+import contraLogo from './sponsorsList/companyLogos/contra.svg'
+import optimizersLogo from './sponsorsList/companyLogos/optimizers.svg'
+import sourcegraphLogo from './sponsorsList/companyLogos/sourcegraph.svg'
+import burdaforwardLogo from './sponsorsList/companyLogos/burdaforward.png'
+import ecosiaLogo from './sponsorsList/companyLogos/ecosia.svg'
+import inlangLogo from './sponsorsList/companyLogos/inlang.png'
+import bluefinLogo from './sponsorsList/companyLogos/bluefin.svg'
+import alignableLogo from './sponsorsList/companyLogos/alignable.svg'
+
+const individuals: Sponsor[] = [
+  { username: 'arp' },
+  { username: 'tlancina' },
+  { username: 'shishkin17' },
+  { username: 'royalswe' },
+  { username: 'lebretont' },
+  { username: 'xar' },
+  { username: 'NicoZweifel' },
+  { username: 'mariuslian' },
+  { username: 'shortpoet' },
+  { username: 'sqs' },
+  { username: 'dylmye' },
+  { username: 'isakura313' },
+  { username: 'rivatove' },
+  { username: 'SMKJALLAD' },
+  { username: 'routinghub' },
+  { username: 'LostCrew' }, // Ecosia
+  { username: 'jakubfiala' }, // Ecosia
+  { username: 'HarshwardhanSingh' },
+  { username: 'd3x7r0' },
+  { username: 'ChristophP' }, // BurdaForward
+  { username: 'msiegenthaler' },
+  { username: 'linkyard' },
+  { username: 'AnukarOP' },
+  { username: 'RoyMcCrain' },
+  { username: 'chrisvander' }, // Bluefin
+  { username: 'EralChen' },
+  { username: '3dyuval' },
+  { username: 'talzion12' },
+  { username: 'felixhaeberle' },
+  { username: 'apappas1129' },
+  /* 404
+  { username: 'agalbenus' },
+  */
+  { username: 'phiberber' },
+  { username: 'cookieplace' },
+  { username: 'JiangWeixian' },
+  { username: 'harrytran998' },
+  { username: 'alexturpin' },
+  { username: 'gu-stav' },
+  { username: 'YannBirba' },
+  { username: 'fi3ework' },
+  { username: 'EJM-Company' },
+  { username: 'Nelie-Taylor' },
+  { username: 'fortezhuo' },
+  { username: 'nshelia' },
+  { username: 'marcusway' },
+  { username: 'edikdeisling' },
+  { username: 'AurelienLourot' },
+  { username: 'jahredhope' },
+  { username: 'charlieforward9' },
+  { username: 'leonmondria' },
+  { username: 'jscottsf' },
+  { username: 'micah-redwood' },
+  { username: 'nicka-redwood' },
+  { username: 'ser1us' },
+  { username: 'nikitavoloboev' },
+  { username: 'samuelstroschein' },
+  { username: 'npacucci' },
+  { username: 'szarapka' },
+  { username: 'techniath' },
+  { username: 'DannyZB' },
+  { username: 'pieperz' },
+  { username: 'hemengke1997' },
+  { username: 'spacedawwwg' },
+  { username: 'arthurgailes' },
+  { username: 'stackblitz' },
+  { username: 'codthing' },
+  { username: 'Junaidhkn' },
+  { username: 'zgfdev' }
+]
+
+const companies: Sponsor[] = [
+  {
+    companyName: 'Contra',
+    companyLogo: contraLogo,
+    plan: 'silver',
+    website: 'https://contra.com',
+    github: 'contra'
+  },
+  {
+    companyName: 'Inlang',
+    companyLogo: inlangLogo,
+    plan: 'silver',
+    website: 'https://inlang.com/',
+    github: 'opral'
+  },
+  {
+    companyName: 'Alignable',
+    companyLogo: alignableLogo,
+    plan: 'silver',
+    website: 'https://www.alignable.com/',
+    github: 'AlignableUser'
+  },
+  {
+    companyName: 'Sourcegraph',
+    companyLogo: sourcegraphLogo,
+    plan: 'bronze',
+    website: 'https://sourcegraph.com',
+    github: 'sourcegraph'
+  },
+  {
+    companyName: 'Optimizers',
+    companyLogo: optimizersLogo,
+    plan: 'bronze',
+    website: 'https://www.optimizers.nl/',
+    divSize: {
+      padding: 20
+    },
+    github: 'OptimizersGroup'
+  },
+  {
+    companyName: 'BurdaFoward',
+    companyLogo: burdaforwardLogo,
+    plan: 'bronze',
+    website: 'https://www.burda-forward.de',
+    github: 'BurdaForward'
+  },
+  {
+    companyName: 'Ecosia',
+    companyLogo: ecosiaLogo,
+    plan: 'bronze',
+    website: 'https://ecosia.org',
+    github: 'ecosia'
+  },
+  {
+    companyName: 'Bluefin',
+    companyLogo: bluefinLogo,
+    plan: 'indie',
+    website: 'https://www.bluefin.one',
+    github: 'bluefin-clinical'
+  }
+]
+
+const sponsorsList: Sponsor[] = [...companies, ...individuals]

package/dist/markdownHeadingsVitePlugin.d.ts

@@ -0,0 +1,13 @@
+export { markdownHeadingsVitePlugin };
+export type { MarkdownHeading };
+type MarkdownHeading = {
+    title: string;
+    headingId: string | null;
+    headingLevel: number;
+    titleAddendum?: string;
+};
+declare function markdownHeadingsVitePlugin(): {
+    name: string;
+    enforce: string;
+    transform: (code: string, id: string) => Promise<string | undefined>;
+};

package/dist/markdownHeadingsVitePlugin.js

@@ -0,0 +1,170 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+export { markdownHeadingsVitePlugin };
+import { assert } from './utils/assert.js';
+import { determineSectionUrlHash } from './utils/determineSectionUrlHash.js';
+import os from 'os';
+function markdownHeadingsVitePlugin() {
+    var _this = this;
+    return {
+        name: 'mdx-headings',
+        enforce: 'pre',
+        transform: function (code, id) { return __awaiter(_this, void 0, void 0, function () {
+            var codeNew;
+            return __generator(this, function (_a) {
+                if (!id.endsWith('+Page.mdx')) {
+                    return [2 /*return*/];
+                }
+                codeNew = transform(code);
+                return [2 /*return*/, codeNew];
+            });
+        }); }
+    };
+}
+function transform(code) {
+    var headings = [];
+    var isCodeBlock = false;
+    var codeNew = code
+        .split('\n')
+        .map(function (line) {
+        // Skip code blocks, e.g.
+        // ~~~md
+        // # Markdown Example
+        // Bla
+        // ~~~
+        if (line.startsWith('~~~') || line.startsWith('```')) {
+            isCodeBlock = !isCodeBlock;
+            return line;
+        }
+        if (isCodeBlock) {
+            return line;
+        }
+        if (line.startsWith('#')) {
+            var _a = parseMarkdownHeading(line), headingId = _a.headingId, headingLevel = _a.headingLevel, title = _a.title, headingHtml = _a.headingHtml;
+            headings.push({ headingId: headingId, headingLevel: headingLevel, title: title });
+            return headingHtml;
+        }
+        return line;
+    })
+        .join('\n');
+    var headingsExportCode = "export const headings = [".concat(headings
+        .map(function (heading) { return JSON.stringify(heading); })
+        .join(', '), "];");
+    codeNew += "\n\n".concat(headingsExportCode, "\n");
+    return codeNew;
+}
+function parseMarkdownHeading(line) {
+    var _a;
+    var _b = line.split(' '), lineBegin = _b[0], lineWords = _b.slice(1);
+    assert(lineBegin.split('#').join('') === '', { line: line, lineWords: lineWords });
+    var headingLevel = lineBegin.length;
+    var titleMdx = lineWords.join(' ');
+    assert(!titleMdx.startsWith(' '), { line: line, lineWords: lineWords });
+    assert(titleMdx, { line: line, lineWords: lineWords });
+    var headingMdx = {
+        title: titleMdx,
+        anchor: titleMdx
+    };
+    {
+        // Support custom anchor like: `## title{#custom-anchor}`
+        var customAnchor = (_a = /(?<={#).*(?=})/g.exec(titleMdx)) === null || _a === void 0 ? void 0 : _a[0];
+        if (customAnchor) {
+            headingMdx.anchor = customAnchor;
+            headingMdx.title = titleMdx.replace(/{#.*}/g, '');
+        }
+    }
+    var headingId = determineSectionUrlHash(headingMdx.anchor);
+    var title = headingMdx.title;
+    var titleParsed = parseTitle(title);
+    assert(headingId === null || headingId.length > 0);
+    var headingAttrId = headingId === null ? '' : " id=\"".concat(headingId, "\"");
+    var headingHtml = "<h".concat(headingLevel).concat(headingAttrId, ">").concat(titleParsed, "</h").concat(headingLevel, ">");
+    var heading = { headingLevel: headingLevel, title: title, headingId: headingId, headingHtml: headingHtml };
+    return heading;
+}
+function parseTitle(titleMarkdown) {
+    var parts = [];
+    var current;
+    titleMarkdown.split('').forEach(function (letter) {
+        if (letter === '`') {
+            if ((current === null || current === void 0 ? void 0 : current.nodeType) === 'code') {
+                // </code>
+                parts.push(current);
+                current = undefined;
+            }
+            else {
+                // <code>
+                if (current) {
+                    parts.push(current);
+                }
+                current = { nodeType: 'code', content: '' };
+            }
+        }
+        else {
+            if (!current) {
+                current = { nodeType: 'text', content: '' };
+            }
+            current.content += letter;
+        }
+    });
+    if (current) {
+        parts.push(current);
+    }
+    var titleHtml = parts
+        .map(function (part) {
+        if (part.nodeType === 'code') {
+            return "<code>".concat(serializeText(part.content), "</code>");
+        }
+        else {
+            assert(part.nodeType === 'text', { parts: parts });
+            return serializeText(part.content);
+        }
+    })
+        .join('');
+    return titleHtml;
+    function serializeText(text) {
+        var textEscaped = text.split("'").join("\\'");
+        // https://github.com/brillout/docpress/pull/2
+        if (isWindows()) {
+            textEscaped = textEscaped.replace(/\r/, '');
+        }
+        return "{'".concat(textEscaped, "'}");
+    }
+}
+function isWindows() {
+    return os.platform() === 'win32';
+}

package/dist/utils/assert.d.ts

@@ -0,0 +1,6 @@
+export { assert };
+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;

package/dist/utils/assert.js

@@ -0,0 +1,48 @@
+export { assert };
+export { assertUsage };
+export { assertWarning };
+function assert(condition, debugInfo) {
+    if (condition) {
+        return;
+    }
+    var hasDebugInfo = debugInfo !== undefined;
+    if (hasDebugInfo) {
+        console.log(debugInfo);
+        if (typeof debugInfo === 'object') {
+            debugInfo = JSON.stringify(debugInfo);
+        }
+    }
+    var errMsg = '[DocPress] Bug. Contact DocPress maintainer.';
+    if (hasDebugInfo) {
+        errMsg += ' Debug info: ' + String(debugInfo);
+    }
+    var err = new Error(errMsg);
+    if (isBrowserAndDev()) {
+        alert(err.stack);
+    }
+    throw err;
+}
+function assertUsage(condition, msg) {
+    if (condition) {
+        return;
+    }
+    var err = new Error('[DocPress][Wrong Usage] ' + msg);
+    if (isBrowserAndDev()) {
+        alert(err.stack);
+    }
+    throw err;
+}
+function isBrowserAndDev() {
+    var _a;
+    return typeof window !== 'undefined' && ((_a = window === null || window === void 0 ? void 0 : window.location) === null || _a === void 0 ? void 0 : _a.port) !== '';
+}
+function assertWarning(condition, msg) {
+    if (condition) {
+        return;
+    }
+    msg = '[DocPress][Warning] ' + msg;
+    console.warn(msg);
+    if (isBrowserAndDev()) {
+        alert(msg);
+    }
+}

package/dist/utils/determineSectionUrlHash.d.ts

@@ -0,0 +1,4 @@
+export { determineSectionUrlHash };
+export { determineSectionTitle };
+declare function determineSectionUrlHash(title: string): string | null;
+declare function determineSectionTitle(urlWithHash: string): string;

package/dist/utils/determineSectionUrlHash.js

@@ -0,0 +1,38 @@
+import { assert } from './assert.js';
+export { determineSectionUrlHash };
+export { determineSectionTitle };
+function determineSectionUrlHash(title) {
+    title = title.toLowerCase();
+    title = removeAccentsAndDiacritics(title);
+    var urlHash = title
+        // \u4E00-\u9FA5 are chinese characters, see https://github.com/brillout/docpress/pull/2
+        .split(/[^a-z0-9\u4E00-\u9FA5]+/)
+        .filter(Boolean)
+        .join('-');
+    // E.g. section is composed of only non-latin characters
+    if (urlHash === '')
+        return null;
+    return urlHash;
+}
+// Remove accents/diacritics in a string in JavaScript
+// https://stackoverflow.com/questions/990904/remove-accents-diacritics-in-a-string-in-javascript/37511463#37511463
+function removeAccentsAndDiacritics(str) {
+    return str.normalize('NFD').replace(/[\u0300-\u036f]/g, '');
+}
+function determineSectionTitle(urlWithHash) {
+    assert(urlWithHash.includes('#'), { urlWithHash: urlWithHash });
+    var urlHash = urlWithHash.split('#')[1];
+    var title = urlHash
+        .split('-')
+        .map(function (word, i) {
+        if (i === 0) {
+            return capitalizeFirstLetter(word);
+        }
+        return word;
+    })
+        .join(' ');
+    return title;
+}
+function capitalizeFirstLetter(word) {
+    return word[0].toUpperCase() + word.slice(1);
+}

package/dist/vite.config.d.ts

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

package/dist/vite.config.js

@@ -0,0 +1,32 @@
+import mdx from '@mdx-js/rollup';
+import react from '@vitejs/plugin-react-swc';
+import vike from 'vike/plugin';
+import { markdownHeadingsVitePlugin } from './markdownHeadingsVitePlugin.js';
+import rehypePrettyCode from 'rehype-pretty-code';
+import remarkGfm from 'remark-gfm';
+var root = process.cwd();
+var prettyCode = [rehypePrettyCode, { theme: 'github-light' }];
+var rehypePlugins = [prettyCode];
+var remarkPlugins = [remarkGfm];
+var config = {
+    root: root,
+    plugins: [
+        markdownHeadingsVitePlugin(),
+        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: ['@mdx-js/react', 'react-dom'] },
+    // @ts-ignore
+    ssr: {
+        noExternal: ['@brillout/docpress']
+    },
+    clearScreen: false
+};
+export default config;

package/index.ts

@@ -0,0 +1,4 @@
+export * from './components'
+export * from './utils/server'
+export type { Config } from './types/Config'
+export type { HeadingDefinition, HeadingDetachedDefinition } from './types/Heading'

package/installSectionUrlHashs.ts

@@ -0,0 +1,60 @@
+import { assert } from './utils/client'
+
+installSectionUrlHashs()
+/* Let browser restore previous scroll
+jumpToSection()
+*/
+
+function installSectionUrlHashs() {
+  const pageContainer = document.querySelector('.doc-page #page-container')
+  if (!pageContainer) {
+    assert(window.location.pathname === '/')
+    return
+  }
+  const headings = [...Array.from(document.querySelectorAll('h2')), ...Array.from(document.querySelectorAll('h3'))]
+  headings.forEach((heading) => {
+    if (!heading.id) return
+    const urlHash = '#' + heading.id
+    assertNavLink(urlHash, heading)
+    heading.onclick = () => {
+      window.location.hash = urlHash
+      // The browser doesn't jump if hash doesn't change
+      jumpToSection()
+    }
+  })
+}
+
+function assertNavLink(urlHash: string, heading: HTMLHeadingElement) {
+  const navigationEl = getNavigationEl()
+  {
+    const parentNavLinkMatch = Array.from(navigationEl.querySelectorAll(`a[href="${window.location.pathname}"]`))
+    assert(parentNavLinkMatch.length === 1)
+  }
+  {
+    const navLinks: HTMLElement[] = Array.from(navigationEl.querySelectorAll(`a[href="${urlHash}"]`))
+    const { tagName } = heading
+    assert(tagName.startsWith('H'))
+    const lengthExpected = tagName === 'H2' ? 1 : 0
+    assert(navLinks.length === lengthExpected, { urlHash })
+  }
+}
+
+function jumpToSection() {
+  const { hash } = window.location
+  if (hash === '' || hash === '#') {
+    return
+  }
+  assert(hash.startsWith('#'))
+  const target = document.getElementById(hash.slice(1))
+  if (!target) {
+    return
+  }
+  target.scrollIntoView()
+}
+
+function getNavigationEl() {
+  const elems: HTMLElement[] = Array.from(document.querySelectorAll('#navigation-container'))
+  assert(elems.length === 1)
+  const navigationEl = elems[0]!
+  return navigationEl
+}