docgen-tool 3.4.0 → 3.6.0

package/dist/include/require/styles/framework.css

@@ -1040,3 +1040,217 @@ button .icon svg,
 td.center {
   display: table-cell;
 }
+
+#dg-coverInfo {
+  margin-top: 100px;
+  margin-bottom: 50px;
+  width: 100%;
+}
+
+#dg-coverInfo {
+  border-collapse: separate; /*http://stackoverflow.com/questions/7625586/*/
+}
+
+#dg-coverInfo th {
+  background-color: rgb(46, 113, 225);
+  color: white;
+  font-size: 34px;
+  padding: 20px;
+  border: 1px solid rgb(46, 113, 225);
+  border-radius: 10px 10px 0 0;
+}
+
+#dg-coverInfo tr td {
+  border-top: 2px solid rgb(46, 113, 225);
+  border-left: 2px solid rgb(46, 113, 225);
+  border-bottom: none;
+  border-right: none;
+  padding-top: 20px;
+  padding-bottom: 20px;
+}
+
+#dg-coverInfo td:last-child {
+  border-right: 2px solid rgb(46, 113, 225);
+}
+
+#dg-coverInfo .dg-finalRow td {
+  border-bottom: 2px solid rgb(46, 113, 225);
+}
+
+#dg-summary {
+  margin-bottom: 100px;
+}
+
+/*
+  PDF header
+*/
+#dg-pdf-header {
+  text-align: right;
+}
+
+/*
+  PDF cover
+*/
+#dg-pdfLogo {
+  display: inline-block;
+  float: right;
+}
+
+#dg-pdf-cover-footer {
+  width: 100%;
+  text-align: center;
+}
+
+/*
+  PDF footer
+*/
+#dg-pdf-footer {
+  border-top: 1px solid #385691;
+  padding-top: 10px;
+}
+
+#dg-pdf-footer table {
+  width: 100%;
+  text-align: center;
+  table-layout: fixed;
+  word-wrap: break-word;
+}
+
+#dg-pdf-footer a {
+  text-decoration: none;
+  color: #444;
+}
+
+pre {
+  font-size: 12px; /*todo - move to base styles*/
+}
+
+section blockquote p,
+section li p {
+  margin: 0;
+}
+
+.w-table {
+  width: 100%;
+}
+
+/******************************** TABLE OF CONTENTS ****************************/
+/*Table of contents button to initiate show/hide*/
+#dg-navigator {
+  float: right;
+  background-color: rgb(26, 34, 49);
+  color: white;
+  text-align: right;
+  padding: 10px 20px 10px 20px;
+  margin-right: 200px;
+  border-radius: 0 0 10px 10px;
+  cursor: pointer;
+  font-weight: bold;
+}
+
+/*Table of contents container*/
+#dg-toc {
+  color: white;
+  background-color: rgb(26, 34, 49);
+}
+
+#dg-toc table {
+  table-layout: auto;
+  width: 100%;
+}
+
+#dg-toc div {
+  padding: 15px 0 15px 0;
+}
+
+/*Columns in table of contents*/
+#dg-toc td {
+  border-right: 1px solid #666;
+  vertical-align: top;
+  text-align: left;
+  padding: 0 20px 0 20px;
+}
+
+#dg-toc ul {
+  padding: 0;
+  list-style-type: none;
+}
+
+#dg-toc li {
+  font-weight: bold;
+}
+
+#dg-toc table td a {
+  color: white;
+  font-weight: normal;
+  text-decoration: none;
+  margin-left: 10px;
+}
+
+#dg-toc table td a:hover {
+  text-decoration: underline;
+}
+
+#dg-tocFixedColumn {
+  border-right: none;
+}
+
+#dg-toc table #dg-tocFixedColumn a {
+  vertical-align: middle;
+  margin-left: 4px;
+}
+
+.dg-tocGroup {
+  width: 22%;
+}
+
+.dg-tocHeading {
+  font-size: 16px;
+}
+
+.dg-tocIcon {
+  width: 18px;
+  height: 18px;
+  float: left;
+}
+
+.dg-tocIcon svg {
+  fill: white;
+}
+
+/*
+	Page table of contents
+*/
+.dg-pageToc {
+  list-style: none;
+  padding: 10px;
+  border: 1px solid #999;
+  background-color: #eee;
+}
+
+/*
+	Class to make a heading look invisible in web page, but still appear in the PDF table of contents
+		- display:none, visibily: hidden, zero dimensions, and offscreen positioning don't work
+		- so instead take it out of the flow and make it small and translucent
+*/
+.dg-hiddenTitle {
+  display: block;
+  border: none;
+  margin: 0;
+  padding: 0;
+  width: 1px;
+  height: 1px;
+  overflow: hidden;
+  position: absolute;
+  background-color: transparent;
+}
+
+.dg-fakeHeading {
+  text-decoration: none;
+  font-weight: bold;
+  color: #385691;
+  border-bottom: 1px solid #999;
+  margin: 20px 0 20px 0;
+  font-size: 16px;
+  padding-bottom: 4px;
+}

