npm - docgen-tool - Versions diffs - 3.2.2 → 3.2.3 - Mend

docgen-tool 3.2.2 → 3.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (42) hide show

package/dist/source/templates/main.html ADDED Viewed

@@ -0,0 +1,95 @@
+<!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">
+  <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) },
+  tex2jax: { inlineMath: [ ["$", "$"], ["\\\\(","\\\\)"] ], displayMath: [ ["$$","$$"], ["\\[", "\\]"] ], processEscapes: true, ignoreClass: "tex2jax_ignore|dno" },
+  TeX: {  noUndefined: { attributes: { mathcolor: "red", mathbackground: "#FFEEEE", mathsize: "90%" } }, Macros: { href: "{}" } },
+  messageStyle: "none"
+});
+</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-title">
+      <a id="dg-homelink" href="#">
+        <div id="dg-logo" style="background-image:url('docs/images/logo.svg');">
+          <span id="dg-title"></span> <span id="dg-web-title-version" style="font-weight:normal;"></span>
+        </div>
+      </a>
+    </div>
+    <div class="header-extra">
+      <span id="dg-backlink"></span>
+    </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>
+</html>

package/dist/source/templates/pdfCover.html ADDED Viewed

@@ -0,0 +1,128 @@
+<!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">
+  <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>
+</html>

package/dist/source/templates/pdfFooter.html ADDED Viewed

@@ -0,0 +1,59 @@
+<!doctype html>
+<html>
+<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*/
+function subst() {
+  var vars={};
+  var x=document.location.search.substring(1).split('&');
+  for(var i in x) {var z=x[i].split('=',2);vars[z[0]] = unescape(z[1]);}
+  var x=['frompage','topage','page','webpage','section','subsection','subsubsection'];
+  for(var i in x) {
+    var y = document.getElementsByClassName(x[i]);
+    for(var j=0; j<y.length; ++j) y[j].textContent = vars[x[i]];
+  }
+}
+</script>
+</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/source/templates/pdfHeader.html ADDED Viewed

@@ -0,0 +1,21 @@
+<!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>
+</html>

package/dist/source/templates/redirect.html ADDED Viewed

@@ -0,0 +1,10 @@
+<!doctype html>
+<html>
+<head>
+ <title></title>
+ <meta http-equiv="REFRESH" content="0;url=docs/index.html">
+</head>
+<body>
+ <a href="docs/index.html" style="color:#ccc;font-size:12px">Redirect to homepage</a>
+</body>
+</html>

package/dist/source/templates/webCover.html ADDED Viewed

@@ -0,0 +1,73 @@
+<style>
+#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;
+}
+</style>
+<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>

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "docgen-tool",
-  "version": "3.2.2",
+  "version": "3.2.3",
   "description": "A tool for creating HTML and PDF documentation",
   "main": "dist/docgen.js",
   "bin": {