@brillout/docpress 0.6.20 → 0.6.21-commit-74553e7

package/dist/components/Consulting.js

@@ -0,0 +1,39 @@
+export { Consulting, Consultants };
+import React from 'react';
+import iconPeople from '../icons/people.svg';
+import { usePageContext } from '../renderer/usePageContext';
+import { SupporterSection, SectionDescription, CallToAction } from './Supporters';
+import { Maintainer } from './Contributors';
+import { maintainers } from '../data/maintainersList';
+import { Link } from './Link';
+var consultingPageHref = '/consulting';
+function Consulting() {
+    var pageContext = usePageContext();
+    var projectInfo = pageContext.config.projectInfo;
+    var projectName = projectInfo.projectName;
+    return (React.createElement(SupporterSection, null,
+        React.createElement(CallToAction, { iconUrl: iconPeople, text: "Consulting", href: consultingPageHref }),
+        React.createElement("div", null),
+        React.createElement(SectionDescription, null,
+            "For questions and issues related to ",
+            projectName,
+            ", open a",
+            ' ',
+            React.createElement("a", { href: projectInfo.githubDiscussions || projectInfo.githubIssues }, "GitHub Discussion"),
+            ". For advanced help or help not directly related to ",
+            projectName,
+            ", the ",
+            projectName,
+            " team offers",
+            ' ',
+            React.createElement(Link, { href: consultingPageHref, noBreadcrumb: true }, "consulting"),
+            ".")));
+}
+function Consultants() {
+    return (React.createElement(SupporterSection, null,
+        React.createElement("div", { style: { display: 'flex', flexWrap: 'wrap', alignItems: 'end' } }, maintainers
+            .filter(function (maintainer) {
+            return !!maintainer.consultingUrl;
+        })
+            .map(function (maintainer, i) { return (React.createElement(Maintainer, { maintainer: maintainer, key: i })); }))));
+}

package/dist/components/Contributors.d.ts

@@ -0,0 +1,7 @@
+export { Contributors, Maintainer };
+import React from 'react';
+import { maintainers } from '../data/maintainersList';
+declare function Contributors(): React.JSX.Element;
+declare function Maintainer({ maintainer }: {
+    maintainer: (typeof maintainers)[0];
+}): React.JSX.Element;

package/dist/components/Contributors.js

