@t8/docsgen 0.1.32 → 0.1.34

package/dist/bin.js

@@ -446,8 +446,9 @@ function getSectionPostprocess(linkMap) {
   return (content) => {
     let s = content;
     s = s.replace(/<a href="([^"]+)">/g, (_, url) => {
-      if (url?.startsWith("#")) return `<a href="${linkMap[url] ?? url}">`;
-      return `<a href="${url}" target="_blank">`;
+      let nextURL = linkMap[url] ?? url;
+      let attrs = /^(https?:)?\/\//.test(nextURL) ? ' target="_blank"' : "";
+      return `<a href="${nextURL}"${attrs}>`;
     });
     return s;
   };
@@ -465,11 +466,11 @@ function postprocessBadges(content) {
   return document.body.innerHTML;
 }
 async function getParsedContent(ctx) {
-  let { singlePage } = ctx;
+  let { singlePage, linkMap } = ctx;
   let rawContent = await fetchText(getLocation(ctx, "README.md", ctx.source));
   let content = md.render(rawContent);
   let dom = new import_jsdom3.JSDOM(content);
-  let { nav, linkMap } = buildNav(ctx, dom);
+  let { nav, linkMap: navLinkMap } = buildNav(ctx, dom);
   let badges = [];
   let title = "";
   let description = [];
@@ -514,7 +515,10 @@ async function getParsedContent(ctx) {
     element = element.nextElementSibling;
   }
   if (section.length !== 0) sections.push(joinLines(section));
-  let postprocess = getSectionPostprocess(linkMap);
+  let postprocess = getSectionPostprocess({
+    ...navLinkMap,
+    ...linkMap
+  });
   return {
     badges: postprocessBadges(joinLines(badges)),
     title,

package/dist/css/base.css

@@ -32,7 +32,7 @@
   --content-padding-y: 1.75rem;
   --space-x: var(--content-padding-x);
   --block-margin-y: 1em;
-  --hr-border: 0.15rem solid var(--b1-medium);
+  --hr-border: .3rem solid var(--b1-light);
 
   font-size: 100%;
   font-family: sans-serif;

package/dist/css/section.css

@@ -117,7 +117,7 @@ main p.sep {
 main hr {
   background: none transparent;
   border: none;
-  border-top: 0.075em solid;
+  border-top: var(--hr-border);
   margin: var(--block-margin-y) 0;
 }
 main h1 {
@@ -139,7 +139,7 @@ main h1 + h2 {
   margin-top: 0.75rem;
 }
 main h2 {
-  border-bottom: .3rem solid var(--b1-light);
+  border-bottom: var(--hr-border);
   padding-bottom: 0.1em;
 }
 
@@ -150,7 +150,7 @@ main h2 {
   justify-content: space-between;
   gap: 1em;
   background: var(--b1-light);
-  border-top: var(--hr-border);
+  border-top: 0.15rem solid var(--b1-medium);
   padding: 0.6em 0.75em 0.75em;
   margin: 1.5em 0 0;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@t8/docsgen",
-  "version": "0.1.32",
+  "version": "0.1.34",
   "description": "",
   "main": "dist/bin.js",
   "bin": {

package/schema.json

@@ -1 +1 @@
-{"$ref":"#/definitions/Config","$schema":"http://json-schema.org/draft-07/schema#","definitions":{"Config":{"additionalProperties":false,"properties":{"$schema":{"type":"string"},"append":{"$ref":"#/definitions/ContentInjectionMap%3C(%22head%22%7C%22body%22%7C%22%3Ahas-code%22)%3E"},"backstory":{"description":"Backstory link URL to be added to the front page.","type":"string"},"baseColor":{"type":"string"},"cname":{"description":"Content of the './CNAME' file.","type":"string"},"contentDir":{"description":"Generated section content directory.","type":"string"},"description":{"type":"string"},"dir":{"type":"string"},"entries":{"items":{"$ref":"#/definitions/EntryConfig"},"type":"array"},"favicon":{"description":"Favicon URL.","type":"string"},"faviconType":{"type":"string"},"htmlTitle":{"type":"string"},"id":{"type":"string"},"jsorg":{"description":"As a boolean, it means whether to add the '<package_name>.js.org' domain to the './CNAME' file.\n\nAs a string, it sets the '<jsorg_value>.js.org' domain to the './CNAME' file.","type":["boolean","string"]},"mainBranch":{"type":"string"},"name":{"type":"string"},"nav":{"description":"URL of an HTML file inserted into the navigation bar.","type":"string"},"npm":{"type":"string"},"redirect":{"description":"Redirection URL.","type":"string"},"remove":{"description":"Whether to remove the GitHub Pages branch and quit.","type":"boolean"},"repo":{"type":"string"},"root":{"description":"Main page root path.","type":"string"},"scope":{"description":"Scope URL.","type":"string"},"singlePage":{"description":"Whether to show all sections on a single page.","type":"boolean"},"source":{"type":"string"},"targetBranch":{"description":"Target branch.","examples":["gh-pages"],"type":"string"},"targetId":{"type":"string"},"theme":{"type":"string"},"title":{"type":"string"},"version":{"type":"string"},"ymid":{"type":["number","string"]}},"type":"object"},"ContentInjectionMap<(\"head\"|\"body\"|\":has-code\")>":{"additionalProperties":false,"properties":{":has-code":{"anyOf":[{"type":"string"},{"additionalProperties":false,"properties":{"content":{"type":"string"},"pages":{"items":{"$ref":"#/definitions/Page"},"type":"array"}},"type":"object"},{"items":{"anyOf":[{"type":"string"},{"not":{}},{"additionalProperties":false,"properties":{"content":{"type":"string"},"pages":{"items":{"$ref":"#/definitions/Page"},"type":"array"}},"type":"object"}]},"type":"array"}]},"body":{"anyOf":[{"type":"string"},{"additionalProperties":false,"properties":{"content":{"type":"string"},"pages":{"items":{"$ref":"#/definitions/Page"},"type":"array"}},"type":"object"},{"items":{"anyOf":[{"type":"string"},{"not":{}},{"additionalProperties":false,"properties":{"content":{"type":"string"},"pages":{"items":{"$ref":"#/definitions/Page"},"type":"array"}},"type":"object"}]},"type":"array"}]},"head":{"anyOf":[{"type":"string"},{"additionalProperties":false,"properties":{"content":{"type":"string"},"pages":{"items":{"$ref":"#/definitions/Page"},"type":"array"}},"type":"object"},{"items":{"anyOf":[{"type":"string"},{"not":{}},{"additionalProperties":false,"properties":{"content":{"type":"string"},"pages":{"items":{"$ref":"#/definitions/Page"},"type":"array"}},"type":"object"}]},"type":"array"}]}},"type":"object"},"EntryConfig":{"additionalProperties":false,"properties":{"append":{"$ref":"#/definitions/ContentInjectionMap%3C(%22head%22%7C%22body%22%7C%22%3Ahas-code%22)%3E"},"backstory":{"description":"Backstory link URL to be added to the front page.","type":"string"},"baseColor":{"type":"string"},"cname":{"description":"Content of the './CNAME' file.","type":"string"},"contentDir":{"description":"Generated section content directory.","type":"string"},"description":{"type":"string"},"dir":{"type":"string"},"favicon":{"description":"Favicon URL.","type":"string"},"faviconType":{"type":"string"},"htmlTitle":{"type":"string"},"id":{"type":"string"},"jsorg":{"description":"As a boolean, it means whether to add the '<package_name>.js.org' domain to the './CNAME' file.\n\nAs a string, it sets the '<jsorg_value>.js.org' domain to the './CNAME' file.","type":["boolean","string"]},"mainBranch":{"type":"string"},"name":{"type":"string"},"nav":{"description":"URL of an HTML file inserted into the navigation bar.","type":"string"},"npm":{"type":"string"},"redirect":{"description":"Redirection URL.","type":"string"},"remove":{"description":"Whether to remove the GitHub Pages branch and quit.","type":"boolean"},"repo":{"type":"string"},"root":{"description":"Main page root path.","type":"string"},"scope":{"description":"Scope URL.","type":"string"},"singlePage":{"description":"Whether to show all sections on a single page.","type":"boolean"},"source":{"type":"string"},"targetBranch":{"description":"Target branch.","examples":["gh-pages"],"type":"string"},"theme":{"type":"string"},"title":{"type":"string"},"version":{"type":"string"},"ymid":{"type":["number","string"]}},"type":"object"},"Page":{"enum":["index","start","section","redirect"],"type":"string"}}}
+{"$ref":"#/definitions/Config","$schema":"http://json-schema.org/draft-07/schema#","definitions":{"Config":{"additionalProperties":false,"properties":{"$schema":{"type":"string"},"append":{"$ref":"#/definitions/ContentInjectionMap%3C(%22head%22%7C%22body%22%7C%22%3Ahas-code%22)%3E"},"backstory":{"description":"Backstory link URL to be added to the front page.","type":"string"},"baseColor":{"type":"string"},"cname":{"description":"Content of the './CNAME' file.","type":"string"},"contentDir":{"description":"Generated section content directory.","type":"string"},"description":{"type":"string"},"dir":{"type":"string"},"entries":{"items":{"$ref":"#/definitions/EntryConfig"},"type":"array"},"favicon":{"description":"Favicon URL.","type":"string"},"faviconType":{"type":"string"},"htmlTitle":{"type":"string"},"id":{"type":"string"},"jsorg":{"description":"As a boolean, it means whether to add the '<package_name>.js.org' domain to the './CNAME' file.\n\nAs a string, it sets the '<jsorg_value>.js.org' domain to the './CNAME' file.","type":["boolean","string"]},"linkMap":{"additionalProperties":{"anyOf":[{"type":"string"},{"not":{}}]},"description":"Link substitution map.","type":"object"},"mainBranch":{"type":"string"},"name":{"type":"string"},"nav":{"description":"URL of an HTML file inserted into the navigation bar.","type":"string"},"npm":{"type":"string"},"redirect":{"description":"Redirection URL.","type":"string"},"remove":{"description":"Whether to remove the GitHub Pages branch and quit.","type":"boolean"},"repo":{"type":"string"},"root":{"description":"Main page root path.","type":"string"},"scope":{"description":"Scope URL.","type":"string"},"singlePage":{"description":"Whether to show all sections on a single page.","type":"boolean"},"source":{"type":"string"},"targetBranch":{"description":"Target branch.","examples":["gh-pages"],"type":"string"},"targetId":{"type":"string"},"theme":{"type":"string"},"title":{"type":"string"},"version":{"type":"string"},"ymid":{"type":["number","string"]}},"type":"object"},"ContentInjectionMap<(\"head\"|\"body\"|\":has-code\")>":{"additionalProperties":false,"properties":{":has-code":{"anyOf":[{"type":"string"},{"additionalProperties":false,"properties":{"content":{"type":"string"},"pages":{"items":{"$ref":"#/definitions/Page"},"type":"array"}},"type":"object"},{"items":{"anyOf":[{"type":"string"},{"not":{}},{"additionalProperties":false,"properties":{"content":{"type":"string"},"pages":{"items":{"$ref":"#/definitions/Page"},"type":"array"}},"type":"object"}]},"type":"array"}]},"body":{"anyOf":[{"type":"string"},{"additionalProperties":false,"properties":{"content":{"type":"string"},"pages":{"items":{"$ref":"#/definitions/Page"},"type":"array"}},"type":"object"},{"items":{"anyOf":[{"type":"string"},{"not":{}},{"additionalProperties":false,"properties":{"content":{"type":"string"},"pages":{"items":{"$ref":"#/definitions/Page"},"type":"array"}},"type":"object"}]},"type":"array"}]},"head":{"anyOf":[{"type":"string"},{"additionalProperties":false,"properties":{"content":{"type":"string"},"pages":{"items":{"$ref":"#/definitions/Page"},"type":"array"}},"type":"object"},{"items":{"anyOf":[{"type":"string"},{"not":{}},{"additionalProperties":false,"properties":{"content":{"type":"string"},"pages":{"items":{"$ref":"#/definitions/Page"},"type":"array"}},"type":"object"}]},"type":"array"}]}},"type":"object"},"EntryConfig":{"additionalProperties":false,"properties":{"append":{"$ref":"#/definitions/ContentInjectionMap%3C(%22head%22%7C%22body%22%7C%22%3Ahas-code%22)%3E"},"backstory":{"description":"Backstory link URL to be added to the front page.","type":"string"},"baseColor":{"type":"string"},"cname":{"description":"Content of the './CNAME' file.","type":"string"},"contentDir":{"description":"Generated section content directory.","type":"string"},"description":{"type":"string"},"dir":{"type":"string"},"favicon":{"description":"Favicon URL.","type":"string"},"faviconType":{"type":"string"},"htmlTitle":{"type":"string"},"id":{"type":"string"},"jsorg":{"description":"As a boolean, it means whether to add the '<package_name>.js.org' domain to the './CNAME' file.\n\nAs a string, it sets the '<jsorg_value>.js.org' domain to the './CNAME' file.","type":["boolean","string"]},"linkMap":{"additionalProperties":{"anyOf":[{"type":"string"},{"not":{}}]},"description":"Link substitution map.","type":"object"},"mainBranch":{"type":"string"},"name":{"type":"string"},"nav":{"description":"URL of an HTML file inserted into the navigation bar.","type":"string"},"npm":{"type":"string"},"redirect":{"description":"Redirection URL.","type":"string"},"remove":{"description":"Whether to remove the GitHub Pages branch and quit.","type":"boolean"},"repo":{"type":"string"},"root":{"description":"Main page root path.","type":"string"},"scope":{"description":"Scope URL.","type":"string"},"singlePage":{"description":"Whether to show all sections on a single page.","type":"boolean"},"source":{"type":"string"},"targetBranch":{"description":"Target branch.","examples":["gh-pages"],"type":"string"},"theme":{"type":"string"},"title":{"type":"string"},"version":{"type":"string"},"ymid":{"type":["number","string"]}},"type":"object"},"Page":{"enum":["index","start","section","redirect"],"type":"string"}}}

package/src/bin/getParsedContent.ts

@@ -90,13 +90,15 @@ function getInstallationCode(element: Element) {
     .match(/(\S\s*)?(npm (i|install) .*)/)?.[2];
 }
 
-function getSectionPostprocess(linkMap: Record<string, string>) {
+function getSectionPostprocess(linkMap: Record<string, string | undefined>) {
   return (content: string) => {
     let s = content;
 
     s = s.replace(/<a href="([^"]+)">/g, (_, url) => {
-      if (url?.startsWith("#")) return `<a href="${linkMap[url] ?? url}">`;
-      return `<a href="${url}" target="_blank">`;
+      let nextURL = linkMap[url] ?? url;
+      let attrs = /^(https?:)?\/\//.test(nextURL) ? " target=\"_blank\"" : "";
+
+      return `<a href="${nextURL}"${attrs}>`;
     });
 
     return s;
@@ -122,12 +124,12 @@ function postprocessBadges(content: string) {
 }
 
 export async function getParsedContent(ctx: Context) {
-  let { singlePage } = ctx;
+  let { singlePage, linkMap } = ctx;
   let rawContent = await fetchText(getLocation(ctx, "README.md", ctx.source));
   let content = md.render(rawContent);
   let dom = new JSDOM(content);
 
-  let { nav, linkMap } = buildNav(ctx, dom);
+  let { nav, linkMap: navLinkMap } = buildNav(ctx, dom);
 
   let badges: string[] = [];
   let title = "";
@@ -185,7 +187,10 @@ export async function getParsedContent(ctx: Context) {
 
   if (section.length !== 0) sections.push(joinLines(section));
 
-  let postprocess = getSectionPostprocess(linkMap);
+  let postprocess = getSectionPostprocess({
+    ...navLinkMap,
+    ...linkMap,
+  });
 
   return {
     badges: postprocessBadges(joinLines(badges)),

package/src/css/base.css

@@ -32,7 +32,7 @@
   --content-padding-y: 1.75rem;
   --space-x: var(--content-padding-x);
   --block-margin-y: 1em;
-  --hr-border: 0.15rem solid var(--b1-medium);
+  --hr-border: .3rem solid var(--b1-light);
 
   font-size: 100%;
   font-family: sans-serif;

package/src/css/section.css

@@ -117,7 +117,7 @@ main p.sep {
 main hr {
   background: none transparent;
   border: none;
-  border-top: 0.075em solid;
+  border-top: var(--hr-border);
   margin: var(--block-margin-y) 0;
 }
 main h1 {
@@ -139,7 +139,7 @@ main h1 + h2 {
   margin-top: 0.75rem;
 }
 main h2 {
-  border-bottom: .3rem solid var(--b1-light);
+  border-bottom: var(--hr-border);
   padding-bottom: 0.1em;
 }
 
@@ -150,7 +150,7 @@ main h2 {
   justify-content: space-between;
   gap: 1em;
   background: var(--b1-light);
-  border-top: var(--hr-border);
+  border-top: 0.15rem solid var(--b1-medium);
   padding: 0.6em 0.75em 0.75em;
   margin: 1.5em 0 0;
 }

package/src/types/EntryConfig.ts

@@ -60,4 +60,6 @@ export type EntryConfig = {
   jsorg?: boolean | string;
   ymid?: number | string;
   append?: ContentInjectionMap<"head" | "body" | ":has-code">;
+  /** Link substitution map. */
+  linkMap?: Record<string, string | undefined>;
 };