npm - docgen-tool - Versions diffs - 2.1.2 → 3.0.0 - Mend

docgen-tool 2.1.2 → 3.0.0

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

package/.gitattributes +1 -0
package/.github/workflows/deploy-website.yml +28 -0
package/.prettierignore +4 -0
package/.prettierrc +4 -0
package/LICENSE +35 -33
package/{docgen → dist/docgen.js} +11 -22
package/docgen.js +95 -0
package/package.json +47 -20
package/source/__test__/test-run/contents.json +12 -0
package/source/__test__/test-run/overview.txt +3 -0
package/source/__test__/test-run/parameters.json +32 -0
package/source/__test__/test-run/release-notes.txt +4 -0
package/source/docgen.js +900 -775
package/source/example/contents.json +11 -11
package/source/example/index.txt +3 -3
package/source/example/parameters.json +36 -36
package/source/internal-readme.md +4 -0
package/source/pdf-stylesheet.css +26 -20
package/source/require/docgen.css +76 -69
package/source/require/katexInjector.js +9 -13
package/source/require/print.css +26 -19
package/source/templates/main.html +93 -93
package/source/user-guide/advanced-content.txt +170 -170
package/source/user-guide/contents.json +56 -56
package/source/user-guide/files/images/svg/inkit-logo.svg +9 -0
package/source/user-guide/index.txt +257 -244
package/source/user-guide/installation.txt +49 -49
package/source/user-guide/parameters.json +36 -36
package/source/user-guide/release-notes.txt +69 -58
package/source/user-guide/running.txt +46 -46
package/source/user-guide/troubleshooting.txt +31 -31
package/source/user-guide/upgrading.txt +25 -25
package/source/user-guide/version-control.txt +13 -13
package/source/user-guide/writing-content.txt +269 -269
package/tsconfig.json +8 -0
package/.npmignore +0 -2
package/docs/advanced-content.html +0 -239
package/docs/commonmark.html +0 -225
package/docs/docgen.pdf +0 -0
package/docs/files/images/overview.png +0 -0
package/docs/files/images/pdf.png +0 -0
package/docs/files/images/svg/icon.svg +0 -845
package/docs/files/images/svg/overview.svg +0 -1345
package/docs/files/images/text.png +0 -0
package/docs/files/images/web.png +0 -0
package/docs/index.html +0 -333
package/docs/installation.html +0 -121
package/docs/ownership.html +0 -164
package/docs/release-notes.html +0 -144
package/docs/require/docgen.css +0 -131
package/docs/require/katex/fonts/KaTeX_AMS-Regular.woff +0 -0
package/docs/require/katex/fonts/KaTeX_Main-Bold.woff +0 -0
package/docs/require/katex/fonts/KaTeX_Main-Italic.woff +0 -0
package/docs/require/katex/fonts/KaTeX_Main-Regular.woff +0 -0
package/docs/require/katex/fonts/KaTeX_Math-BoldItalic.woff +0 -0
package/docs/require/katex/fonts/KaTeX_Math-Italic.woff +0 -0
package/docs/require/katex/fonts/KaTeX_Math-Regular.woff +0 -0
package/docs/require/katex/fonts/KaTeX_Size1-Regular.woff +0 -0
package/docs/require/katex/fonts/KaTeX_Size2-Regular.woff +0 -0
package/docs/require/katex/fonts/KaTeX_Size3-Regular.woff +0 -0
package/docs/require/katex/fonts/KaTeX_Size4-Regular.woff +0 -0
package/docs/require/katex/katex.min.css +0 -1
package/docs/require/katex/katex.min.js +0 -6
package/docs/require/katexInjector.js +0 -22
package/docs/require/print.css +0 -19
package/docs/require/webknife/fonts/DroidSansMono.woff +0 -0
package/docs/require/webknife/fonts/OpenSans.woff +0 -0
package/docs/require/webknife/fonts/OpenSansBold.woff +0 -0
package/docs/require/webknife/fonts/OpenSansBoldItalic.woff +0 -0
package/docs/require/webknife/fonts/OpenSansItalic.woff +0 -0
package/docs/require/webknife/framework.icons.js +0 -82
package/docs/require/webknife/framework.min.css +0 -3
package/docs/require/webknife/framework.min.js +0 -14
package/docs/require/webknife/highlight.min.css +0 -1
package/docs/require/webknife/highlight.min.js +0 -6
package/docs/running.html +0 -123
package/docs/troubleshooting.html +0 -105
package/docs/upgrading.html +0 -124
package/docs/version-control.html +0 -102
package/docs/writing-content.html +0 -305
/package/{docs → source/__test__/test-run}/files/images/logo.png +0 -0