@@ -0,0 +1,74 @@
+export { Contributors, Maintainer };
+import React from 'react';
+import { usePageContext } from '../renderer/usePageContext';
+import { Supporter, SupporterSection, SectionDescription, Individuals, SupporterImg } from './Supporters';
+import { maintainers } from '../data/maintainersList';
+import { contributors } from 'vike-contributors'; // sorted by number of contributions
+function Contributors() {
+    var pageContext = usePageContext();
+    var projectInfo = pageContext.config.projectInfo;
+    return (React.createElement(SupporterSection, null,
+        React.createElement(SectionDescription, null,
+            projectInfo.projectName,
+            " is built and maintained by passionate contributors."),
+        React.createElement("div", { style: { display: 'flex', flexWrap: 'wrap', justifyContent: 'space-evenly', alignItems: 'end' } }, maintainers.map(function (maintainer, i) { return (React.createElement(Maintainer, { maintainer: maintainer, key: i })); })),
+        React.createElement(Individuals, null, contributors
+            .filter(function (contributor) {
+            return (!contributor.login.includes('[bot]') && !maintainers.map(function (m) { return m.username; }).includes(contributor.login));
+        })
+            .map(function (contributor, i) { return (React.createElement(Supporter, { username: contributor.login, avatarUrl: contributor.avatarUrl, key: i })); }))));
+}
+function Maintainer(_a) {
+    var maintainer = _a.maintainer;
+    var marginHeight = 20;
+    var marginWidth = 10;
+    var imgSize = 50;
+    var githubUrl = "https://github.com/".concat(maintainer.username);
+    return (React.createElement("div", { style: {
+            borderRadius: 7,
+            borderWidth: 1,
+            borderStyle: 'solid',
+            borderColor: '#e0e0e0',
+            overflow: 'hidden',
+            width: 430,
+            maxWidth: "calc(100vw - 2 * var(--main-view-padding) - 2 * ".concat(marginWidth, "px)"),
+            margin: "".concat(marginHeight, "px ").concat(marginWidth, "px"),
+            display: 'flex',
+            flexWrap: 'wrap',
+            padding: 20,
+            gap: 20,
+            textAlign: 'left',
+        } },
+        React.createElement("a", { href: githubUrl },
+            React.createElement("div", { style: { width: imgSize, height: imgSize, borderRadius: imgSize / 2, overflow: 'hidden' } },
+                React.createElement(SupporterImg, { username: maintainer.username, avatarUrl: getAvatarUrl(maintainer), imgAlt: maintainer.firstName, width: imgSize, height: imgSize }))),
+        React.createElement("div", null,
+            React.createElement("b", null, maintainer.firstName),
+            " \u00B7",
+            ' ',
+            React.createElement("a", { href: githubUrl },
+                React.createElement("i", { style: { fontSize: '.9em', color: '#505050' } }, maintainer.username)),
+            maintainer.consultingUrl ? (React.createElement(React.Fragment, null,
+                ' ',
+                "\u00B7",
+                ' ',
+                React.createElement("a", { href: maintainer.consultingUrl },
+                    React.createElement("b", { style: {
+                            fontSize: '.7em',
+                            color: 'white',
+                            backgroundColor: '#305090',
+                            padding: '1px 5px 2px 5px',
+                            verticalAlign: 'text-top',
+                            borderRadius: 3,
+                        } }, "consulting")))) : null,
+            React.createElement("ul", { style: { fontSize: '.8em', paddingLeft: 15, marginTop: 5, marginBottom: 0 } }, maintainer.roles.map(function (role, i) { return (React.createElement("li", { key: i }, role)); })))));
+}
+function getAvatarUrl(maintainer) {
+    for (var _i = 0, contributors_1 = contributors; _i < contributors_1.length; _i++) {
+        var contributor = contributors_1[_i];
+        if (maintainer.username === contributor.login) {
+            return contributor.avatarUrl;
+        }
+    }
+    throw new Error("Maintainer ".concat(maintainer.username, " not found in contributors' list."));
+}

package/dist/components/FileRemoved.d.ts

@@ -0,0 +1,9 @@
+export { FileRemoved };
+export { FileAdded };
+import React from 'react';
+declare function FileRemoved({ children }: {
+    children: React.ReactNode;
+}): React.JSX.Element;
+declare function FileAdded({ children }: {
+    children: React.ReactNode;
+}): React.JSX.Element;

package/dist/components/FileRemoved.js

@@ -0,0 +1,28 @@
+export { FileRemoved };
+export { FileAdded };
+import React from 'react';
+// Styling defined in src/css/code/diff.css
+var classRemoved = [
+    //
+    'diff-entire-file',
+    'diff-entire-file-removed',
+].join(' ');
+var classAdded = [
+    //
+    'diff-entire-file',
+    'diff-entire-file-added',
+].join(' ');
+function FileRemoved(_a) {
+    var children = _a.children;
+    return React.createElement("div", { className: classRemoved },
+        " ",
+        children,
+        " ");
+}
+function FileAdded(_a) {
+    var children = _a.children;
+    return React.createElement("div", { className: classAdded },
+        " ",
+        children,
+        " ");
+}

package/dist/components/HorizontalLine.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+export { HorizontalLine };
+declare function HorizontalLine({ primary }: {
+    primary?: true;
+}): React.JSX.Element;

package/dist/components/HorizontalLine.js

@@ -0,0 +1,15 @@
+import React from 'react';
+export { HorizontalLine };
+function HorizontalLine(_a) {
+    var primary = _a.primary;
+    return (React.createElement("div", { className: 'header-separator-line ' + (primary ? 'primary' : ''), style: { textAlign: 'center' } },
+        React.createElement("hr", { style: {
+                display: 'inline-block',
+                margin: 0,
+                border: 0,
+                // Same as `.doc-page h2::after`
+                borderTop: '1px solid #eaeaea',
+                maxWidth: 500,
+                width: '80%',
+            } })));
+}

