@brillout/docpress 0.5.1 → 0.5.3

package/dist/index.d.ts

@@ -101,13 +101,9 @@ declare function RepoLink({ path, text, editMode }: {
 
 declare function P(props: React$1.HTMLProps<HTMLDivElement>): JSX.Element;
 
-declare function Info({ children }: {
-    children: React$1.ReactNode;
-}): JSX.Element;
-
 declare function ReadingRecommendation({ tour, links }: {
     tour?: true;
-    links: string[];
+    links?: string[];
 }): JSX.Element;
 
 declare function Warning({ children }: {
@@ -119,6 +115,14 @@ declare function Construction({ children }: {
 declare function Danger({ children }: {
     children: JSX.Element;
 }): JSX.Element;
+declare function NoteWithoutIcon({ children }: {
+    children: JSX.Element;
+}): JSX.Element;
+type CustomIcon = JSX.Element | string;
+declare function NoteWithCustomIcon({ icon, children }: {
+    children: JSX.Element;
+    icon: CustomIcon;
+}): JSX.Element;
 
 declare function ImportMeta({ prop }: {
     prop: string;
@@ -154,4 +158,4 @@ declare function CodeBlockTransformer({ children, lineBreak }: {
     lineBreak: LineBreak;
 }): JSX.Element;
 
-export { CodeBlockTransformer, Config, Construction, Danger, Emoji, EmojiName, HeadingDefinition, HeadingDetachedDefinition, HorizontalLine, ImportMeta, Info, Link, P, ReadingRecommendation, RepoLink, Sponsor, Sponsors, Warning, assert, assertUsage, assertWarning, crawlAllFiles, determineSectionTitle, determineSectionUrlHash, filter, isBrowser, isRepoLink, jsxToTextContent, objectAssign };
+export { CodeBlockTransformer, Config, Construction, Danger, Emoji, EmojiName, HeadingDefinition, HeadingDetachedDefinition, HorizontalLine, ImportMeta, Link, NoteWithCustomIcon, NoteWithoutIcon, P, ReadingRecommendation, RepoLink, Sponsor, Sponsors, Warning, assert, assertUsage, assertWarning, crawlAllFiles, determineSectionTitle, determineSectionUrlHash, filter, isBrowser, isRepoLink, jsxToTextContent, objectAssign };

package/dist/index.js

@@ -139,72 +139,83 @@ function P(props) {
   });
 }
 
-// src/components/Info.tsx
-import React3 from "react";
-function Info({ children }) {
-  return /* @__PURE__ */ React3.createElement("blockquote", null, /* @__PURE__ */ React3.createElement(P, null, children));
-}
-
 // src/components/ReadingRecommendation.tsx
-import React4 from "react";
+import React3 from "react";
 function ReadingRecommendation({ tour, links }) {
+  links ?? (links = []);
+  if (!links.length)
+    tour = true;
   const multiple = links.length + (tour ? 1 : 0) > 1;
-  return /* @__PURE__ */ React4.createElement(Info, null, multiple ? " " : "", /* @__PURE__ */ React4.createElement("b", null, "Reading Recommendation", multiple ? "." : ": "), (() => {
+  const intro = /* @__PURE__ */ React3.createElement("b", null, "Reading Recommendation", multiple ? "." : ": ");
+  return /* @__PURE__ */ React3.createElement("blockquote", null, (() => {
     if (!multiple) {
-      const link = tour ? /* @__PURE__ */ React4.createElement(TourLink, null) : /* @__PURE__ */ React4.createElement(Link, {
+      const link = tour ? /* @__PURE__ */ React3.createElement(TourLink, null) : /* @__PURE__ */ React3.createElement(Link, {
         href: links[0]
       });
-      return /* @__PURE__ */ React4.createElement(React4.Fragment, null, link, ".");
+      return /* @__PURE__ */ React3.createElement("p", null, intro, link);
     }
-    return /* @__PURE__ */ React4.createElement("ul", {
+    return /* @__PURE__ */ React3.createElement(React3.Fragment, null, /* @__PURE__ */ React3.createElement("p", null, " ", intro), /* @__PURE__ */ React3.createElement("ul", {
       style: {
         marginLeft: 18,
         marginTop: 11
       }
-    }, tour && /* @__PURE__ */ React4.createElement("li", null, /* @__PURE__ */ React4.createElement(TourLink, null)), links.map((link, i) => /* @__PURE__ */ React4.createElement("li", {
+    }, tour && /* @__PURE__ */ React3.createElement("li", null, /* @__PURE__ */ React3.createElement(TourLink, null)), links.map((link, i) => /* @__PURE__ */ React3.createElement("li", {
       key: i
-    }, /* @__PURE__ */ React4.createElement(Link, {
+    }, /* @__PURE__ */ React3.createElement(Link, {
       href: link
-    }))));
+    })))));
   })());
 }
 function TourLink() {
-  return /* @__PURE__ */ React4.createElement(React4.Fragment, null, /* @__PURE__ */ React4.createElement(Link, {
+  return /* @__PURE__ */ React3.createElement(React3.Fragment, null, /* @__PURE__ */ React3.createElement(Link, {
     href: "/react-tour",
     noBreadcrumb: true
-  }), " or ", /* @__PURE__ */ React4.createElement(Link, {
+  }), " or ", /* @__PURE__ */ React3.createElement(Link, {
     href: "/vue-tour",
     noBreadcrumb: true
   }));
 }
 
 // src/components/Note.tsx
-import React5 from "react";
+import React4 from "react";
 function Warning({ children }) {
-  return /* @__PURE__ */ React5.createElement(Note, {
+  return /* @__PURE__ */ React4.createElement(NoteGeneric, {
     type: "warning"
   }, children);
 }
 function Construction({ children }) {
-  return /* @__PURE__ */ React5.createElement(Note, {
+  return /* @__PURE__ */ React4.createElement(NoteGeneric, {
     type: "construction"
   }, children);
 }
 function Danger({ children }) {
-  return /* @__PURE__ */ React5.createElement(Note, {
+  return /* @__PURE__ */ React4.createElement(NoteGeneric, {
     type: "danger"
   }, children);
 }
-function Note({
+function NoteWithoutIcon({ children }) {
+  return /* @__PURE__ */ React4.createElement(NoteGeneric, {
+    icon: null
+  }, children);
+}
+function NoteWithCustomIcon({ icon, children }) {
+  if (!icon)
+    throw new Error(`<NoteWithCustomIcon icon={/*...*/}> property 'icon' is \`${icon}\` which is forbidden`);
+  return /* @__PURE__ */ React4.createElement(NoteGeneric, {
+    icon
+  }, children);
+}
+function NoteGeneric({
   type,
   icon,
   children
 }) {
+  assert(icon === null || icon || type, { icon, type });
   let className = "custom-icon";
   if (type) {
     className = `${className} type-${type}`;
   }
-  if (!icon) {
+  if (!icon && type) {
     let classColor = "";
     if (type === "danger") {
       icon = ":no_entry:";
@@ -218,37 +229,37 @@ function Note({
       icon = ":construction:";
       classColor = "note-color-yellow";
     }
-    if (classColor) {
-      className = `${className} ${classColor}`;
-    }
+    assert(icon);
+    assert(classColor);
+    className = `${className} ${classColor}`;
   }
-  return /* @__PURE__ */ React5.createElement("blockquote", {
+  return /* @__PURE__ */ React4.createElement("blockquote", {
     className
-  }, /* @__PURE__ */ React5.createElement("div", {
+  }, /* @__PURE__ */ React4.createElement("div", {
     style: { marginBottom: 20 }
-  }), icon, " ", /* @__PURE__ */ React5.createElement("div", {
+  }), icon, " ", /* @__PURE__ */ React4.createElement("div", {
     className: "blockquote-content"
-  }, children), /* @__PURE__ */ React5.createElement("div", {
+  }, children), /* @__PURE__ */ React4.createElement("div", {
     style: { marginTop: 20 }
   }));
 }
 
 // src/components/ImportMeta.tsx
-import React6 from "react";
+import React5 from "react";
 function ImportMeta({ prop }) {
   assert(!prop.startsWith("import"));
   assert(!prop.startsWith("."));
   const text = "import.meta." + prop;
-  return /* @__PURE__ */ React6.createElement("code", null, text);
+  return /* @__PURE__ */ React5.createElement("code", null, text);
 }
 
 // src/components/HorizontalLine.tsx
-import React7 from "react";
+import React6 from "react";
 function HorizontalLine({ primary }) {
-  return /* @__PURE__ */ React7.createElement("div", {
+  return /* @__PURE__ */ React6.createElement("div", {
     className: "header-separator-line " + (primary ? "primary" : ""),
     style: { textAlign: "center" }
-  }, /* @__PURE__ */ React7.createElement("hr", {
+  }, /* @__PURE__ */ React6.createElement("hr", {
     style: {
       display: "inline-block",
       margin: 0,
@@ -261,7 +272,7 @@ function HorizontalLine({ primary }) {
 }
 
 // src/components/Sponsors.tsx
-import React8 from "react";
+import React7 from "react";
 
 // src/icons/heart.svg
 var heart_default = "/assets/heart-OINVKOXO.svg";
@@ -393,9 +404,9 @@ function Sponsors() {
   const { projectInfo } = pageContext.config;
   const sponsorsCompanies = sponsorsList.filter(isCompany);
   const sponsorsIndividuals = sponsorsList.filter(isIndividual);
-  return /* @__PURE__ */ React8.createElement("div", {
+  return /* @__PURE__ */ React7.createElement("div", {
     style: { textAlign: "center", marginTop: 19 }
-  }, /* @__PURE__ */ React8.createElement("a", {
+  }, /* @__PURE__ */ React7.createElement("a", {
     className: "button",
     href: "https://github.com/sponsors/brillout",
     style: {
@@ -405,19 +416,19 @@ function Sponsors() {
       padding: "5px 10px",
       marginBottom: 10
     }
-  }, /* @__PURE__ */ React8.createElement("img", {
+  }, /* @__PURE__ */ React7.createElement("img", {
     src: heart_default,
     height: 22
-  }), " ", /* @__PURE__ */ React8.createElement("span", {
+  }), " ", /* @__PURE__ */ React7.createElement("span", {
     style: { marginLeft: 7, fontSize: "1.07em" }
-  }, "Sponsor")), /* @__PURE__ */ React8.createElement("div", null), /* @__PURE__ */ React8.createElement("div", {
+  }, "Sponsor")), /* @__PURE__ */ React7.createElement("div", null), /* @__PURE__ */ React7.createElement("div", {
     style: { maxWidth: 400, display: "inline-block", marginTop: 12, marginBottom: 12 }
-  }, projectInfo.projectNameJsx || projectInfo.projectName, " is free and open source, made possible by wonderful sponsors."), /* @__PURE__ */ React8.createElement("div", {
+  }, projectInfo.projectNameJsx || projectInfo.projectName, " is free and open source, made possible by wonderful sponsors."), /* @__PURE__ */ React7.createElement("div", {
     style: { display: "flex", flexWrap: "wrap", justifyContent: "space-evenly", alignItems: "end" }
-  }, sponsorsCompanies.map((sponsor, i) => /* @__PURE__ */ React8.createElement(SponsorDiv, {
+  }, sponsorsCompanies.map((sponsor, i) => /* @__PURE__ */ React7.createElement(SponsorDiv, {
     sponsor,
     key: i
-  }))), /* @__PURE__ */ React8.createElement("div", {
+  }))), /* @__PURE__ */ React7.createElement("div", {
     style: {
       display: "flex",
       flexWrap: "wrap",
@@ -426,7 +437,7 @@ function Sponsors() {
       margin: "17px auto",
       maxWidth: 700
     }
-  }, sponsorsIndividuals.map((sponsor, i) => /* @__PURE__ */ React8.createElement(SponsorDiv, {
+  }, sponsorsIndividuals.map((sponsor, i) => /* @__PURE__ */ React7.createElement(SponsorDiv, {
     sponsor,
     key: i
   }))));
@@ -461,16 +472,16 @@ function SponsorDiv({ sponsor }) {
     imgAlt = sponsor.companyName;
     marginHeight = 20;
     marginWidth = 10;
-    label = /* @__PURE__ */ React8.createElement(Label, {
+    label = /* @__PURE__ */ React7.createElement(Label, {
       sponsor
     });
   }
-  return /* @__PURE__ */ React8.createElement("a", {
+  return /* @__PURE__ */ React7.createElement("a", {
     href: website,
     style: {
       margin: `${marginHeight}px ${marginWidth}px`
     }
-  }, label, /* @__PURE__ */ React8.createElement("div", {
+  }, label, /* @__PURE__ */ React7.createElement("div", {
     style: {
       backgroundColor,
       borderRadius: 7,
@@ -483,7 +494,7 @@ function SponsorDiv({ sponsor }) {
       flexDirection: "column",
       justifyContent: "center"
     }
-  }, /* @__PURE__ */ React8.createElement("img", {
+  }, /* @__PURE__ */ React7.createElement("img", {
     style: { width: `calc(100% - ${padding}px)`, height: height - padding, zIndex: 2, objectFit: "contain" },
     src: imgSrc,
     alt: imgAlt
@@ -494,7 +505,7 @@ function Label({ sponsor }) {
   const labelBg = getLabelBg(sponsor);
   const labelIcon = getLabelIcon(sponsor);
   const labelText = getLabelText(sponsor);
-  return /* @__PURE__ */ React8.createElement("div", {
+  return /* @__PURE__ */ React7.createElement("div", {
     style: {
       top: 0,
       display: "flex",
@@ -507,20 +518,20 @@ function Label({ sponsor }) {
 }
 function getLabelBg(sponsor) {
   const height = sponsor.plan === "platinum" ? 32 : 24;
-  return /* @__PURE__ */ React8.createElement("img", {
+  return /* @__PURE__ */ React7.createElement("img", {
     src: label_default,
     style: { height, position: "absolute", bottom: 0, zIndex: -1 }
   });
 }
 function getLabelText(sponsor) {
   if (sponsor.plan === "platinum") {
-    return /* @__PURE__ */ React8.createElement(React8.Fragment, null);
+    return /* @__PURE__ */ React7.createElement(React7.Fragment, null);
   }
   let letterSpacing = void 0;
   if (["bronze", "silver", "gold", "indie"].includes(sponsor.plan)) {
     letterSpacing = 1;
   }
-  return /* @__PURE__ */ React8.createElement(React8.Fragment, null, " ", /* @__PURE__ */ React8.createElement("span", {
+  return /* @__PURE__ */ React7.createElement(React7.Fragment, null, " ", /* @__PURE__ */ React7.createElement("span", {
     style: {
       zIndex: 1,
       fontSize: "0.82em",
@@ -535,12 +546,12 @@ function getLabelText(sponsor) {
 function getLabelIcon(sponsor) {
   let medalSrc;
   if (sponsor.plan === "platinum") {
-    return /* @__PURE__ */ React8.createElement(Emoji, {
+    return /* @__PURE__ */ React7.createElement(Emoji, {
       name: "trophy",
       style: { fontSize: "1.3em" }
     });
   } else if (sponsor.plan === "indie") {
-    return /* @__PURE__ */ React8.createElement(Emoji, {
+    return /* @__PURE__ */ React7.createElement(Emoji, {
       name: "ribbon",
       style: { fontSize: "0.9em" }
     });
@@ -553,7 +564,7 @@ function getLabelIcon(sponsor) {
   } else {
     assert(false);
   }
-  return /* @__PURE__ */ React8.createElement("img", {
+  return /* @__PURE__ */ React7.createElement("img", {
     src: medalSrc,
     style: { height: 15, zIndex: 1, marginRight: 5 }
   });
@@ -593,14 +604,14 @@ function isIndividual(sponsor) {
 }
 
 // src/components/CodeBlockTransformer.tsx
-import React9 from "react";
+import React8 from "react";
 function CodeBlockTransformer({ children, lineBreak }) {
   assert(
     lineBreak === "white-space" || lineBreak === "break-word",
     "`lineBreak` is currently the only use case for <CodeBlockTransformer>"
   );
   const className = `with-line-break_${lineBreak}`;
-  return /* @__PURE__ */ React9.createElement("div", {
+  return /* @__PURE__ */ React8.createElement("div", {
     className
   }, children);
 }
@@ -612,8 +623,9 @@ export {
   FeatureList,
   HorizontalLine,
   ImportMeta,
-  Info,
   Link,
+  NoteWithCustomIcon,
+  NoteWithoutIcon,
   P,
   ReadingRecommendation,
   RepoLink,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brillout/docpress",
-  "version": "0.5.1",
+  "version": "0.5.3",
   "scripts": {
     "// Check types while developing": "",
     "types": "tsc --noEmit --watch",