npm - docgen-tool - Versions diffs - 2.1.3 → 3.0.1 - Mend

docgen-tool 2.1.3 → 3.0.1

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 (113) hide show

package/docs/advanced-content.html DELETED Viewed

@@ -1,239 +0,0 @@
-<!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 - a documentation tool</title>
-  <!--load stylesheets first (rationale: https://developers.google.com/speed/docs/best-practices/rtt#PutStylesBeforeScripts)-->
-  <link rel="stylesheet" href="require/webknife/framework.min.css" type="text/css">
-  <link rel="stylesheet" href="require/webknife/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/webknife/framework.min.js"></script>
-  <script src="require/webknife/framework.icons.js"></script>
-  <script src="require/webknife/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>
-<link rel="stylesheet" href="require/katex/katex.min.css" type="text/css"><script type="text/javascript" src="require/katex/katex.min.js"></script><script type="text/javascript" src="require/katexInjector.js"></script><script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML-full"></script></head>
-<body>
-<div id="dg-toc"><div><table class="unstyled"><tr><td class="dg-tocGroup"><ul><li class="dg-tocHeading">Quick Start</li><li><a href="index.html">Overview</a></li><li><a href="installation.html">Installation</a></li><li><a href="upgrading.html">Upgrading</a></li></ul></td><td class="dg-tocGroup"><ul><li class="dg-tocHeading">User Guide</li><li><a href="running.html">Running DocGen</a></li><li><a href="writing-content.html">Writing content</a></li><li><a href="commonmark.html">CommonMark reference</a></li><li><a href="advanced-content.html">Advanced content</a></li></ul></td><td class="dg-tocGroup"><ul><li class="dg-tocHeading">Help</li><li><a href="troubleshooting.html">Troubleshooting</a></li><li><a href="version-control.html">Using with version control</a></li></ul></td><td class="dg-tocGroup"></td><td class="dg-tocGroup" id="dg-tocFixedColumn"><ul><li><span class="w-icon dg-tocIcon" data-name="person_group" title="archive"></span><a href="ownership.html">Ownership</a></li><li><span class="w-icon dg-tocIcon" data-name="refresh" title="archive"></span><a href="release-notes.html">Release Notes</a></li></ul><div><button class="w-icon-button" onclick="window.location=&apos;docgen.pdf&apos;;"><span class="w-icon" data-name="document"></span><span>PDF copy</span></button></div></td></tr></table></div></div>
-<div id="dg-navigator">Table of contents</div>
-<header>
- <div class="w-fixed-width">
-  <a id="dg-homelink" href="index.html">
-    <div id="dg-logo" style="background-image: url(files/images/logo.png); height: 42px; line-height: 42px; padding-left: 85px;">
-      <span id="dg-title">DocGen - a documentation tool</span> <span id="dg-web-title-version" style="font-weight:normal;">(2.1.3)</span>
-    </div>
-  </a>
-  <div>
-    <span id="dg-backlink"></span>
-  </div>
- </div>
-</header>
-<section id="dg-content"><div class="w-fixed-width"><div id="dg-innerContent"><h1 id="dg-autoTitle">Advanced content</h1><ul class="dg-pageToc"><li><a href="#advanced-styles">Advanced styles</a></li><li><a href="#basic-tables">Basic tables</a></li><li><a href="#html-tables">HTML tables</a></li><li><a href="#creating-internal-links-to-page-sections">Creating internal links to page sections</a></li><li><a href="#creating-internal-links-to-other-pages">Creating internal links to other pages</a></li><li><a href="#control-of-page-breaks-in-the-pdf">Control of page breaks in the PDF</a></li></ul><style>
-.container {
-  box-sizing: border-box;
-  float:left;
-  width: 480px;
-}
-.codeContainer {
-  margin: 0 20px 0 0;
-}
-.codeContainer pre {
-  margin: 0;
-}
-.codeContainer code {
-}
-.codeContainer p {
-  margin: 0;
-  padding: 0;
-}
-.exampleContainer {
-  margin: 0;
-  border: 1px solid #666;
-  border-radius: 6px;
-  padding: 0 18px 0 18px;
-}
-.exampleContainer img {
-  margin-top: 5px;
-}
-#content table {
-  width: 400px!important;
-}
-.hljs-change {
-  background-color: initial!important;
-}
-</style>
-<h2 id="advanced-styles">Advanced styles</h2>
-<p>DocGen is built on the <a href="http://mtmacdonald.github.io/webknife">Webknife CSS framework</a>. Any of the HTML elements and
-styles from Webknife can be used in a DocGen source file. For details, see
-the <a href="http://mtmacdonald.github.io/webknife/docs/reference.html">Webknife reference guide</a>.</p>
-<h2 id="basic-tables">Basic tables</h2>
-<p>Basic tables can be inserted with the Github-flavoured Markdown
-<a href="https://help.github.com/articles/github-flavored-markdown/#tables">table extension</a>.</p>
-<div class="container codeContainer">
-<pre><code>| Heading    | Heading    | Heading |
-|:-----------:----------:|--------:|
-| Something  | Something  | ?       |
-| Another    | Another    | ?       |
-| One more   | One more   | ?       |</code></pre>
-</div>
-<div class="container exampleContainer">
-<table class="w-table w-fixed w-stripe">
-<thead>
-<tr>
-<th style="text-align:left">Heading</th>
-<th style="text-align:center">Heading</th>
-<th style="text-align:right">Heading</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td style="text-align:left">Something</td>
-<td style="text-align:center">Something</td>
-<td style="text-align:right">?</td>
-</tr>
-<tr>
-<td style="text-align:left">Another</td>
-<td style="text-align:center">Another</td>
-<td style="text-align:right">?</td>
-</tr>
-<tr>
-<td style="text-align:left">One more</td>
-<td style="text-align:center">One more</td>
-<td style="text-align:right">?</td>
-</tr>
-</tbody>
-</table>
-</div><br class="w-clear">
-<h2 id="html-tables">HTML tables</h2>
-<p>Regular HTML can also be used for tables, allowing full custom styling (including table and column widths).</p>
-<div class="container codeContainer">
-<pre><code>&lt;table style=&quot;width:100%;&quot;&gt;
- &lt;tr&gt;
-  &lt;th&gt;Heading&lt;/th&gt;
-  &lt;th&gt;Heading&lt;/th&gt;
-  &lt;th&gt;Heading&lt;/th&gt;
- &lt;/tr&gt;
- &lt;tr&gt;
-  &lt;td class=&quot;bold&quot;&gt;Example&lt;/td&gt;
-  &lt;td&gt;Example&lt;/td&gt;
-  &lt;td&gt;Example&lt;/td&gt;
- &lt;/tr&gt;
- &lt;tr&gt;
-  &lt;td&gt;&lt;strong&gt;Example&lt;/strong&gt;&lt;/td&gt;
-  &lt;td class=&quot;w-success-text&quot;&gt;Example&lt;/td&gt;
-  &lt;td&gt;&lt;span class=&quot;w-icon&quot; data-name=&quot;checkmark&quot;&gt;&lt;/span&gt;&lt;/td&gt;
- &lt;/tr&gt;
- &lt;tr&gt;
-  &lt;td&gt;&lt;strong&gt;Example&lt;/strong&gt;&lt;/td&gt;
-  &lt;td class=&quot;w-error-text&quot;&gt;Example&lt;/td&gt;
-  &lt;td&gt;&lt;span class=&quot;w-icon&quot; data-name=&quot;close&quot;&gt;&lt;/td&gt;
- &lt;/tr&gt;
-&lt;/table&gt;</code></pre>
-</div>
-<div class="container exampleContainer">
-<table style="width:100%;" class="w-table w-fixed w-stripe">
- <tr>
-  <th>Heading</th>
-  <th>Heading</th>
-  <th>Heading</th>
- </tr>
- <tr>
-  <td class="bold">Example</td>
-  <td>Example</td>
-  <td>Example</td>
- </tr>
- <tr>
-  <td><strong>Example</strong></td>
-  <td class="w-success-text">Example</td>
-  <td><span class="w-icon" data-name="checkmark"></span></td>
- </tr>
- <tr>
-  <td><strong>Example</strong></td>
-  <td class="w-error-text">Example</td>
-  <td><span class="w-icon" data-name="close"></span></td>
- </tr>
-</table>
-</div><br class="w-clear">
-<h2 id="creating-internal-links-to-page-sections">Creating internal links to page sections</h2>
-<p>To create links to other sections within one content page, put hyphens between the words in the heading and prepend with #:</p>
-<pre><code>[link to heading](#this-is-a-heading)
-... other page content here ...
-This is a heading
------------------
-</code></pre>
-<h2 id="creating-internal-links-to-other-pages">Creating internal links to other pages</h2>
-<p>To create links to <em>other</em> content pages provide the relative url to the page:</p>
-<pre><code>[link to heading](example-page.html)
-</code></pre>
-<h2 id="control-of-page-breaks-in-the-pdf">Control of page breaks in the PDF</h2>
-<p>DocGen does not provide precision control over PDF layout. However, some steps can be taken in case of page break
-issues (the most common problem).</p>
-<p>To <em>force</em> a page break, insert the following before an element that should appear on a new page:</p>
-<pre><code>&lt;p class=&quot;dg-forceBreak&quot;&gt;&lt;/p&gt;
-</code></pre>
-<p>DocGen automatically tries to eliminate page breaks <em>inside</em> code blocks, block quotes, and table rows.
-To apply the same technique to other elements, revert to HTML and apply the <strong>dg-avoidBreak</strong> class. For example:</p>
-<pre><code>&lt;p class=&quot;dg-avoidBreak&quot;&gt;A long paragraph&lt;/p&gt;</code></pre>
-</div></div></section>
- <footer>
-  <div><p class="w-fixed-width"><span id="dg-web-footer">Version 2.1.3 released on 29/05/2015.</span></p></div>
-  <div class="w-fixed-width">
-    <p><span id="dg-copyright">&#xA9; 2015 <a href="https://github.com/mtmacdonald">Mark Macdonald</a></span></p>
-    <p>
-      <span id="dg-marking">MIT License.</span>
-      <span id="dg-legalese"></span>
-      <span id="dg-attribution">Created by DocGen 2.1.3 on 29/05/2015 at 13:57:42.</span>
-    </p>
-  </div>
- </footer>
- </body>
-</html>

package/docs/commonmark.html DELETED Viewed

@@ -1,225 +0,0 @@
-<!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 - a documentation tool</title>
-  <!--load stylesheets first (rationale: https://developers.google.com/speed/docs/best-practices/rtt#PutStylesBeforeScripts)-->
-  <link rel="stylesheet" href="require/webknife/framework.min.css" type="text/css">
-  <link rel="stylesheet" href="require/webknife/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/webknife/framework.min.js"></script>
-  <script src="require/webknife/framework.icons.js"></script>
-  <script src="require/webknife/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>
-<link rel="stylesheet" href="require/katex/katex.min.css" type="text/css"><script type="text/javascript" src="require/katex/katex.min.js"></script><script type="text/javascript" src="require/katexInjector.js"></script><script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML-full"></script></head>
-<body>
-<div id="dg-toc"><div><table class="unstyled"><tr><td class="dg-tocGroup"><ul><li class="dg-tocHeading">Quick Start</li><li><a href="index.html">Overview</a></li><li><a href="installation.html">Installation</a></li><li><a href="upgrading.html">Upgrading</a></li></ul></td><td class="dg-tocGroup"><ul><li class="dg-tocHeading">User Guide</li><li><a href="running.html">Running DocGen</a></li><li><a href="writing-content.html">Writing content</a></li><li><a href="commonmark.html">CommonMark reference</a></li><li><a href="advanced-content.html">Advanced content</a></li></ul></td><td class="dg-tocGroup"><ul><li class="dg-tocHeading">Help</li><li><a href="troubleshooting.html">Troubleshooting</a></li><li><a href="version-control.html">Using with version control</a></li></ul></td><td class="dg-tocGroup"></td><td class="dg-tocGroup" id="dg-tocFixedColumn"><ul><li><span class="w-icon dg-tocIcon" data-name="person_group" title="archive"></span><a href="ownership.html">Ownership</a></li><li><span class="w-icon dg-tocIcon" data-name="refresh" title="archive"></span><a href="release-notes.html">Release Notes</a></li></ul><div><button class="w-icon-button" onclick="window.location=&apos;docgen.pdf&apos;;"><span class="w-icon" data-name="document"></span><span>PDF copy</span></button></div></td></tr></table></div></div>
-<div id="dg-navigator">Table of contents</div>
-<header>
- <div class="w-fixed-width">
-  <a id="dg-homelink" href="index.html">
-    <div id="dg-logo" style="background-image: url(files/images/logo.png); height: 42px; line-height: 42px; padding-left: 85px;">
-      <span id="dg-title">DocGen - a documentation tool</span> <span id="dg-web-title-version" style="font-weight:normal;">(2.1.3)</span>
-    </div>
-  </a>
-  <div>
-    <span id="dg-backlink"></span>
-  </div>
- </div>
-</header>
-<section id="dg-content"><div class="w-fixed-width"><div id="dg-innerContent"><h1 id="dg-autoTitle">CommonMark reference</h1><p>This section shows examples of how to write content with CommonMark. See the <a href="http://spec.commonmark.org">CommonMark Spec</a>
-for more detailed information.</p>
-<style>
-.reference pre, .reference table, .reference blockquote {
-  margin: 0;
-}
-.reference .codeCell pre {
-  border: none;
-  border-radius: 0;
-}
-.reference .codeCell {
-  padding: 0;
-}
-</style>
-<div>
-<table class="reference w-table w-fixed w-stripe" style="width: 100%">
-<tr><th>Element</th><th>What you type</th><th>What it looks like in DocGen</th></tr>
-<tr>
- <td class="r1">Page Heading</td>
- <td class="codeCell"><pre><code>
-  Page Heading
-  ============
- </code></pre></td>
- <td>
-  <p class="dg-fakeHeading" style="font-size: 20px; padding-bottom: 6px;">Page Heading</p>
-</td>
-</tr>
-<tr>
- <td class="r1">Section Heading</td>
- <td class="codeCell"><pre><code>
-  Section Heading
-  ---------------
- </code></pre></td>
- <td>
-  <p class="dg-fakeHeading" style="font-size: 18px; padding-bottom: 4px;">Section Heading</p>
- </td>
-</tr>
-<tr>
- <td class="r1">Minor Heading</td>
- <td class="codeCell"><pre><code>
-  ### Minor Heading
- </code></pre></td>
- <td>
-  <p class="dg-fakeHeading" style="font-size: 16px; padding-bottom: 4px;">Minor Heading</p>
- </td>
-</tr>
-<tr>
- <td class="r1">Fake Heading<br>(not in PDF contents list)</td>
- <td class="codeCell"><pre><code>
-  &lt;p class=&quot;dg-fakeHeading&quot;&gt;Fake&lt;/p&gt;
- </code></pre></td>
- <td>
-  <p class="dg-fakeHeading">Fake</p>
- </td>
-</tr>
-<tr>
- <td class="r1">Emphasis (italic)</td>
- <td class="codeCell"><pre><code>
-  This text has *emphasis*
- </code></pre></td>
- <td>This text has <em>emphasis</em></td>
-</tr>
-<tr>
- <td class="r1">Strong (bold)</td>
- <td class="codeCell"><pre><code>
-  This text is **bold**
- </code></pre></td>
- <td>This text is <strong>bold</strong></td>
-</tr>
-<tr>
- <td class="r1">Block quotes</td>
-<td class="codeCell"><pre><code>
-  &gt; This is a block quote.
- </code></pre></td>
- <td><blockquote>This is a block quote</blockquote></td>
-</tr>
-<tr>
- <td class="r1">Code block<br> (indent with tab)</td>
- <td class="codeCell"><pre><code>
- &#xA0;&#xA0;&#xA0;&#xA0;&#xA0;int some_code=0
- </code></pre></td>
- <td><pre><code>int some_code=0;</code></pre></td>
-</tr>
-<tr>
- <td class="r1">Unordered List</td>
- <td class="codeCell"><pre><code>
-  * unordered list
-  * (items)
- </code></pre></td>
- <td><ul><li>unordered list</li><li>(items)</li></ul></td>
-</tr>
-<tr>
- <td class="r1">Ordered List</td>
- <td class="codeCell"><pre><code>
-  1. ordered list
-  2. (items)
- </code></pre></td>
- <td><ol><li>ordered list</li><li>(items)</li></ol></td>
-</tr>
-<tr>
- <td class="r1">External Links</td>
- <td class="codeCell"><pre><code>
-  [link](http://www.google.com)
- </code></pre></td>
- <td><a href="http://www.google.com">link</a></td>
-</tr>
-<tr>
- <td class="r1">Links to a local file</td>
- <td class="codeCell"><pre><code>
-  [attachment](user_guide.pdf)
- </code></pre></td>
- <td><a href="user_guide.pdf">attachment</a></td>
-</tr>
-<tr>
- <td class="r1">Diagrams<br> (embedding images)</td>
- <td class="codeCell"><pre><code>
-  ![](files/images/logo.png)
- </code></pre></td>
- <td><img src="files/images/logo.png"></td>
-</tr>
-<tr>
- <td class="r1">Simple table</td>
- <td class="codeCell"><pre><code>
-  | Cell 1 | Cell 2 | Cell 3 |
-  | Cell 4 | Cell 5 | Cell 6 |
- </code></pre></td>
- <td>
-  <table style="width:300px;" class="w-table w-fixed w-stripe">
-   <tr><td>Cell 1</td><td>Cell 2</td><td>Cell 3</td></tr>
-   <tr><td>Cell 4</td><td>Cell 5</td><td>Cell 6</td></tr>
-  </table>
- </td>
-</tr>
-</table>
-</div></div></div></section>
- <footer>
-  <div><p class="w-fixed-width"><span id="dg-web-footer">Version 2.1.3 released on 29/05/2015.</span></p></div>
-  <div class="w-fixed-width">
-    <p><span id="dg-copyright">&#xA9; 2015 <a href="https://github.com/mtmacdonald">Mark Macdonald</a></span></p>
-    <p>
-      <span id="dg-marking">MIT License.</span>
-      <span id="dg-legalese"></span>
-      <span id="dg-attribution">Created by DocGen 2.1.3 on 29/05/2015 at 13:57:42.</span>
-    </p>
-  </div>
- </footer>
- </body>
-</html>

package/docs/docgen.pdf DELETED Viewed

Binary file

package/docs/files/images/logo.png DELETED Viewed

Binary file

package/docs/files/images/overview.png DELETED Viewed

Binary file

package/docs/files/images/pdf.png DELETED Viewed

Binary file