package/dist/components/ImportMeta.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+export { ImportMeta };
+declare function ImportMeta({ prop }: {
+    prop: string;
+}): React.JSX.Element;

package/dist/components/ImportMeta.js

@@ -0,0 +1,10 @@
+import React from 'react';
+import { assert } from '../utils/server';
+export { ImportMeta };
+function ImportMeta(_a) {
+    var prop = _a.prop;
+    assert(!prop.startsWith('import'));
+    assert(!prop.startsWith('.'));
+    var text = 'imp' + 'ort.meta.' + prop;
+    return React.createElement("code", null, text);
+}

package/dist/components/Link.d.ts

@@ -0,0 +1,16 @@
+export { Link };
+export type { LinkData };
+import React from 'react';
+declare function Link({ href, text, noBreadcrumb, doNotInferSectionTitle, children, }: {
+    href: string;
+    text?: string | JSX.Element;
+    noBreadcrumb?: true;
+    doNotInferSectionTitle?: true;
+    children?: React.ReactNode;
+}): React.JSX.Element;
+type LinkData = {
+    url?: null | string;
+    title: string;
+    linkBreadcrumb: null | string[];
+    sectionTitles?: string[];
+};

package/dist/components/Link.js

@@ -0,0 +1,108 @@
+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 { parseTitle } from '../parseTitle';
+import pc from '@brillout/picocolors';
+function Link(_a) {
+    var href = _a.href, text = _a.text, noBreadcrumb = _a.noBreadcrumb, doNotInferSectionTitle = _a.doNotInferSectionTitle, children = _a.children;
+    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`');
+    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 })));
+    }
+}
+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 breadcrumbParts = [];
+    if (linkData.linkBreadcrumb) {
+        breadcrumbParts.push.apply(breadcrumbParts, ((_b = linkData.linkBreadcrumb) !== null && _b !== void 0 ? _b : []).slice().reverse().map(parseTitle));
+    }
+    breadcrumbParts.push(parseTitle(linkData.title));
+    if (hrefHash) {
+        var sectionTitle_1 = undefined;
+        assert(!hrefHash.startsWith('#'));
+        if (isLinkOnSamePage) {
+            var linkDataPageSection = findLinkData("#".concat(hrefHash), pageContext);
+            sectionTitle_1 = parseTitle(linkDataPageSection.title);
+        }
+        else if ('sectionTitles' in linkData && linkData.sectionTitles) {
+            linkData.sectionTitles.forEach(function (title) {
+                if (determineSectionUrlHash(title) === hrefHash) {
+                    sectionTitle_1 = parseTitle(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];
+        }
+    }
+    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 findLinkData(href, pageContext) {
+    assert(href.startsWith('/') || href.startsWith('#'));
+    var linksAll = pageContext.linksAll;
+    var linkData = linksAll.find(function (_a) {
+        var url = _a.url;
+        return href === url;
+    });
+    if (href.startsWith('#')) {
+        assertUsage(linkData, "Couldn't find ".concat(href, " in ").concat(pageContext.urlPathname, ", does it exist?"));
+    }
+    else {
+        assertUsage(linkData, [
+            "Couldn't find page with URL ".concat(pc.bold(href)),
+            "\u2014 did you define it in",
+            [
+                pc.cyan('docpress.config.js'),
+                pc.dim('#{'),
+                pc.cyan('headings'),
+                pc.dim(','),
+                pc.cyan('headingsDetached'),
+                pc.dim('}'),
+                '?',
+            ].join(''),
+        ].join(' '));
+    }
+    return linkData;
+}
+function parseHref(href) {
+    var hrefHash = null;
+    var hrefPathname = null;
+    if (!href.includes('#')) {
+        hrefPathname = href;
+    }
+    else {
+        var _a = href.split('#'), partsFirst = _a[0], partsRest = _a.slice(1);
+        if (partsFirst) {
+            hrefPathname = partsFirst;
+        }
+        hrefHash = partsRest.join('#');
+    }
+    assert(hrefPathname !== null || hrefHash !== null);
+    assert(hrefPathname || hrefHash);
+    return { hrefPathname: hrefPathname, hrefHash: hrefHash };
+}

package/dist/components/Note.d.ts

@@ -0,0 +1,22 @@
+export { Warning };
+export { Advanced };
+export { Construction };
+export { Contribution };
+export { Danger };
+export { NoteWithoutIcon };
+export { NoteWithCustomIcon };
+import React from 'react';
+type Props = {
+    children: React.ReactNode;
+    style?: React.CSSProperties;
+};
+declare function Warning(props: Props): React.JSX.Element;
+declare function Advanced(props: Props): React.JSX.Element;
+declare function Construction(props: Props): React.JSX.Element;
+declare function Contribution(props: Props): React.JSX.Element;
+declare function Danger(props: Props): React.JSX.Element;
+declare function NoteWithoutIcon(props: Props): React.JSX.Element;
+type CustomIcon = JSX.Element | string;
+declare function NoteWithCustomIcon(props: Props & {
+    icon: CustomIcon;
+}): React.JSX.Element;

package/dist/components/Note.js

@@ -0,0 +1,93 @@
+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 { Warning };
+export { Advanced };
+export { Construction };
+export { Contribution };
+export { Danger };
+export { NoteWithoutIcon };
+export { NoteWithCustomIcon };
+/* Use markdown instead:
+ * ```diff
+ * - <Note>Some note</Note>
+ * + > Some note
+ * ```
+export { Note }
+*/
+import React from 'react';
+import { assert } from '../utils/assert';
+function Warning(props) {
+    return React.createElement(NoteGeneric, __assign({ type: "warning" }, props));
+}
+function Advanced(props) {
+    return React.createElement(NoteGeneric, __assign({ type: "advanced" }, props));
+}
+function Construction(props) {
+    return React.createElement(NoteGeneric, __assign({ type: "construction" }, props));
+}
+function Contribution(props) {
+    return React.createElement(NoteGeneric, __assign({ type: "contribution" }, props));
+}
+function Danger(props) {
+    return React.createElement(NoteGeneric, __assign({ type: "danger" }, props));
+}
+function NoteWithoutIcon(props) {
+    return React.createElement(NoteGeneric, __assign({ icon: null }, props));
+}
+function NoteWithCustomIcon(props) {
+    var icon = props.icon;
+    if (!icon)
+        throw new Error("<NoteWithCustomIcon icon={/*...*/}> property 'icon' is `".concat(icon, "` which is forbidden"));
+    return React.createElement(NoteGeneric, __assign({}, props));
+}
+function NoteGeneric(_a) {
+    var type = _a.type, icon = _a.icon, iconMargin = _a.iconMargin, children = _a.children, style = _a.style;
+    assert(icon === null || icon || type, { icon: icon, type: type });
+    iconMargin !== null && iconMargin !== void 0 ? iconMargin : (iconMargin = 2);
+    var className = 'custom-icon';
+    if (type) {
+        className = "".concat(className, " type-").concat(type);
+    }
+    if (!icon && type) {
+        var classColor = '';
+        if (type === 'danger') {
+            icon = '⛔';
+            classColor = 'note-color-red';
+        }
+        if (type === 'warning') {
+            icon = '⚠️';
+            classColor = 'note-color-yellow';
+        }
+        if (type === 'construction') {
+            icon = '🚧';
+            classColor = 'note-color-yellow';
+        }
+        if (type === 'contribution') {
+            icon = '💚';
+            classColor = 'note-color-green';
+        }
+        if (type === 'advanced') {
+            icon = '🧠';
+            classColor = 'note-color-pink';
+        }
+        assert(icon);
+        assert(classColor);
+        className = "".concat(className, " ").concat(classColor);
+    }
+    return (React.createElement("blockquote", { className: className, style: style },
+        React.createElement("div", { style: { marginBottom: 20 } }),
+        React.createElement("span", { style: { fontFamily: 'emoji' } }, icon),
+        React.createElement("span", { style: { width: iconMargin !== null && iconMargin !== void 0 ? iconMargin : undefined, display: 'inline-block' } }),
+        ' ',
+        React.createElement("div", { className: "blockquote-content" }, children),
+        React.createElement("div", { style: { marginTop: 20 } })));
+}

package/dist/components/P.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import './P.css';
+export { P };
+declare function P(props: React.HTMLProps<HTMLDivElement>): React.JSX.Element;

package/dist/components/P.js

@@ -0,0 +1,17 @@
+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);
+};
+import React from 'react';
+import './P.css';
+export { P };
+function P(props) {
+    return React.createElement("div", __assign({}, props, { className: 'paragraph' }));
+}

package/dist/components/ReadingRecommendation.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+export { ReadingRecommendation };
+declare function ReadingRecommendation({ tour, links }: {
+    tour?: true;
+    links?: string[];
+}): React.JSX.Element;

package/dist/components/ReadingRecommendation.js

@@ -0,0 +1,40 @@
+import React from 'react';
+import { Link } from './Link';
+export { ReadingRecommendation };
+// TODO/eventually: remove
+function ReadingRecommendation(_a) {
+    var tour = _a.tour, links = _a.links;
+    links !== null && links !== void 0 ? links : (links = []);
+    if (!links.length)
+        tour = true;
+    var multiple = links.length + (tour ? 1 : 0) > 1;
+    var intro = React.createElement("b", null,
+        "Reading Recommendation",
+        multiple ? '.' : ': ');
+    return (React.createElement("blockquote", null, (function () {
+        if (!multiple) {
+            var link = tour ? React.createElement(TourLink, null) : React.createElement(Link, { href: links[0] });
+            return (React.createElement("p", null,
+                intro,
+                link));
+        }
+        return (React.createElement(React.Fragment, null,
+            React.createElement("p", null,
+                " ",
+                intro),
+            React.createElement("ul", { style: {
+                    marginLeft: 18,
+                    marginTop: 11,
+                } },
+                tour && (React.createElement("li", null,
+                    React.createElement(TourLink, null))),
+                links.map(function (link, i) { return (React.createElement("li", { key: i },
+                    React.createElement(Link, { href: link }))); }))));
+    })()));
+}
+function TourLink() {
+    return (React.createElement(React.Fragment, null,
+        React.createElement(Link, { href: '/react-tour', noBreadcrumb: true }),
+        " or ",
+        React.createElement(Link, { href: '/vue-tour', noBreadcrumb: true })));
+}

package/dist/components/RepoLink.d.ts

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

package/dist/components/RepoLink.js

@@ -0,0 +1,22 @@
+import React from 'react';
+import { assert } from '../utils/server';
+import { usePageContext } from '../renderer/usePageContext';
+export { RepoLink };
+export { isRepoLink };
+function isRepoLink(href) {
+    return ['/examples/', '/docs/', '/boilerplates/', '.github/', '/test/'].some(function (start) { return href.startsWith(start); });
+}
+function RepoLink(_a) {
+    var path = _a.path, text = _a.text, editMode = _a.editMode;
+    var pageContext = usePageContext();
+    assert(isRepoLink(path), { path: path });
+    text = text || path;
+    if (!path.startsWith('/')) {
+        path = '/' + path;
+    }
+    var viewMode = path.endsWith('/') || editMode ? 'tree' : 'blob';
+    var githubRepository = pageContext.config.projectInfo.githubRepository;
+    assert(githubRepository.startsWith('https://github.com/'));
+    var href = "".concat(githubRepository, "/").concat(viewMode, "/main").concat(path);
+    return React.createElement("a", { href: href }, text);
+}

package/dist/components/Sponsors.d.ts

@@ -0,0 +1,22 @@
+export { Sponsors };
+export type { Sponsor };
+import React from 'react';
+type Plan = 'indie' | 'bronze' | 'silver' | 'gold' | 'platinum';
+type SponsorCompany = {
+    companyName: string;
+    companyLogo: string;
+    website: string;
+    plan: Plan;
+    divSize?: Partial<DivSize>;
+    github: string;
+};
+type SponsorIndividual = {
+    username: string;
+};
+type Sponsor = SponsorCompany | SponsorIndividual;
+type DivSize = {
+    width: number;
+    height: number;
+    padding: number;
+};
+declare function Sponsors(): React.JSX.Element;