package/dist/include/require/styles/framework.js

@@ -5418,3 +5418,22 @@ function svgInject() {
     });
   };
 }
+
+$(document).ready(() => {
+  $('#dg-toc').hide(); //hide the table of contents
+
+  //instantiate svg injector to show SVG icons
+  const injector = new svgInject();
+  injector.inject();
+
+  //code syntax highlighting
+  $('pre code, .w-inline-code').each((i, block) => {
+    hljs.highlightBlock(block);
+  });
+
+  //toggle visibility of table of contents
+  $('#dg-navigator').click(() => {
+    $('#dg-toc').slideToggle('fast');
+    $(this).toggleClass('active');
+  });
+});

package/dist/include/templates/main.html

@@ -1,49 +1,17 @@
 <!doctype html>
 <html>
  <head>
-  <meta http-equiv="X-UA-Compatible" content="IE=edge" ><!--Prevent IE using compatibility mode on local or intranet pages. Do not put scripts before this line.-->
-  <meta name="viewport" content="width=device-width, user-scalable=yes"><!--Mobile device scaling-->
   <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, user-scalable=yes">
   <title></title>
 
-  <!--load stylesheets first (rationale: https://developers.google.com/speed/docs/best-practices/rtt#PutStylesBeforeScripts)-->
   <link rel="stylesheet" href="require/styles/framework.css" type="text/css" />
   <link rel="stylesheet" href="require/styles/highlight.min.css" type="text/css" />
-  <link rel="stylesheet" href="require/docgen.css" type="text/css" />
   <link rel="stylesheet" href="require/print.css" media="print" />
-
-  <!--load scripts second-->
-
   <script src="require/styles/framework.js"></script>
   <script src="require/styles/framework.icons.js"></script>
   <script src="require/styles/highlight.min.js"></script>
 
-  <!--inline scripts last-->
-
-<script type="text/javascript">
-
-$(document).ready( function () {
-  $("#dg-toc").hide(); //hide the table of contents
-
-  //instantiate an svg injector to show SVG icons
-  var injector = new svgInject();
-  injector.inject();
-
-  //code syntax highlighting
-  $('pre code, .w-inline-code').each(function(i, block) {
-    hljs.highlightBlock(block);
-  });
-
-  //toggle visibility of table of contents
-  $("#dg-navigator").click(function()
-  {
-    $("#dg-toc").slideToggle("fast");
-    $(this).toggleClass("active");
-  });
-
-});
-</script>
-
 <script type="text/x-mathjax-config">
 //MathJax configuration is the same as used by math.stackexchange.com
 MathJax.Hub.Config({"HTML-CSS": { preferredFont: "TeX", availableFonts: ["STIX","TeX"], linebreaks: { automatic:true }, EqnChunk: (MathJax.Hub.Browser.isMobile ? 10 : 50) },
@@ -54,47 +22,5 @@ MathJax.Hub.Config({"HTML-CSS": { preferredFont: "TeX", availableFonts: ["STIX",
 </script>
 
 </head>
-
-<body>
-
-<div id="dg-toc"></div>
-<div id="dg-navigator">Table of contents</div>
-
-<header>
-  <div class="w-fixed-width header-container">
-    <div class="header">
-      <div class="headerLeftBlock">
-        <a class="dg-homelink" href="#">
-          <div id="dg-logo"></div>
-        </a>
-        <div id="headerLeftText">
-          <a class="dg-homelink" href="#">
-            <span id="dg-title"></span> <span id="dg-web-title-version" style="font-weight:normal;"></span>
-          </a>
-        </div>
-      </div>
-      <div id="headerRightBlock">
-        <span id="dg-backlink"></span>
-      </div>
-    </div>
-  </div>
-</header>
-
-<section id="dg-content">
-
-</section>
-
- <footer>
-  <div><p class="w-fixed-width"><span id="dg-web-footer">.</p></div>
-  <div class="w-fixed-width">
-    <p><span id="dg-copyright"></span></p>
-    <p>
-      <span id="dg-marking"></span>
-      <span id="dg-legalese"></span>
-      <span id="dg-attribution"></span>
-    </p>
-  </div>
- </footer>
-
- </body>
+<body></body>
 </html>

package/dist/include/templates/pdfCover.html

@@ -1,128 +1,13 @@
 <!doctype html>
 <html>
  <head>
-  <meta http-equiv="X-UA-Compatible" content="IE=edge" ><!--Prevent IE using compatibility mode on local or intranet pages. Do not put scripts before this line.-->
-  <meta name="viewport" content="width=device-width, user-scalable=yes"><!--Mobile device scaling-->
   <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, user-scalable=yes">
   <title>DocGen</title>
 
-  <!--load stylesheets first (rationale: https://developers.google.com/speed/docs/best-practices/rtt#PutStylesBeforeScripts)-->
   <link rel="stylesheet" href="../require/styles/framework.css" type="text/css" />
-  <link rel="stylesheet" href="../require/docgen.css" type="text/css" />
   <link rel="stylesheet" href="../require/print.css" media="print" />
 
-<style>
-
-html {
-  background: none;
-  min-height: 100%;
-}
-
-#dg-pdfLogo {
-  display: inline-block;
-  float: right;
-
-}
-
-#dg-coverInfo {
-  margin-top: 100px;
-  margin-bottom: 50px;
-  width: 100%;
-}
-
-#dg-coverInfo {
-  border-collapse: separate; /*http://stackoverflow.com/questions/7625586/*/
-}
-
-#dg-coverInfo th {
-  background-color: rgb(46, 113, 225);
-  color: white;
-  font-size: 34px;
-  padding: 20px;
-  border: 1px solid rgb(46, 113, 225);
-  border-radius: 10px 10px 0 0;
-}
-
-#dg-coverInfo tr td {
-  border-top: 2px solid rgb(46, 113, 225);
-  border-left: 2px solid rgb(46, 113, 225);
-  border-bottom: none;
-  border-right: none;
-  padding-top: 20px;
-  padding-bottom: 20px;
-}
-
-#dg-coverInfo td:last-child {
-  border-right: 2px solid rgb(46, 113, 225);
-}
-
-#dg-coverInfo .dg-finalRow td {
-  border-bottom: 2px solid rgb(46, 113, 225);
-}
-
-#dg-summary {
-  margin-bottom: 100px;
-}
-
-#dg-footer {
-   /*position: fixed;*/
-   /*bottom: 0px;*/
-   width: 100%;
-   text-align: center;
-}
-
-#footnote {
-  font-size: 9px;
-}
-
-
-</style>
-
-<script src="../require/styles/framework.js"></script>
-
-</head>
-<body>
-
-<div class="w-clear-after"><div id="dg-pdfLogo"><img src="../files/images/logo.svg" /></div></div>
-
-<table class="w-table w-fixed" id="dg-coverInfo">
-<thead>
- <tr>
-  <th colspan="3" id="dg-title"></th>
- </tr>
- </thead>
- <tfoot>
- </tfoot>
- <tbody>
- <tr>
-  <td><strong>Owner: </strong> <span id="dg-owner"></span></td>
-  <td><strong>Version: </strong> <span id="dg-version"></span></td>
-  <td><strong>Released: </strong> <span id="dg-release-date"></span></td>
- </tr>
- <tr>
-  <td><strong>Author: </strong> <span id="dg-author"></span></td>
-  <td colspan="2"><strong>Contributors: </strong> <span id="dg-contributors"></span></td>
- </tr>
- <tr class="dg-finalRow">
-  <td><strong>Module: </strong> <span id="dg-module"></span></td>
-  <td><strong>ID: </strong> <span id="dg-id"></span></td>
-  <td><strong>Link: </strong> <span id="dg-website"></span></td>
- </tr>
- <tr>
-</tbody>
-</table>
-
-<h1>Summary</h1>
-<p id="dg-summary"></p>
-
-<div id="dg-footer">
-  <p><span id="dg-copyright"></span></p>
-  <p id="footnote">
-    <span id="dg-marking"></span>
-    <span id="dg-legalese"></span>
-    <span id="dg-attribution"></span>
-  </p>
-</div>
-
-</body>
+  <script src="../require/styles/framework.js"></script>
+ </head>
 </html>

