@t8/docsgen 0.4.1 → 0.4.3

package/dist/bin.js

@@ -39,6 +39,9 @@ var require_dist = __commonJS({
         if (x.startsWith("-") && x.length === 2) return toCamelCase(x.slice(1));
       }
     }
+    function isKey(x) {
+      return Boolean(toKey(x));
+    }
     function split(x) {
       let words = [], word = "";
       let hasOpenSingleQuote = false;
@@ -74,7 +77,10 @@ var require_dist = __commonJS({
         let normalizedItem = item.trim();
         let k = normalizedItem.indexOf("=");
         if (k === -1) return normalizedItem;
-        return [normalizedItem.slice(0, k), normalizedItem.slice(k + 1)];
+        let key2 = normalizedItem.slice(0, k);
+        let value = normalizedItem.slice(k + 1);
+        if (!isKey(key2)) return normalizedItem;
+        return [key2, value];
       });
       if (map) normalizedMap = map;
       let key = "";
@@ -99,7 +105,7 @@ var require_dist = __commonJS({
         else parsedValue = true;
         let prevValue = parsedArgs[key];
         let value;
-        if (prevValue === void 0) value = parsedValue;
+        if (prevValue === void 0) value = key === "" ? [parsedValue] : parsedValue;
         else if (Array.isArray(prevValue)) value = [...prevValue, parsedValue];
         else value = [prevValue, parsedValue];
         parsedArgs[key] = value;
@@ -425,6 +431,22 @@ function getRepoLink({ repo }, className) {
   return `<a href="${repo}"${className ? ` class="${className}"` : ""} target="_blank">${caption}</a>`;
 }
 
+// src/bin/getRepoMetadata.ts
+async function getRepoMetadata({
+  repo
+}) {
+  if (repo?.startsWith("https://github.com/")) {
+    try {
+      let repoMetadata = await fetchContent(
+        repo.replace("https://github.com/", "https://api.github.com/repos/")
+      );
+      return JSON.parse(repoMetadata);
+    } catch {
+    }
+  }
+  return {};
+}
+
 // src/bin/parsing/getParsedContent.ts
 import { JSDOM as JSDOM2 } from "jsdom";
 import Markdown from "markdown-it";
@@ -810,10 +832,18 @@ ${navContent}
 </nav>`;
 }
 
+// src/bin/content/tweakTypography.ts
+function tweakTypography(s = "") {
+  return s.replace(/\b(for|in|on|at|to|with|a|an|the|its)\s+/gi, "$1\xA0").replace(/\b(React)\s+(apps?)\b/gi, "$1\xA0$2");
+}
+
 // src/bin/content/getSectionContent.ts
 async function getSectionContent(ctx, index) {
   let { root, contentDir = "" } = ctx;
-  let escapedPackageDescription = escapeHTML(ctx.description);
+  let repoDescription = index === 0 ? (await getRepoMetadata(ctx)).description : "";
+  let descriptionContent = escapeHTML(
+    tweakTypography(repoDescription || ctx.description)
+  );
   let cssRoot = await getCSSRoot(ctx, "content");
   let { sections, nav } = await getParsedContent(ctx);
   let content = sections[index];
@@ -842,7 +872,7 @@ ${getInjectedContent(ctx, "section", "body", "prepend")}
 <header class="aux">
   <h1>${mainTitle}</h1>
   <div class="description">
-    <p>${escapedPackageDescription}</p>
+    <p>${descriptionContent}</p>
   </div>
 </header>
 <div class="${navContent ? "" : "no-nav "}body">
@@ -863,7 +893,7 @@ ${content}
   <div class="header" hidden>
     <h1>${mainTitle}</h1>
     <div class="description">
-      <p>${escapedPackageDescription}</p>
+      <p>${descriptionContent}</p>
       <p class="installation">${await getInstallationContent(ctx)}</p>
     </div>
   </div>

package/dist/css/section.css

@@ -11,17 +11,32 @@ footer {
 header {
   display: none;
   text-align: center;
-  padding-top: 0.5em;
-  padding-bottom: 0.5em;
+  padding-top: 0.7em;
+  padding-bottom: 0.75em;
 }
 header h1 {
-  font-size: 1.25em;
+  font-size: 1.3rem;
   font-weight: 900;
+  color: var(--aux-emphatic-color);
   margin: 0;
 }
+header h1 > a,
+header h1 > a:link,
+header h1 > a:hover,
+header h1 > a:visited,
+header h1 > a:active {
+  --color: var(--aux-emphatic-color);
+  text-decoration: underline;
+  border-bottom: none;
+}
+header h1 sup {
+  font-size: 0.5em;
+}
 header .description {
+  max-width: 36em;
   font-size: 0.8em;
-  margin-top: 0.15em;
+  line-height: 1.2;
+  margin: 0.35em auto 0;
 }
 header .description p {
   margin: 0;
@@ -87,8 +102,9 @@ aside > .header .installation code {
   margin: 0;
 }
 aside h1 {
-  font-size: 1.35em;
+  font-size: 1.3rem;
   font-weight: 900;
+  color: var(--aux-emphatic-color);
   margin: 0;
 }
 aside h1 > a,
@@ -96,7 +112,7 @@ aside h1 > a:link,
 aside h1 > a:hover,
 aside h1 > a:visited,
 aside h1 > a:active {
-  --color: var(--aux-color);
+  --color: var(--aux-emphatic-color);
   text-decoration: underline;
   border-bottom: none;
 }
@@ -251,6 +267,7 @@ main h1 + h2 {
   margin-top: 0.5rem;
 }
 main h2 {
+  font-weight: 900;
   border-bottom: var(--sep-line);
   padding-bottom: 0.1em;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@t8/docsgen",
-  "version": "0.4.1",
+  "version": "0.4.3",
   "description": "",
   "main": "dist/bin.js",
   "type": "module",
@@ -26,11 +26,11 @@
   "devDependencies": {
     "@types/jsdom": "^27.0.0",
     "@types/markdown-it": "^14.1.2",
-    "@types/node": "^25.0.2"
+    "@types/node": "^25.2.1"
   },
   "dependencies": {
-    "args-json": "^1.2.9",
-    "jsdom": "^27.3.0",
+    "args-json": "^1.2.12",
+    "jsdom": "^28.0.0",
     "markdown-it": "^14.1.0"
   }
 }

package/src/bin/content/getSectionContent.ts

@@ -2,6 +2,7 @@ import type { Context } from "../../types/Context.ts";
 import { escapeHTML } from "../../utils/escapeHTML.ts";
 import { escapeRegExp } from "../../utils/escapeRegExp.ts";
 import { getRepoLink } from "../getRepoLink.ts";
+import { getRepoMetadata } from "../getRepoMetadata.ts";
 import { getParsedContent } from "../parsing/getParsedContent.ts";
 import { stripHTML } from "../stripHTML.ts";
 import { getCounterContent } from "./getCounterContent.ts";
@@ -14,10 +15,15 @@ import { getMainTitle } from "./getMainTitle.ts";
 import { getNav } from "./getNav.ts";
 import { getPlainTitle } from "./getPlainTitle.ts";
 import { toFileContent } from "./toFileContent.ts";
+import { tweakTypography } from "./tweakTypography.ts";
 
 export async function getSectionContent(ctx: Context, index: number) {
   let { root, contentDir = "" } = ctx;
-  let escapedPackageDescription = escapeHTML(ctx.description);
+  let repoDescription =
+    index === 0 ? (await getRepoMetadata(ctx)).description : "";
+  let descriptionContent = escapeHTML(
+    tweakTypography(repoDescription || ctx.description),
+  );
 
   let cssRoot = await getCSSRoot(ctx, "content");
   let { sections, nav } = await getParsedContent(ctx);
@@ -50,7 +56,7 @@ ${getInjectedContent(ctx, "section", "body", "prepend")}
 <header class="aux">
   <h1>${mainTitle}</h1>
   <div class="description">
-    <p>${escapedPackageDescription}</p>
+    <p>${descriptionContent}</p>
   </div>
 </header>
 <div class="${navContent ? "" : "no-nav "}body">
@@ -71,7 +77,7 @@ ${content}
   <div class="header" hidden>
     <h1>${mainTitle}</h1>
     <div class="description">
-      <p>${escapedPackageDescription}</p>
+      <p>${descriptionContent}</p>
       <p class="installation">${await getInstallationContent(ctx)}</p>
     </div>
   </div>

package/src/bin/getRepoMetadata.ts

@@ -0,0 +1,19 @@
+import type { Context } from "../types/Context.ts";
+import type { RepoMetadata } from "../types/RepoMetadata.ts";
+import { fetchContent } from "./fetchContent.ts";
+
+export async function getRepoMetadata({
+  repo,
+}: Context): Promise<RepoMetadata> {
+  if (repo?.startsWith("https://github.com/")) {
+    try {
+      let repoMetadata = await fetchContent(
+        repo.replace("https://github.com/", "https://api.github.com/repos/"),
+      );
+
+      return JSON.parse(repoMetadata) as RepoMetadata;
+    } catch {}
+  }
+
+  return {};
+}

package/src/css/section.css

@@ -11,17 +11,32 @@ footer {
 header {
   display: none;
   text-align: center;
-  padding-top: 0.5em;
-  padding-bottom: 0.5em;
+  padding-top: 0.7em;
+  padding-bottom: 0.75em;
 }
 header h1 {
-  font-size: 1.25em;
+  font-size: 1.3rem;
   font-weight: 900;
+  color: var(--aux-emphatic-color);
   margin: 0;
 }
+header h1 > a,
+header h1 > a:link,
+header h1 > a:hover,
+header h1 > a:visited,
+header h1 > a:active {
+  --color: var(--aux-emphatic-color);
+  text-decoration: underline;
+  border-bottom: none;
+}
+header h1 sup {
+  font-size: 0.5em;
+}
 header .description {
+  max-width: 36em;
   font-size: 0.8em;
-  margin-top: 0.15em;
+  line-height: 1.2;
+  margin: 0.35em auto 0;
 }
 header .description p {
   margin: 0;
@@ -87,8 +102,9 @@ aside > .header .installation code {
   margin: 0;
 }
 aside h1 {
-  font-size: 1.35em;
+  font-size: 1.3rem;
   font-weight: 900;
+  color: var(--aux-emphatic-color);
   margin: 0;
 }
 aside h1 > a,
@@ -96,7 +112,7 @@ aside h1 > a:link,
 aside h1 > a:hover,
 aside h1 > a:visited,
 aside h1 > a:active {
-  --color: var(--aux-color);
+  --color: var(--aux-emphatic-color);
   text-decoration: underline;
   border-bottom: none;
 }
@@ -251,6 +267,7 @@ main h1 + h2 {
   margin-top: 0.5rem;
 }
 main h2 {
+  font-weight: 900;
   border-bottom: var(--sep-line);
   padding-bottom: 0.1em;
 }

package/src/types/RepoMetadata.ts

@@ -0,0 +1,3 @@
+export type RepoMetadata = {
+  description?: string | undefined;
+};