package/docs/writing-content.html DELETED Viewed

@@ -1,305 +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.2)</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">Writing content</h1><ul class="dg-pageToc"><li><a href="#overview">Overview</a></li><li><a href="#metadata">Metadata</a></li><li><a href="#plain-text">Plain text</a></li><li><a href="#commonmark-(markdown)">CommonMark (Markdown)</a></li><li><a href="#html">HTML</a></li><li><a href="#embedding-images">Embedding images</a></li><li><a href="#attaching-files">Attaching files</a></li><li><a href="#mathematical-expressions">Mathematical Expressions</a></li><li><a href="#mathematics-using-katex">Mathematics using KaTeX</a></li><li><a href="#mathematics-using-mathjax">Mathematics using MathJax</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: transparent!important;
-}
-</style>
-<p>Content for a DocGen website is authored in plain text, using any text editor. Image files can be embedded, and
-other types of files can be attached as links. Additionally, website metadata is configured
-via <a href="http://json.org">JSON</a> files.</p>
-<h2 id="overview">Overview</h2>
-<p>DocGen transforms source files from an input directory into output files in an output directory.</p>
-<p>It takes every source file (plain text) specified in <strong>contents.json</strong> and converts it. Each source file becomes a
-separate page in the website and a separate chapter in the PDF.</p>
-<p>DocGen adds metadata that is specified in <strong>parameters.json</strong>, and copies the images and files in the <strong>files</strong>
-directory to the output.</p>
-<blockquote>
-<p>Always save input files with <strong>UTF-8</strong> encoding. This makes non-standard characters (&#xF8; &#xA9; &#xE9; etc) work.</p>
-</blockquote>
-<h2 id="metadata">Metadata</h2>
-<p><strong>parameters.json</strong></p>
-<p>The parameters file is used to specify metadata describing the product.</p>
-<ul>
-<li><strong>title</strong> - the product title</li>
-<li><strong>name</strong> - the product name (also used to name the PDF)</li>
-<li><strong>version</strong> - the release version</li>
-<li><strong>date</strong> - the release date</li>
-<li><strong>organization</strong> - the company or organization</li>
-<li><strong>author</strong> - the lead author of the document</li>
-<li><strong>owner</strong> - the owner of the product</li>
-<li><strong>contributors</strong> - list of contributors</li>
-<li><strong>website</strong> - a link to the product website</li>
-<li><strong>backlink</strong> - a link back to product user interface (useful for integrated documentation)</li>
-<li><strong>module</strong> - module name (useful for larger products with submodules)</li>
-<li><strong>id</strong> - reference number (e.g. product id in a change management tool)</li>
-<li><strong>summary</strong> - a descriptive summary of the product</li>
-<li><strong>marking</strong> - license or other protective markings</li>
-<li><strong>legalese</strong> - document markings (confidentiality, disclaimers, smallprint etc)</li>
-</ul>
-<p>Values can be empty strings, but the elements are required in the JSON file.</p>
-<p>Parameters with URLs can be either website URLs, or email addresses (specify <em>&apos;mailto:name@address.com&apos;</em>).</p>
-<p><strong>contents.json</strong></p>
-<p>The contents file specifies the names, locations, order, and hierarchy of the source files. It is used to generate both
-the web and PDF table of contents.</p>
-<p><strong>release-notes.txt</strong></p>
-<p>The release notes source file is a mandatory source file (that does not need to be listed in contents.json). Use it to
-summarize the change history for each version of the product.</p>
-<h2 id="plain-text">Plain text</h2>
-<p>The simplest input format is just to write in plain text. Here is an example of the source and output:</p>
-<div class="container codeContainer">
-<pre><code>Example paragraph.
-</code></pre>
-</div>
-<div class="container exampleContainer">
-<p>Example paragraph.</p>
-</div><br class="w-clear">
-<p class="dg-forceBreak"></p>
-<h2 id="commonmark-(markdown)">CommonMark (Markdown)</h2>
-<p><a href="http://commonmark.org/">CommonMark</a> (also known as <a href="http://daringfireball.net/projects/markdown/">MarkDown</a>) is a
-human-friendly plain text markup format. The source format is easy to read and write, and the CommonMark parser
-translates it into HTML. DocGen uses the <a href="https://markdown-it.github.io">markdown-it</a> implementation
-of CommonMark. Here is an example of the source and output:</p>
-<div class="container codeContainer">
-<pre><code>CommonMark Example
-------------------
-Paragraphs are text blocks separated by new lines.
-Text can be styled: *emphasised* and **strong**.
-Here is an [example link](http://www.google.com).
-  # To make a code block, just indent with a tab
-  # &quot;Hello World&quot; in Ruby:
-  5.times { puts &quot;Hello!&quot; }
-</code></pre>
-</div>
-<div class="container exampleContainer">
-<p class="dg-fakeHeading" style="font-size: 18px; padding-bottom: 4px;">CommonMark Example</p>
-<p>Paragraphs are text blocks separated by new lines.</p>
-<p>Text can be styled: <em>emphasised</em> and <strong>strong</strong>.</p>
-<p>Here is an <a href="http://www.google.com">example link</a>.</p>
-<pre><code># To make a code block, just indent with a tab
-# &quot;Hello World&quot; in Ruby:
-5.times { puts &quot;Hello!&quot; }
-</code></pre>
-</div><br class="w-clear">
-<p>For more examples, see the <a href="commonmark.html">CommonMark reference</a>.</p>
-<h2 id="html">HTML</h2>
-<p>For more complex pages not covered by CommonMark&apos;s syntax, simply use inline HTML:</p>
-<div class="container codeContainer">
-<pre><code>&lt;table&gt;
-  &lt;tr&gt;
-    &lt;td&gt;Foo&lt;/td&gt;
-    &lt;td&gt;Bar&lt;/td&gt;
-    &lt;td&gt;Baz&lt;/td&gt;
-  &lt;/tr&gt;
-&lt;/table&gt;</code></pre>
-</div>
-<div class="container exampleContainer">
-<table class="w-table w-fixed w-stripe">
-  <tr>
-    <td>Foo</td>
-    <td>Bar</td>
-    <td>Baz</td>
-  </tr>
-</table>
-</div><br class="w-clear">
-<p>For more examples, see <a href="advanced-content.html">writing advanced content</a>.</p>
-<blockquote>
-<p>Inline HTML is still parsed by the CommonMark parser (HTML is allowed in CommonMark documents). In DocGen, it is also
-possible to bypass the CommonMark parser altogether and specify a pure HTML input page, by setting
-<code class="w-inline-code">&quot;html&quot;: true</code> in a page object in <em>contents.json</em>.</p>
-</blockquote>
-<h2 id="embedding-images">Embedding images</h2>
-<p>Diagrams (in image form, e.g. JPEG, PNG, GIF etc) should be put the <em>files/images</em> directory, and embedded as images.</p>
-<div class="container codeContainer">
-<pre><code>![](files/images/logo.png)</code></pre>
-</div>
-<div class="container exampleContainer">
-<img src="files/images/logo.png">
-</div><br class="w-clear">
-<h2 id="attaching-files">Attaching files</h2>
-<p>Other files you want to attach should go into <em>files</em> directory.</p>
-<div class="container codeContainer">
-<pre><code>[attachment](user_guide.pdf)</code></pre>
-</div>
-<div class="container exampleContainer">
-<a href="user_guide.pdf">attachment</a>
-</div><br class="w-clear">
-<h2 id="mathematical-expressions">Mathematical Expressions</h2>
-<p><a href="http://en.wikipedia.org/wiki/LaTeX">LaTeX</a> is the most common markup format for mathematical expressions.</p>
-<p>Modern web browsers do not yet consistently support a common standard for authoring mathematical expressions. For this
-reason, extra libraries are needed. DocGen supports two widely-used web mathematics libraries out-the-box:</p>
-<ul>
-<li><strong><a href="http://khan.github.io/KaTeX/">KaTeX</a></strong> is fast, lightweight, and <a href="http://github.com/Khan/KaTeX/wiki/Function-Support-in-KaTeX">supports fewer features</a></li>
-<li><strong><a href="https://www.mathjax.org/">MathJax</a></strong> is slower, larger, and <a href="http://docs.mathjax.org/en/latest/tex.html#supported-latex-commands">supports more features</a></li>
-</ul>
-<p>The document author decides which one (or both) to use.</p>
-<p class="dg-forceBreak"></p>
-<h3 id="mathematics-using-katex">Mathematics using KaTeX</h3>
-<p>KaTeX is the recommended choice. It is bundled with DocGen but must be enabled by passing the
-<strong>-m</strong> option.</p>
-<div class="container codeContainer">
-<pre><code>&lt;div class=&quot;dg-katexMath&quot;&gt;
-f(x) = \int_{-\infty}^\infty
-    \hat f(\xi)\,e^{2 \pi i \xi x}
-    \,d\xi
-&lt;/div&gt;</code></pre>
-</div>
-<div class="container exampleContainer">
-<div class="dg-katexMath">
-f(x) = \int_{-\infty}^\infty
-    \hat f(\xi)\,e^{2 \pi i \xi x}
-    \,d\xi
-</div>
-</div><br class="w-clear">
-<h3 id="mathematics-using-mathjax">Mathematics using MathJax</h3>
-<p>MathJax is the fallback choice for expressions not yet supported by KaTex. When required, MathJax can be enabled by
-passing the <strong>-n</strong> option.</p>
-<blockquote>
-<p>DocGen uses the same MathJax configuration as the popular <a href="http://math.stackexchange.com">Stack Exchange</a> websites.</p>
-</blockquote>
-<p class="w-error">
-Because MathJax is a large library, it is not bundled with DocGen, but is served from a third-party CDN
-(content delivery network). This means users need an active Internet connection for the MathJax feature to work.
-</p>
-<p class="w-error">
-MathJax can be slow to render. When used with the PDF feature, it may be necessary to allow more rendering time by
-passing the <br><strong>-d [milliseconds]</strong> option.
-</p>
-<div class="container codeContainer">
-<pre><code>$$
-f(n) = \begin{cases}
-    n/2,  &amp; \text{if $n$ is even} \\
-    3n+1, &amp; \text{if $n$ is odd}
-    \end{cases}
-$$</code></pre>
-</div>
-<div class="container exampleContainer">
-$$
-f(n) = \begin{cases}
-    n/2,  &amp; \text{if $n$ is even} \\
-    3n+1, &amp; \text{if $n$ is odd}
-    \end{cases}
-$$
-</div><br class="w-clear">
-</div></div></section>
- <footer>
-  <div><p class="w-fixed-width"><span id="dg-web-footer">Version 2.1.2 released on 28/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.2 on 28/05/2015 at 18:31:56.</span>
-    </p>
-  </div>
- </footer>
- </body>
-</html>

/package/{docs → source/__test__/test-run}/files/images/logo.png RENAMED Viewed

File without changes