package/dist/include/templates/pdfFooter.html

@@ -3,31 +3,9 @@
 <head>
   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   <link rel="stylesheet" href="../require/styles/framework.css" type="text/css" />
-  <link rel="stylesheet" href="../require/docgen.css" type="text/css" />
   <link rel="stylesheet" href="../require/print.css" media="print" />
 
-<style>
-
-#dg-footer {
-  border-top: 1px solid #385691;
-  padding-top: 10px;
-}
-
-#dg-footer table {
-  width: 100%;
-  text-align: center;
-  table-layout: fixed;
-  word-wrap: break-word;
-}
-
-a {
-  text-decoration: none;
-  color: #444;
-}
-
-</style>
-
-<script> /*from wkhtmltopdf documenation - substitutes in parameters like page numbers at runtime*/
+<script> /*from wkhtmltopdf documentation - substitutes in parameters like page numbers at runtime*/
 function subst() {
   var vars={};
   var x=document.location.search.substring(1).split('&');
@@ -42,18 +20,5 @@ function subst() {
 
 </head>
 <body onload="subst()">
-
-<div id="dg-footer">
- <table><thead></thead><tfoot></tfoot><tbody>
-  <tr>
-   <td><span id="dg-title"></span> <span id="dg-web-title-version"></span></td>
-   <td><span id="dg-copyright"></span></td>
-   <td>Page <span class="page"></span> of <span class="topage"></span></td>
-  </tr>
- </tbody></table>
-</div>
-
 </body>
 </html>
-
-

package/dist/include/templates/pdfHeader.html

@@ -1,21 +1,8 @@
 <!doctype html>
 <html>
 <head>
-
   <link rel="stylesheet" href="../require/styles/framework.css" type="text/css" />
-  <link rel="stylesheet" href="../require/docgen.css" type="text/css" />
   <link rel="stylesheet" href="../require/print.css" media="print" />
-
-<style>
-#dg-header {
- text-align:right;
-}
-
-</style>
 </head>
-<body>
-<div id="dg-header">
- <img src="../files/images/logo.svg" />
-</div>
-</body>
+<body />
 </html>

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "docgen-tool",
-    "version": "3.4.0",
+    "version": "3.6.0",
     "description": "A tool for creating HTML and PDF documentation",
     "main": "dist/docgen.ts",
     "bin": {
@@ -34,21 +34,23 @@
         "docgen": "prettier --write"
     },
     "dependencies": {
-        "chalk": "^4.1.0",
         "cheerio": "^1.0.0-rc.12",
         "cli-spinner": "^0.2.10",
         "commander": "^11.0.0",
         "fs-extra": "^11.1.1",
         "husky": "^4.3.0",
-        "image-size": "^1.0.2",
         "lint-staged": "^10.5.1",
+        "lodash": "^4.17.21",
         "markdown-it": "^13.0.1",
-        "moment": "^2.29.4",
+        "picocolors": "^1.0.0",
+        "react": "^18.2.0",
+        "react-dom": "^18.2.0",
         "spawn-args": "^0.2.0",
         "z-schema": "^6.0.1"
     },
     "devDependencies": {
         "@types/node": "^20.3.1",
+        "@types/react": "^18.2.37",
         "eslint": "^8.43.0",
         "eslint-config-prettier": "^8.8.0",
         "ncp": "^2.0.0",